Documentation Powered by ReDoc

orb-fleet (1.0.0)

Download OpenAPI specification:Download

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

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.

tags
object
Example: tags={"key":"value"}

Tags filter. Filtering is performed as a case-insensitive partial key value match.

header Parameters
Authorization
required
any

User's access token (bearer auth)

Responses

Response samples

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

Create a new Agent Group

header Parameters
Authorization
required
any

User's access token (bearer auth)

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
any

User's access token (bearer auth)

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
any

User's access token (bearer auth)

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
any

User's access token (bearer auth)

Responses

Response samples

Content type
application/json
"string"

Validate an Agent Group configuration without saving it

header Parameters
Authorization
required
any

User's access token (bearer auth)

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
{
  • "name": "eu-agents",
  • "tags": {
    },
  • "matching_agents": {
    }
}

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.

tags
object
Example: tags={"key":"value"}

Tags filter. Filtering is performed as a case-insensitive partial key value match.

header Parameters
Authorization
required
any

User's access token (bearer auth)

Responses

Response samples

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

Create a new Agent

header Parameters
Authorization
required
any

User's access token (bearer auth)

Request Body schema: application/json

JSON-formatted document describing the new Agent configuration

name
required
string

A unique name label

orb_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": "my-agent1",
  • "orb_tags": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "my-agent1",
  • "agent_tags": {
    },
  • "orb_tags": {
    },
  • "ts_created": "2019-08-24T14:15:22Z",
  • "agent_metadata": {
    },
  • "state": "online",
  • "last_hb_data": { },
  • "ts_last_hb": "2019-08-24T14:15:22Z",
  • "key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e",
  • "channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459"
}

Get an existing Agent

path Parameters
id
required
string <uuid>

Unique Agent identifier.

header Parameters
Authorization
required
any

User's access token (bearer auth)

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "my-agent1",
  • "agent_tags": {
    },
  • "orb_tags": {
    },
  • "ts_created": "2019-08-24T14:15:22Z",
  • "agent_metadata": {
    },
  • "state": "online",
  • "last_hb_data": { },
  • "ts_last_hb": "2019-08-24T14:15:22Z",
  • "key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e",
  • "channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459"
}

Update an existing Agent

path Parameters
id
required
string <uuid>

Unique Agent identifier.

header Parameters
Authorization
required
any

User's access token (bearer auth)

Request Body schema: application/json

JSON-formatted document describing the updated Agent configuration

name
string

A unique name label

orb_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": "my-agent1",
  • "orb_tags": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "my-agent1",
  • "agent_tags": {
    },
  • "orb_tags": {
    },
  • "ts_created": "2019-08-24T14:15:22Z",
  • "agent_metadata": {
    },
  • "state": "online",
  • "last_hb_data": { },
  • "ts_last_hb": "2019-08-24T14:15:22Z",
  • "key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e",
  • "channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459"
}

Delete an existing Agent

path Parameters
id
required
string <uuid>

Unique Agent identifier.

header Parameters
Authorization
required
any

User's access token (bearer auth)

Responses

Response samples

Content type
application/json
"string"

Get matching groups for an existing Agent

path Parameters
id
required
string <uuid>

Unique Agent identifier.

header Parameters
Authorization
required
any

User's access token (bearer auth)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Validate an Agent configuration without saving it

header Parameters
Authorization
required
any

User's access token (bearer auth)

Request Body schema: application/json

JSON-formatted document describing the new Agent configuration

name
required
string

A unique name label

orb_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": "my-agent1",
  • "orb_tags": {
    }
}

Response samples

Content type
application/json
{
  • "name": "my-agent1",
  • "orb_tags": {
    }
}

List of Agent backends

header Parameters
Authorization
required
any

User's access token (bearer auth)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List of pktvisor Taps available from current agents

header Parameters
Authorization
required
any

User's access token (bearer auth)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List of pktvisor Inputs available across current agents

header Parameters
Authorization
required
any

User's access token (bearer auth)

Responses

Response samples

Content type
application/json
{
  • "pcap": {
    }
}

List of pktvisor Handlers available across current agents

header Parameters
Authorization
required
any

User's access token (bearer auth)

Responses

Response samples

Content type
application/json
{
  • "additionalProperties": {
    }
}

Request for reset agent remotely

path Parameters
id
required
string <uuid>

Unique Agent identifier.

header Parameters
Authorization
required
any

User's access token (bearer auth)

Responses

Response samples

Content type
application/json
"string"