> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tofunmiadewuyi.com/custos/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a host

> Requires `host.access`. Adds live connection state and bound sets to the summary.



## OpenAPI

````yaml /custos/openapi.yaml get /hosts/{id}
openapi: 3.1.0
info:
  title: Custos control-plane API
  version: 0.1.0
  description: >
    Seed specification. The auth, identity, key, host-list, and grant endpoints
    below are

    complete; the remaining control-plane endpoints are still being transcribed.
servers:
  - url: https://custos.example.com
    description: Your control plane
security:
  - bearerAuth: []
tags:
  - name: Auth
    description: Login, token refresh, and logout.
  - name: Identity
    description: The authenticated user.
  - name: Keys
    description: A user's SSH public keys.
  - name: Credentials
    description: Stored secrets, sealed at rest and audited on every read.
  - name: Permission requests
    description: Time-boxed access requests for gated credentials.
  - name: Sets
    description: >-
      Secret sets — an app's .env, either deployable (private) or team-shared
      (public).
  - name: Hosts
    description: Enrolled machines.
  - name: Health
    description: Liveness and readiness probes.
  - name: Notifications
    description: In-app notifications for the signed-in user.
  - name: Rotation reviews
    description: Credential rotation checklists raised when a user is suspended or removed.
  - name: Audit
    description: Install-wide trails.
  - name: Users
    description: Accounts and their lifecycle.
  - name: Invitations
    description: Onboarding new accounts.
  - name: Groups
    description: Resource groups — a grant on a group cascades to everything in it.
  - name: Grants
    description: Permission grants.
  - name: Enrollment
    description: Admitting a machine to the fleet. Daemon-facing.
  - name: Upgrades
    description: Rolling the daemon fleet forward.
paths:
  /hosts/{id}:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    get:
      tags:
        - Hosts
      summary: Get a host
      description: >-
        Requires `host.access`. Adds live connection state and bound sets to the
        summary.
      responses:
        '200':
          description: The host
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Host'
                  - type: object
                    properties:
                      connected:
                        type: boolean
                        description: Whether the daemon's WebSocket is up right now.
                      encryption:
                        type: boolean
                        description: >-
                          Whether the host registered an X25519 key and can
                          receive sealed sets.
                      sets:
                        type: array
                        items:
                          type: string
        '403':
          description: Missing `host.access`
        '404':
          description: Not found
components:
  schemas:
    Host:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        hostname:
          type: string
        ssh_endpoint:
          type: object
          properties:
            address:
              type: string
            source:
              type: string
        accounts:
          type: array
          items:
            type: string
          description: The Unix accounts this host manages.
        status:
          type: string
        connection_status:
          type: string
          description: Whether a daemon is currently connected.
        agent_version:
          type: string
        desired_version:
          type: string
        enrolled_at:
          type: string
          format: date-time
        last_seen_at:
          type: string
          format: date-time
          nullable: true
        permissions:
          type: array
          items:
            type: string
          description: The caller's permissions on this host.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        An opaque access token from /login or /refresh. Tokens are checked
        against the database on every request, so revocation is immediate.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.