orb-fleet (1.0.0)

Download OpenAPI specification:Download

agent_groups

List current Agent Groups

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

Size of the subset to retrieve.

offset
integer >= 0
Default: 0

Number of items to skip during retrieval.

name
string

Name filter. Filtering is performed as a case-insensitive partial match.

order
string
Default: "id"
Enum: "name" "id"

Order type.

dir
string
Default: "desc"
Enum: "asc" "desc"

Order direction.

header Parameters
Authorization
required
string <jwt>

User's access token.

Responses

Response samples

Content type
application/json
{
  • "agent_groups": [
    ],
  • "total": 0,
  • "offset": 0,
  • "limit": 0
}

Create a new Agent Group

header Parameters
Authorization
required
string <jwt>

User's access token.

Request Body schema: application/json

JSON-formatted document describing the new Agent Group configuration

name
required
string

A unique name label

description
string

User description of this Agent Group

tags
required
object

User defined key/values that will define the members of the group by matching against Agent tags

Responses

Request samples

Content type
application/json
{
  • "name": "eu-agents",
  • "description": "An example agent group representing european dns nodes",
  • "tags": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "eu-agents",
  • "description": "An example agent group representing european dns nodes",
  • "tags": {
    },
  • "ts_created": "2019-08-24T14:15:22Z",
  • "matching_agents": {
    }
}

Get an existing Agent Group

path Parameters
id
required
string <uuid>

Unique Agent Group identifier.

header Parameters
Authorization
required
string <jwt>

User's access token.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "eu-agents",
  • "description": "An example agent group representing european dns nodes",
  • "tags": {
    },
  • "ts_created": "2019-08-24T14:15:22Z",
  • "matching_agents": {
    }
}

Update an existing Agent Group

path Parameters
id
required
string <uuid>

Unique Agent Group identifier.

header Parameters
Authorization
required
string <jwt>

User's access token.

Request Body schema: application/json

JSON-formatted document describing the updated Agent Group configuration

name
string

A unique name label

description
string

User description of this Agent Group

tags
object

User defined key/values that will define the members of the group by matching against Agent tags

Responses

Request samples

Content type
application/json
{
  • "name": "eu-agents",
  • "description": "An example agent group representing european dns nodes",
  • "tags": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "eu-agents",
  • "description": "An example agent group representing european dns nodes",
  • "tags": {
    },
  • "ts_created": "2019-08-24T14:15:22Z",
  • "matching_agents": {
    }
}

Delete an existing Agent Group

path Parameters
id
required
string <uuid>

Unique Agent Group identifier.

header Parameters
Authorization
required
string <jwt>

User's access token.

Responses

Response samples

Content type
application/json
"string"

Validate an Agent Group configuration without saving it

header Parameters
Authorization
required
string <jwt>

User's access token.

Request Body schema: application/json

JSON-formatted document describing the new Agent Group configuration

name
required
string

A unique name label

description
string

User description of this Agent Group

tags
required
object

User defined key/values that will define the members of the group by matching against Agent tags

Responses

Request samples

Content type
application/json
{
  • "name": "eu-agents",
  • "description": "An example agent group representing european dns nodes",
  • "tags": {
    }
}

Response samples

Content type
application/json
"string"

agents

List current Agents

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

Size of the subset to retrieve.

offset
integer >= 0
Default: 0

Number of items to skip during retrieval.

name
string

Name filter. Filtering is performed as a case-insensitive partial match.

order
string
Default: "id"
Enum: "name" "id"

Order type.

dir
string
Default: "desc"
Enum: "asc" "desc"

Order direction.

header Parameters
Authorization
required
string <jwt>

User's access token.

Responses

Response samples

Content type
application/json
{
  • "agents": [