ReferenceAgents
ResourcesAgents

Agents

List agents

GET
/api/v1/orgs/{owner}/agents

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/agents"
{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "description": "string",      "tags": [        "string"      ],      "live_state": 0,      "user": "string",      "namespace": "string",      "version_api": {},      "version": "string",      "content": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "status": "created",      "status_conditions": [        {          "type": "created",          "status": "string",          "reason": "string",          "message": "string",          "last_update_time": "2019-08-24T14:15:22Z",          "last_transition_time": "2019-08-24T14:15:22Z",          "meta_info": {}        }      ],      "is_ui_managed": true,      "hostname": "string",      "settings": {},      "stats": {},      "contributors": [        {}      ]    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Create agent

POST
/api/v1/orgs/{owner}/agents

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Agent body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/agents" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "live_state": 0,  "user": "string",  "namespace": "string",  "version_api": {},  "version": "string",  "content": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "status": "created",  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "is_ui_managed": true,  "hostname": "string",  "settings": {},  "stats": {},  "contributors": [    {}  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Global Cron

POST
/api/v1/orgs/{owner}/agents/cron

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Cron body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/agents/cron" \  -H "Content-Type: application/json" \  -d '{}'
{  "status": "created",  "state": {    "schedules": {},    "hooks": {},    "watchdogs": {},    "tuners": {},    "queued": {},    "stopping": {},    "deleting": {},    "apply": {},    "checks": {},    "full": true  },  "live_state": 0,  "compatible_updates": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List agents names

GET
/api/v1/orgs/{owner}/agents/names

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/agents/names"
{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "description": "string",      "tags": [        "string"      ],      "live_state": 0,      "user": "string",      "namespace": "string",      "version_api": {},      "version": "string",      "content": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "status": "created",      "status_conditions": [        {          "type": "created",          "status": "string",          "reason": "string",          "message": "string",          "last_update_time": "2019-08-24T14:15:22Z",          "last_transition_time": "2019-08-24T14:15:22Z",          "meta_info": {}        }      ],      "is_ui_managed": true,      "hostname": "string",      "settings": {},      "stats": {},      "contributors": [        {}      ]    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get Global State (queues/runs)

GET
/api/v1/orgs/{owner}/agents/state

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/agents/state"
{  "status": "created",  "state": {    "schedules": {},    "hooks": {},    "watchdogs": {},    "tuners": {},    "queued": {},    "stopping": {},    "deleting": {},    "apply": {},    "checks": {},    "full": true  },  "live_state": 0,  "compatible_updates": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Patch agent

PATCH
/api/v1/orgs/{owner}/agents/{agent.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

agent.uuid*string

UUID

Request Body

application/json

Agent body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/orgs/string/agents/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "live_state": 0,  "user": "string",  "namespace": "string",  "version_api": {},  "version": "string",  "content": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "status": "created",  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "is_ui_managed": true,  "hostname": "string",  "settings": {},  "stats": {},  "contributors": [    {}  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update agent

PUT
/api/v1/orgs/{owner}/agents/{agent.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

agent.uuid*string

UUID

Request Body

application/json

Agent body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/orgs/string/agents/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "live_state": 0,  "user": "string",  "namespace": "string",  "version_api": {},  "version": "string",  "content": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "status": "created",  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "is_ui_managed": true,  "hostname": "string",  "settings": {},  "stats": {},  "contributors": [    {}  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update agent config

PATCH
/api/v1/orgs/{owner}/agents/{agent.uuid}/config

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

agent.uuid*string

UUID

Request Body

application/json

Agent body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/orgs/string/agents/string/config" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "live_state": 0,  "user": "string",  "namespace": "string",  "version_api": {},  "version": "string",  "content": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "status": "created",  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "is_ui_managed": true,  "hostname": "string",  "settings": {},  "stats": {},  "contributors": [    {}  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Sync agent

PATCH
/api/v1/orgs/{owner}/agents/{agent.uuid}/sync

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

agent.uuid*string

UUID

Request Body

application/json

Agent body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/orgs/string/agents/string/sync" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Patch agent token

PATCH
/api/v1/orgs/{owner}/agents/{entity}/token

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity

Request Body

application/json

Token body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/orgs/string/agents/string/token" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "key": "string",  "name": "string",  "scopes": [    "string"  ],  "services": [    "string"  ],  "started_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "expiration": 0}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update agent token

PUT
/api/v1/orgs/{owner}/agents/{entity}/token

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity

Request Body

application/json

Token body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/orgs/string/agents/string/token" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "key": "string",  "name": "string",  "scopes": [    "string"  ],  "services": [    "string"  ],  "started_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "expiration": 0}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get agent

GET
/api/v1/orgs/{owner}/agents/{uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the sub-entity

Query Parameters

entity?string

Entity: project name, hub name, registry name, ...

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/agents/string"
{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "live_state": 0,  "user": "string",  "namespace": "string",  "version_api": {},  "version": "string",  "content": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "status": "created",  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "is_ui_managed": true,  "hostname": "string",  "settings": {},  "stats": {},  "contributors": [    {}  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete agent

DELETE
/api/v1/orgs/{owner}/agents/{uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the sub-entity

Query Parameters

entity?string

Entity: project name, hub name, registry name, ...

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/orgs/string/agents/string"
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get agent config

GET
/api/v1/orgs/{owner}/agents/{uuid}/config

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the sub-entity

Query Parameters

entity?string

Entity: project name, hub name, registry name, ...

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/agents/string/config"
{  "uuid": "string",  "name": "string",  "description": "string",  "tags": [    "string"  ],  "live_state": 0,  "user": "string",  "namespace": "string",  "version_api": {},  "version": "string",  "content": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "status": "created",  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "is_ui_managed": true,  "hostname": "string",  "settings": {},  "stats": {},  "contributors": [    {}  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Reconcile agent

PATCH
/api/v1/orgs/{owner}/agents/{uuid}/reconcile

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the entity

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/orgs/string/agents/string/reconcile" \  -H "Content-Type: application/json" \  -d '{}'
{}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get State (queues/runs)

GET
/api/v1/orgs/{owner}/agents/{uuid}/state

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the entity

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/agents/string/state"
{  "status": "created",  "state": {    "schedules": {},    "hooks": {},    "watchdogs": {},    "tuners": {},    "queued": {},    "stopping": {},    "deleting": {},    "apply": {},    "checks": {},    "full": true  },  "live_state": 0,  "compatible_updates": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get agent stats

GET
/api/v1/orgs/{owner}/agents/{uuid}/stats

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

SubEntity uuid

Query Parameters

entity?string

Entity name under namespace.

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Stats Mode.

kind?string

Stats Kind.

aggregate?string

Stats aggregate.

groupby?string

Stats group.

trunc?string

Stats trunc.

start_date?string

Stats start date.

end_date?string

Stats end date.

boundary?boolean

Stats boundary.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/agents/string/stats"
{}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get Agent statuses

GET
/api/v1/orgs/{owner}/agents/{uuid}/statuses

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the sub-entity

Query Parameters

entity?string

Entity: project name, hub name, registry name, ...

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/agents/string/statuses"
{  "uuid": "string",  "status": "created",  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "meta_info": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Create new agent status

POST
/api/v1/orgs/{owner}/agents/{uuid}/statuses

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the entity

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/agents/string/statuses" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "status": "created",  "status_conditions": [    {      "type": "created",      "status": "string",      "reason": "string",      "message": "string",      "last_update_time": "2019-08-24T14:15:22Z",      "last_transition_time": "2019-08-24T14:15:22Z",      "meta_info": {}    }  ],  "meta_info": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get agent token

GET
/api/v1/orgs/{owner}/agents/{uuid}/token

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the entity

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/agents/string/token"
{  "uuid": "string",  "key": "string",  "name": "string",  "scopes": [    "string"  ],  "services": [    "string"  ],  "started_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "expiration": 0}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

collect agent

POST
/internal/v1/{namespace}/{owner}/agents/{uuid}/collect

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the entity

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/internal/v1/string/string/agents/string/collect"
{}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Inspect an agent's service full conditions

GET
/streams/v1/{namespace}/{owner}/agents/{uuid}/k8s_inspect

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the entity

Query Parameters

service?string

Service.

last_file?string

last_file.

force?boolean

Force query param.

connection?string

Connection to use.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/streams/v1/string/string/agents/string/k8s_inspect"
{}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Restart agent service

POST
/streams/v1/{namespace}/{owner}/agents/{uuid}/k8s_restart

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the entity

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/streams/v1/string/string/agents/string/k8s_restart" \  -H "Content-Type: application/json" \  -d '{}'
{}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get run logs

GET
/streams/v1/{namespace}/{owner}/agents/{uuid}/logs

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

namespace*string

namespace

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the entity

Query Parameters

service?string

Service.

last_file?string

last_file.

force?boolean

Force query param.

connection?string

Connection to use.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/streams/v1/string/string/agents/string/logs"
{  "logs": [    {      "timestamp": "2019-08-24T14:15:22Z",      "node": "string",      "pod": "string",      "container": "string",      "value": "string"    }  ],  "last_time": "2019-08-24T14:15:22Z",  "last_file": "string",  "files": [    "string"  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}
Organizations
Queues

On this page

List agentsCreate agentGlobal CronList agents namesGet Global State (queues/runs)Patch agentUpdate agentUpdate agent configSync agentPatch agent tokenUpdate agent tokenGet agentDelete agentGet agent configReconcile agentGet State (queues/runs)Get agent statsGet Agent statusesCreate new agent statusGet agent tokencollect agentInspect an agent's service full conditionsRestart agent serviceGet run logs

Actions

Give us feedback