> ## 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. # Register a daemon > A daemon registers with its realm token, and registers again on every start. Send the `daemon_id` you got the first time to keep the same identity. The reply carries the realm's access list and the public key the daemon checks CliqHub's dispatch tokens with. A token that does not grant the requested `realm_id` is refused with `403 forbidden`. Daemon only: requires the daemon's realm token (`Authorization: Bearer cliq_dt_…`). User tokens are refused. ## OpenAPI ````yaml /openapi/hub-by-tag/hub-daemons.yaml post /v1/daemons/register 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/register: post: tags: - Daemons summary: Register a daemon description: >- A daemon registers with its realm token, and registers again on every start. Send the `daemon_id` you got the first time to keep the same identity. The reply carries the realm's access list and the public key the daemon checks CliqHub's dispatch tokens with. A token that does not grant the requested `realm_id` is refused with `403 forbidden`. Daemon only: requires the daemon's realm token (`Authorization: Bearer cliq_dt_…`). User tokens are refused. operationId: POST_v1_daemons_register requestBody: required: true content: application/json: schema: type: object properties: realm_id: type: string description: Requested realm id (must be granted by token) daemon_id: type: string description: Stable daemon id when re-registering hostname: type: string description: Daemon hostname ip: type: string description: Daemon IP port: type: number description: Daemon listen port public_url: type: string description: Public base URL for the daemon name: type: string description: Display name additionalProperties: true examples: default: value: daemon_id: 7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d hostname: build-01.acme.internal port: 4900 name: build-01 responses: '200': description: Success. content: application/json: schema: type: object required: - ok - daemon properties: ok: type: boolean enum: - true description: Always `true` on success. daemon: $ref: '#/components/schemas/DaemonRegistration' example: ok: true daemon: daemon_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 created_at: 1759000000000 last_registered_at: 1759834000000 realm_id: 5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b acl: realm_id: 5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b allowed: - sshah - jdoe dispatch_public_key: |- -----BEGIN PUBLIC KEY----- … dispatch_public_key: |- -----BEGIN PUBLIC KEY----- … '401': description: >- `unauthorized`: No `Authorization` header, or the token is malformed, expired or revoked. `unauthorized`: The `Authorization` header is missing or not a Bearer token. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: unauthorized: summary: unauthorized value: ok: false error: code: unauthorized message: Authentication required unauthorized (endpoint): summary: unauthorized (endpoint) value: ok: false error: Missing or invalid Authorization header code: unauthorized '403': description: >- `forbidden`: A user token was used, or the daemon's token belongs to another realm. `forbidden`: The realm token does not grant the requested `realm_id`. 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 forbidden (endpoint): summary: forbidden (endpoint) value: ok: false error: Realm grant denied code: forbidden '422': description: >- `invalid_params`: The body fails the request schema: a required field is missing or a value has the wrong type or format. The message lists every issue as `field: problem`. content: application/json: schema: $ref: '#/components/schemas/HubErr' examples: invalid_params: summary: invalid_params value: ok: false error: 'realm_id: Required' 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: DaemonRegistration: type: object required: - daemon_id - status - created_at - last_registered_at properties: daemon_id: type: string description: The daemon's id. Keep it and send it when registering again. name: type: string nullable: true user_id: type: string description: The user who owns the realm token. user_email: type: string hostname: type: string nullable: true ip: type: string nullable: true port: type: number nullable: true public_url: type: string nullable: true status: type: string enum: - online - stale - offline - removed created_at: type: number last_registered_at: type: number realm_id: type: string description: The realm the daemon joined. acl: $ref: '#/components/schemas/DaemonAcl' dispatch_public_key: type: string 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. DaemonAcl: type: object required: - realm_id - allowed - dispatch_public_key properties: realm_id: type: string allowed: type: array items: type: string description: Who may call the daemon from another host (the realm's members). dispatch_public_key: type: string description: PEM public key the daemon checks CliqHub's dispatch tokens with. 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.