ReferenceQueues
ResourcesQueues

Queues

Create queue

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

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

agent*string

Agent that consumes the queue

Request Body

application/json

Queue 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/string/queues" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "agent": "string",  "name": "string",  "description": "string",  "user": "string",  "tags": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "priority": 0,  "concurrency": 0,  "resource": "string",  "quota": "string",  "stats": {},  "contributors": [    {}  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Patch queue

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

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

agent*string

Agent that consumes the queue

queue.uuid*string

UUID

Request Body

application/json

Queue 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/queues/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "agent": "string",  "name": "string",  "description": "string",  "user": "string",  "tags": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "priority": 0,  "concurrency": 0,  "resource": "string",  "quota": "string",  "stats": {},  "contributors": [    {}  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update queue

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

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

agent*string

Agent that consumes the queue

queue.uuid*string

UUID

Request Body

application/json

Queue 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/queues/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "agent": "string",  "name": "string",  "description": "string",  "user": "string",  "tags": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "priority": 0,  "concurrency": 0,  "resource": "string",  "quota": "string",  "stats": {},  "contributors": [    {}  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get queue

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

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

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

uuid*string

Uuid identifier of the sub-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/queues/string"
{  "uuid": "string",  "agent": "string",  "name": "string",  "description": "string",  "user": "string",  "tags": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "priority": 0,  "concurrency": 0,  "resource": "string",  "quota": "string",  "stats": {},  "contributors": [    {}  ]}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete queue

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

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

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

uuid*string

Uuid identifier of the sub-entity

Response Body

application/json

application/json

application/json

application/json

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

Get queue stats

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

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

entity*string

Entity name under namespace

uuid*string

SubEntity uuid

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

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/queues/string/stats"
{}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List queues

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

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity managing the resource

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/string/queues"
{  "count": 0,  "results": [    {      "uuid": "string",      "agent": "string",      "name": "string",      "description": "string",      "user": "string",      "tags": [        "string"      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "priority": 0,      "concurrency": 0,      "resource": "string",      "quota": "string",      "stats": {},      "contributors": [        {}      ]    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List queues names

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

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

name*string

Entity managing the resource

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/string/queues/names"
{  "count": 0,  "results": [    {      "uuid": "string",      "agent": "string",      "name": "string",      "description": "string",      "user": "string",      "tags": [        "string"      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "priority": 0,      "concurrency": 0,      "resource": "string",      "quota": "string",      "stats": {},      "contributors": [        {}      ]    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List organization level queues

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

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/queues"
{  "count": 0,  "results": [    {      "uuid": "string",      "agent": "string",      "name": "string",      "description": "string",      "user": "string",      "tags": [        "string"      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "priority": 0,      "concurrency": 0,      "resource": "string",      "quota": "string",      "stats": {},      "contributors": [        {}      ]    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List organization level queues names

GET
/api/v1/orgs/{owner}/queues/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/queues/names"
{  "count": 0,  "results": [    {      "uuid": "string",      "agent": "string",      "name": "string",      "description": "string",      "user": "string",      "tags": [        "string"      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "priority": 0,      "concurrency": 0,      "resource": "string",      "quota": "string",      "stats": {},      "contributors": [        {}      ]    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}
Agents
Connections

On this page

Create queuePatch queueUpdate queueGet queueDelete queueGet queue statsList queuesList queues namesList organization level queuesList organization level queues names

Actions

Give us feedback