> ## Documentation Index > Fetch the complete documentation index at: https://docs.getcliq.io/llms.txt > Use this file to discover all available pages before exploring further. # List daemons > Lists daemons: those of `realm_id`, or of every realm of `org_id` you can see. Filter by `status` or search hostname and id with `query`. Requires a signed-in user token; with `realm_id`, a realm member (or higher) with the `daemons.view` permission on that realm; with `org_id`, a role with the `daemons.view` permission in that organization. With neither, the results are limited to what you can see. ## OpenAPI ````yaml /openapi/hub-by-tag/hub-daemons.yaml post /v1/daemons/get openapi: 3.0.3 info: title: 'CliqHub API: Daemons' version: 1.0.0 description: >- Daemons (`cliqd`) connected to CliqHub. A daemon joins a realm with a realm token (`cliq_dt_…`, from Generate a token with `type: realm`, or `cliq login` on the daemon). With that token it registers, sends a heartbeat, reports its installed teams, refreshes the realm's access list and acknowledges each command CliqHub sends it. People list, inspect and remove daemons. A daemon is `online` while it sends heartbeats, then `stale`, then `offline`; `removed` once deregistered or removed. servers: - url: https://{host} variables: host: default: cliqhub.io description: CliqHub host security: [] tags: - name: Daemons description: >- Daemons (`cliqd`) connected to CliqHub. A daemon joins a realm with a realm token (`cliq_dt_…`, from Generate a token with `type: realm`, or `cliq login` on the daemon). With that token it registers, sends a heartbeat, reports its installed teams, refreshes the realm's access list and acknowledges each command CliqHub sends it. People list, inspect and remove daemons. A daemon is `online` while it sends heartbeats, then `stale`, then `offline`; `removed` once deregistered or removed. paths: /v1/daemons/get: post: tags: - Daemons summary: List daemons description: >- Lists daemons: those of `realm_id`, or of every realm of `org_id` you can see. Filter by `status` or search hostname and id with `query`. Requires a signed-in user token; with `realm_id`, a realm member (or higher) with the `daemons.view` permission on that realm; with `org_id`, a role with the `daemons.view` permission in that organization. With neither, the results are limited to what you can see. operationId: POST_v1_daemons_get requestBody: required: true content: application/json: schema: type: object properties: realm_id: type: string description: When set, list daemons in this realm (org_id not required) org_id: type: string format: uuid description: >- Organization UUID. Required when listing daemons without realm_id. status: type: string enum: - online - stale - offline description: Filter by status query: type: string description: Substring match on daemon id / hostname limit: type: integer minimum: 1 description: Page size offset: type: integer description: Page offset all: type: boolean description: >- Site admins only: every record on the hub, not just the caller\ sort_by: type: string enum: - name - status - last_heartbeat description: >- Sort column: name | status | last_heartbeat. Omit for the default order (most recently registered first; name = name, else hostname, else id). sort_dir: type: string enum: - asc - desc description: >- Sort direction with sort_by (default asc); ties are broken by id ascending examples: default: value: realm_id: 5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b status: online responses: '200': description: Success. content: application/json: schema: type: object required: - ok - data properties: ok: type: boolean enum: - true description: Always `true` on success. data: type: object properties: items: type: array items: $ref: '#/components/schemas/DaemonData' total: type: integer offset: type: integer limit: type: integer description: The page size, or all when none was sent. example: ok: true data: items: - id: 7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d name: build-01 user_id: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d user_email: dev@acme.example hostname: build-01.acme.internal ip: 10.0.4.12 port: 4900 public_url: null status: online last_heartbeat: 1759834190000 capacity: 1 created_at: 1759000000000 last_registered_at: 1759800000000 permissions: {} realms: - id: 5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b slug: production name: Production role: member total: 1 offset: 0 limit: 1 type: array '401': description: >- `unauthorized`: No `Authorization` header, or the token is malformed, expired or revoked. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: unauthorized: summary: unauthorized value: ok: false error: code: unauthorized message: Authentication required '403': description: >- `forbidden`: You can see the realm or organization but your role lacks the required permission. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: forbidden: summary: forbidden value: ok: false error: code: forbidden message: You do not have access to do this '404': description: >- `not_found`: The realm or organization you named does not exist or you cannot see it. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: not_found: summary: not_found value: ok: false error: code: not_found message: Not found '422': description: '`invalid_params`: Neither `realm_id` nor `org_id` was sent.' content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: invalid_params: summary: invalid_params value: ok: false error: >- org_id: org_id is required when listing daemons without realm_id code: invalid_params '500': description: >- `internal_error`: An unexpected server fault. Retry later; if it persists, report it with the time of the request. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: internal_error: summary: internal_error value: ok: false error: Internal server error code: internal_error security: - BearerAuth: [] components: schemas: DaemonData: type: object properties: id: type: string description: Daemon identifier (opaque string, not UUID) name: type: string nullable: true description: Human-assigned name; null when not set user_id: type: string nullable: true description: UUID of the user who registered this daemon; null for unclaimed user_email: type: string nullable: true description: Email of the registering user; null for unclaimed hostname: type: string nullable: true description: Machine hostname; null when not reported ip: type: string nullable: true description: Last-known IP address port: type: integer nullable: true description: Listening port; null when not reported public_url: type: string nullable: true description: Computed public base URL; null when unreachable status: type: string enum: - online - stale - offline - removed description: Last-known connection status last_heartbeat: type: number nullable: true description: Epoch ms of last heartbeat; null when never received capacity: type: integer description: Maximum concurrent runs created_at: type: number description: Epoch ms of registration last_registered_at: type: number description: Epoch ms of most recent re-registration permissions: type: object additionalProperties: true description: Daemon permission grants bag realms: type: array items: type: object properties: id: type: string description: Realm UUID slug: type: string description: Realm slug name: type: string description: Realm display name role: type: string description: Daemon\ required: - id - slug - name - role description: Realms this daemon belongs to required: - id - name - user_id - user_email - hostname - ip - port - public_url - status - last_heartbeat - capacity - created_at - last_registered_at - permissions - realms HubErr: type: object required: - ok - error description: >- Every failure. Route-policy denials (401/403/404, and 400 when neither realm_id nor org_id was sent) answer `error` as `{ code, message }`; errors raised by the endpoint answer `error` as the message with the code beside it in `code`. Every error has a code. See [Errors](/hub-api/errors). properties: ok: type: boolean description: Always false on error error: description: The message, or `{ code, message }` for an access denial. oneOf: - type: string - type: object required: - code - message properties: code: type: string message: type: string code: type: string description: Stable error code of an endpoint error. details: type: object additionalProperties: true description: Structured detail, when there is some. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: cliq_tok_* | cliq_dt_* description: >- User PAT (`cliq_tok_…`, including session-scoped) or realm token (`cliq_dt_…`). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.