Documentation Powered by ReDoc

Sensor Orchestrator (2023.11)

Download OpenAPI specification:Download

Configuration management and sensor orchestration service

How to Authenticate

v3

AgentServiceV3

Retrieve all agent documents. This is not the agent configuration, it the document that contain agent status and information received from agents. The agent configuration is created separately.

query Parameters
page
integer
Default: 0

Page number - zero counting

limit
integer
Default: 1000

Page size

match
string
Default: ""

Match strategy for filter. Supported matches:

  • match=exact - Performs an exact match
  • match=regex - Performs a regex search (https://www.erlang.org/doc/man/re.html)
  • match=     - Default behaviour. Either exact or 'contains' match, depending on the filtered column.
object

Sort on id, agentType, or agentName. Examples:

  • sort[column]=id&sort[dir]=desc
  • sort[column]=agentType&sort[dir]=asc
  • sort[column]=agentName&sort[dir]=desc
object

Filter on id, agentName, agentType or metadata. Examples:

  • filter[column]=id&filter[value]=myAgentId
  • filter[column]=agentType&filter[value]=actuate
  • filter[column]=agentName&filter[value]=myAgentName
  • filter[column]=metadata.LOCATION&filter[value]=Montreal

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve an agent by agentId.

path Parameters
agentId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete an agent specified by the provided agentId. This will not delete the agent configuration, it will remove agent status.

path Parameters
agentId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create an agent configuration

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create an agent configuration

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all agent configurations

query Parameters
page
integer
Default: 0

Page number - zero counting

limit
integer
Default: 1000

Page size

match
string
Default: ""

Match strategy for filter. Supported matches:

  • match=exact - Performs an exact match
  • match=regex - Performs a regex search (https://www.erlang.org/doc/man/re.html)
  • match=     - Default behaviour. Either exact or 'contains' match, depending on the filtered column.
object

Sort on id or agentName. Examples:

  • sort[column]=id&sort[dir]=desc
  • sort[column]=agentName&sort[dir]=desc
object

Filter on id, agentName, or metadata. Examples:

  • filter[column]=id&filter[value]=myAgentId
  • filter[column]=agentName&filter[value]=myAgentName
  • filter[column]=metadata.LOCATION&filter[value]=Montreal

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Download a techSupport log bz2

path Parameters
agentId
required
string

Responses

Retrieve an agent configuration by agentId.

path Parameters
agentId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update an agent configuration specified by the provided agentId.

path Parameters
agentId
required
string
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete an agent configuration specified by the provided agentId. This will also remove the agent document containing status.

path Parameters
agentId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Sends a given command to be run for the agent specified by agentId

path Parameters
agentId
required
string
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "requestId": "f422344c-1b97-4bd4-8073-773fc592e9e2",
  • "results": [
    ]
}

Retrieve all sessions

query Parameters
page
integer
Default: 0

Page number - zero counting

limit
integer
Default: 1000

Page size

match
string
Default: ""

Match strategy for filter. Supported matches:

  • match=exact - Performs an exact match
  • match=regex - Performs a regex search (https://www.erlang.org/doc/man/re.html)
  • match=     - Default behaviour. Either exact or 'contains' match, depending on the filtered column.
object

Sort on id, sessionType, sessionName, schedule or period. Examples:

  • sort[column]=id&sort[dir]=desc
  • sort[column]=sessionType&sort[dir]=asc
  • sort[column]=sessionName&sort[dir]=desc
  • sort[column]=period&sort[dir]=desc
  • sort[column]=schedule&sort[dir]=desc
object

Filter on id, sessionType, sessionName, period, schedule or metadata. Examples:

  • filter[column]=id&filter[value]=mySessionId
  • filter[column]=sessionType&filter[value]=twamp-stateless
  • filter[column]=sessionName&filter[value]=mySessionName
  • filter[column]=period&filter[value]=continuous
  • filter[column]=schedule&filter[value]=myScheduleId
  • filter[column]=metadata.LOCATION&filter[value]=Montreal

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Create agent sessions

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Create an agent session

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update an agent session.

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve an agent session by sessionId.

path Parameters
sessionId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete an agent session by sessionId.

path Parameters
sessionId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve agent sessions by agentId.

path Parameters
agentId
required
string
query Parameters
page
integer
Default: 0

Page number - zero counting

limit
integer
Default: 1000

Page size

match
string
Default: ""

Match strategy for filter. Supported matches:

  • match=exact - Performs an exact match
  • match=regex - Performs a regex search (https://www.erlang.org/doc/man/re.html)
  • match=     - Default behaviour. Either exact or 'contains' match, depending on the filtered column.
object

Sort on id, sessionType, sessionName, scheduleReference or period. Examples:

  • sort[column]=id&sort[dir]=desc
  • sort[column]=sessionType&sort[dir]=asc
  • sort[column]=sessionName&sort[dir]=desc
  • sort[column]=period&sort[dir]=desc
  • sort[column]=scheduleReference&sort[dir]=desc
object

Filter on id, sessionType, sessionName, period, scheduleReference or metadata. Examples:

  • filter[column]=id&filter[value]=mySessionId
  • filter[column]=sessionType&filter[value]=twamp-stateless
  • filter[column]=sessionName&filter[value]=mySessionName
  • filter[column]=period&filter[value]=continuous
  • filter[column]=scheduleReference&filter[value]=myScheduleName
  • filter[column]=metadata.LOCATION&filter[value]=Montreal

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Delete all sessions for the provided agentId.

path Parameters
agentId
required
string
query Parameters
page
integer
Default: 0

Page number - zero counting

limit
integer
Default: 1000

Page size

match
string
Default: ""

Match strategy for filter. Supported matches:

  • match=exact - Performs an exact match
  • match=regex - Performs a regex search (https://www.erlang.org/doc/man/re.html)
  • match=     - Default behaviour. Either exact or 'contains' match, depending on the filtered column.
object

Sort on id, sessionType, sessionName, scheduleReference or period. Examples:

  • sort[column]=id&sort[dir]=desc
  • sort[column]=sessionType&sort[dir]=asc
  • sort[column]=sessionName&sort[dir]=desc
  • sort[column]=period&sort[dir]=desc
  • sort[column]=scheduleReference&sort[dir]=desc
object

Filter on id, sessionType, sessionName, period, scheduleReference or metadata. Examples:

  • filter[column]=id&filter[value]=mySessionId
  • filter[column]=sessionType&filter[value]=twamp-stateless
  • filter[column]=sessionName&filter[value]=mySessionName
  • filter[column]=period&filter[value]=continuous
  • filter[column]=scheduleReference&filter[value]=myScheduleName
  • filter[column]=metadata.LOCATION&filter[value]=Montreal

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve all session's status

query Parameters
page
integer
Default: 0

Page number - zero counting

limit
integer
Default: 1000

Page size

match
string
Default: ""

Match strategy for filter. Supported matches:

  • match=exact - Performs an exact match
  • match=regex - Performs a regex search (https://www.erlang.org/doc/man/re.html)
  • match=     - Default behaviour. Either exact or 'contains' match, depending on the filtered column.
object

Sort on id, sessionType, sessionName, scheduleReference or period. Examples:

  • sort[column]=id&sort[dir]=desc
  • sort[column]=sessionType&sort[dir]=asc
  • sort[column]=sessionName&sort[dir]=desc
  • sort[column]=period&sort[dir]=desc
  • sort[column]=scheduleReference&sort[dir]=desc
object

Filter on id, sessionType, sessionName, period, scheduleReference or metadata. Examples:

  • filter[column]=id&filter[value]=mySessionId
  • filter[column]=sessionType&filter[value]=twamp-stateless
  • filter[column]=sessionName&filter[value]=mySessionName
  • filter[column]=period&filter[value]=continuous
  • filter[column]=scheduleReference&filter[value]=theScheduleName
  • filter[column]=metadata.LOCATION&filter[value]=Montreal

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieves the session status for session with sessionId

path Parameters
sessionId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieves the reflector status for reflector with reflectorId

path Parameters
reflectorId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Generates and returns the agent secrets required to start an agent

path Parameters
agentId
required
string

Responses

Generates and returns an api-key for use for agent bootstrapping

Responses

Create a new schema

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all schema extensions

query Parameters
page
integer
Default: 0

Page number - zero counting

limit
integer
Default: 1000

Page size

match
string
Default: ""

Match strategy for filter. Supported matches:

  • match=exact - Performs an exact match
  • match=regex - Performs a regex search (https://www.erlang.org/doc/man/re.html)
  • match=     - Default behaviour. Either exact or 'contains' match, depending on the filtered column.
object

Sort on id or name. Examples:

  • sort[column]=name&sort[dir]=asc
  • sort[column]=name&sort[dir]=desc
object

Filter on name or id. Examples:

  • filter[column]=name&filter[value]=mySchemaId
  • filter[column]=name&filter[value]=mySchemaName

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve an extension schema by schemaId.

path Parameters
schemaId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update an extension schema specified by the provided schemaId.

path Parameters
schemaId
required
string
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete an extension schema specified by the provided schemaId.

path Parameters
schemaId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieves the running extension schema for tenant

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": { }
}

Retrieve all agent configurations, agents, and sessions matching metadata search keys

query Parameters
page
integer
Default: 0

Page number - zero counting

limit
integer
Default: 1000

Page size

match
string
Default: ""

Match strategy for filter. Supported matches:

  • match=exact - Performs an exact match
  • match=regex - Performs a regex search (https://www.erlang.org/doc/man/re.html)
  • match=     - Default behaviour. Either exact or 'contains' match, depending on the filtered column.
object

Filter on metadata. Examples:

  • filter[column]=metadata.LOCATION&filter[value]=Montreal
  • filter[column]=metadata.ORG&filter[value]=Sprint

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Create a schedule

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Update a schedule

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieves schedule by scheduleId.

path Parameters
scheduleId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Delete a schedule by scheduleId.

path Parameters
scheduleId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieve all schedules

query Parameters
page
integer
Default: 0

Page number - zero counting

limit
integer
Default: 1000

Page size

match
string
Default: ""

Match strategy for filter. Supported matches:

  • match=exact - Performs an exact match
  • match=regex - Performs a regex search (https://www.erlang.org/doc/man/re.html)
  • match=     - Default behaviour. Either exact or 'contains' match, depending on the filtered column.
object

Sort on id or scheduleName. Examples:

  • sort[column]=id&sort[dir]=desc
  • sort[column]=scheduleName&sort[dir]=desc
object

Filter on id, single or scheduleName. Examples:

  • filter[column]=id&filter[value]=myScheduleId
  • filter[column]=single&filter[value]=true
  • filter[column]=scheduleName&filter[value]=myScheduleName

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieve all schedules usage

query Parameters
page
integer
Default: 0

Page number - zero counting

limit
integer
Default: 1000

Page size

match
string
Default: ""

Match strategy for filter. Supported matches:

  • match=exact - Performs an exact match
  • match=regex - Performs a regex search (https://www.erlang.org/doc/man/re.html)
  • match=     - Default behaviour. Either exact or 'contains' match, depending on the filtered column.
object

Sort on id or scheduleName. Examples:

  • sort[column]=id&sort[dir]=desc
  • sort[column]=scheduleName&sort[dir]=desc
object

Filter on id, single or scheduleName. Examples:

  • filter[column]=id&filter[value]=myScheduleId
  • filter[column]=single&filter[value]=true
  • filter[column]=scheduleName&filter[value]=myScheduleName

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

Retrieves the schedule status for session with sessionId

path Parameters
sessionId
required
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Retrieves aggregate info of the schedule status

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}