ReferenceConnections
ResourcesConnections

Connections

List connections

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

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/connections"
{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "agent": "string",      "user": "string",      "description": "string",      "tags": [        "string"      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "live_state": 0,      "kind": "host_path"    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Create connection

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

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Connection 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/connections" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "agent": "string",  "user": "string",  "description": "string",  "tags": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "live_state": 0,  "kind": "host_path"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

List connections names

GET
/api/v1/orgs/{owner}/connections/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/connections/names"
{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "agent": "string",      "user": "string",      "description": "string",      "tags": [        "string"      ],      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "live_state": 0,      "kind": "host_path"    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Patch connection

PATCH
/api/v1/orgs/{owner}/connections/{connection.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

connection.uuid*string

UUID

Request Body

application/json

Connection 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/connections/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "agent": "string",  "user": "string",  "description": "string",  "tags": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "live_state": 0,  "kind": "host_path"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update connection

PUT
/api/v1/orgs/{owner}/connections/{connection.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

connection.uuid*string

UUID

Request Body

application/json

Connection 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/connections/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "agent": "string",  "user": "string",  "description": "string",  "tags": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "live_state": 0,  "kind": "host_path"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get connection

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

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/connections/string"
{  "uuid": "string",  "name": "string",  "agent": "string",  "user": "string",  "description": "string",  "tags": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "live_state": 0,  "kind": "host_path"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete connection

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

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

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

On this page

List connectionsCreate connectionList connections namesPatch connectionUpdate connectionGet connectionDelete connection

Actions

Give us feedback