Unregister an agent from CliqHub

Removes an agent’s registration from your CliqHub organization: every version, or only version. The agent stays on this daemon’s agents path. Built-in agents cannot be unregistered.

From the CLI: cliq agent unregister jira-sync.

No credential is needed from this machine. From another host, send Authorization: Bearer with a dispatch token CliqHub signed for this daemon or a cliq_tok_… personal token of a user in the daemon’s realm; this only works once the daemon is connected to CliqHub. See Authentication.

POST

agents

unregister

curl --request POST \
  --url http://127.0.0.1:4900/v1/agents/unregister \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "jira-sync"
}
'

{
  "ok": true,
  "data": {
    "name": "jira-sync",
    "deregistered": true,
    "removed_count": 1
  }
}

Authorizations

Authorization

string

header

required

Not needed from the same machine. From another host: a dispatch JWT CliqHub signed for this daemon, or a cliq_tok_… personal token whose user is in the daemon's realm.

Body

application/json

name

string

required

Agent name

Minimum string length: 1

version

string

Only this version

Minimum string length: 1

Response

Success.

boolean

required

data

object

required

Show child attributes

curl --request POST \
  --url http://127.0.0.1:4900/v1/agents/unregister \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "jira-sync"
}
'

{
  "ok": true,
  "data": {
    "name": "jira-sync",
    "deregistered": true,
    "removed_count": 1
  }
}

Introduction

System

Teams

Workspaces

Runs

Artifacts

Agents

Settings

Instances

Daemon

Sign-in

Local tokens

HUG

Hub commands

Unregister an agent from CliqHub

Authorizations

Body

Response