Acknowledge a command
A daemon acknowledges a command CliqHub sent it (install, execute, cancel, …) with
ok or error. CliqHub stops resending the command and shows the outcome. Acking an
unknown or already-acked command changes nothing.
Daemon only: requires the daemon’s realm token (Authorization: Bearer cliq_dt_…). User tokens are refused. Daemon in the token realm; command addressed to it.
POST
/
v1
/
daemons
/
ack_command
Acknowledge a command
curl --request POST \
--url https://{host}/v1/daemons/ack_command \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tx_id": "ack-81c4e2",
"command_tx_id": "tx-5d2c9a",
"daemon_id": "7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"status": "ok"
}
'import requests
url = "https://{host}/v1/daemons/ack_command"
payload = {
"tx_id": "ack-81c4e2",
"command_tx_id": "tx-5d2c9a",
"daemon_id": "7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"status": "ok"
}
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({
tx_id: 'ack-81c4e2',
command_tx_id: 'tx-5d2c9a',
daemon_id: '7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d',
status: 'ok'
})
};
fetch('https://{host}/v1/daemons/ack_command', 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/ack_command",
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([
'tx_id' => 'ack-81c4e2',
'command_tx_id' => 'tx-5d2c9a',
'daemon_id' => '7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d',
'status' => 'ok'
]),
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/ack_command"
payload := strings.NewReader("{\n \"tx_id\": \"ack-81c4e2\",\n \"command_tx_id\": \"tx-5d2c9a\",\n \"daemon_id\": \"7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d\",\n \"status\": \"ok\"\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/ack_command")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tx_id\": \"ack-81c4e2\",\n \"command_tx_id\": \"tx-5d2c9a\",\n \"daemon_id\": \"7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d\",\n \"status\": \"ok\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/daemons/ack_command")
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 \"tx_id\": \"ack-81c4e2\",\n \"command_tx_id\": \"tx-5d2c9a\",\n \"daemon_id\": \"7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d\",\n \"status\": \"ok\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true
}
Authorizations
User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).
Body
application/json
Id of this acknowledgment (for de-duplication).
Minimum string length:
1Id of the command being acknowledged.
Minimum string length:
1The acknowledging daemon.
Minimum string length:
1ok or error.
Available options:
ok, error The command's result, when it has one.
Why the command failed, with status error.
Response
Success.
Always true on success.
Available options:
true ⌘I
Acknowledge a command
curl --request POST \
--url https://{host}/v1/daemons/ack_command \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tx_id": "ack-81c4e2",
"command_tx_id": "tx-5d2c9a",
"daemon_id": "7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"status": "ok"
}
'import requests
url = "https://{host}/v1/daemons/ack_command"
payload = {
"tx_id": "ack-81c4e2",
"command_tx_id": "tx-5d2c9a",
"daemon_id": "7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"status": "ok"
}
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({
tx_id: 'ack-81c4e2',
command_tx_id: 'tx-5d2c9a',
daemon_id: '7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d',
status: 'ok'
})
};
fetch('https://{host}/v1/daemons/ack_command', 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/ack_command",
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([
'tx_id' => 'ack-81c4e2',
'command_tx_id' => 'tx-5d2c9a',
'daemon_id' => '7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d',
'status' => 'ok'
]),
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/ack_command"
payload := strings.NewReader("{\n \"tx_id\": \"ack-81c4e2\",\n \"command_tx_id\": \"tx-5d2c9a\",\n \"daemon_id\": \"7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d\",\n \"status\": \"ok\"\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/ack_command")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tx_id\": \"ack-81c4e2\",\n \"command_tx_id\": \"tx-5d2c9a\",\n \"daemon_id\": \"7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d\",\n \"status\": \"ok\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/daemons/ack_command")
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 \"tx_id\": \"ack-81c4e2\",\n \"command_tx_id\": \"tx-5d2c9a\",\n \"daemon_id\": \"7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d\",\n \"status\": \"ok\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true
}