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.
POST
/
v1
/
daemons
/
register
Register a daemon
curl --request POST \
--url https://{host}/v1/daemons/register \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"daemon_id": "7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"hostname": "build-01.acme.internal",
"port": 4900,
"name": "build-01"
}
'import requests
url = "https://{host}/v1/daemons/register"
payload = {
"daemon_id": "7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"hostname": "build-01.acme.internal",
"port": 4900,
"name": "build-01"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
daemon_id: '7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d',
hostname: 'build-01.acme.internal',
port: 4900,
name: 'build-01'
})
};
fetch('https://{host}/v1/daemons/register', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/v1/daemons/register",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'daemon_id' => '7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d',
'hostname' => 'build-01.acme.internal',
'port' => 4900,
'name' => 'build-01'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{host}/v1/daemons/register"
payload := strings.NewReader("{\n \"daemon_id\": \"7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d\",\n \"hostname\": \"build-01.acme.internal\",\n \"port\": 4900,\n \"name\": \"build-01\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{host}/v1/daemons/register")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"daemon_id\": \"7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d\",\n \"hostname\": \"build-01.acme.internal\",\n \"port\": 4900,\n \"name\": \"build-01\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/daemons/register")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"daemon_id\": \"7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d\",\n \"hostname\": \"build-01.acme.internal\",\n \"port\": 4900,\n \"name\": \"build-01\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"daemon": {
"daemon_id": "7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"name": "build-01",
"user_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"user_email": "[email protected]",
"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-----\n…"
},
"dispatch_public_key": "-----BEGIN PUBLIC KEY-----\n…"
}
}
Authorizations
User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).
Body
application/json
⌘I
Register a daemon
curl --request POST \
--url https://{host}/v1/daemons/register \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"daemon_id": "7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"hostname": "build-01.acme.internal",
"port": 4900,
"name": "build-01"
}
'import requests
url = "https://{host}/v1/daemons/register"
payload = {
"daemon_id": "7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"hostname": "build-01.acme.internal",
"port": 4900,
"name": "build-01"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
daemon_id: '7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d',
hostname: 'build-01.acme.internal',
port: 4900,
name: 'build-01'
})
};
fetch('https://{host}/v1/daemons/register', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/v1/daemons/register",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'daemon_id' => '7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d',
'hostname' => 'build-01.acme.internal',
'port' => 4900,
'name' => 'build-01'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{host}/v1/daemons/register"
payload := strings.NewReader("{\n \"daemon_id\": \"7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d\",\n \"hostname\": \"build-01.acme.internal\",\n \"port\": 4900,\n \"name\": \"build-01\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{host}/v1/daemons/register")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"daemon_id\": \"7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d\",\n \"hostname\": \"build-01.acme.internal\",\n \"port\": 4900,\n \"name\": \"build-01\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/daemons/register")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"daemon_id\": \"7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d\",\n \"hostname\": \"build-01.acme.internal\",\n \"port\": 4900,\n \"name\": \"build-01\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"daemon": {
"daemon_id": "7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"name": "build-01",
"user_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"user_email": "[email protected]",
"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-----\n…"
},
"dispatch_public_key": "-----BEGIN PUBLIC KEY-----\n…"
}
}