@itentialopensource/adapter-accedian_skylight
Version:
This adapter integrates with system described as: accedianSkylight.
1,880 lines (1,879 loc) • 70.4 kB
JSON
{
"openapi": "3.0.0",
"info": {
"title": "Sensor Orchestrator",
"description": "Configuration management and sensor orchestration service",
"version": "2021.12.0"
},
"tags": [
{
"name": "v3"
}
],
"paths": {
"/api/orchestrate/v3/agents": {
"get": {
"summary": "Retrieve all agents",
"tags": [
"AgentServiceV3"
],
"responses": {
"200": {
"description": "",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentListResponse"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "No agent configurations are provisioned",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
},
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"description": "Page number - zero counting",
"default": 0,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Page size",
"default": 1000,
"schema": {
"type": "integer"
}
}
]
},
"/api/orchestrate/v3/agents/{agentId}": {
"parameters": [
{
"name": "agentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieve an agent by agentId.",
"tags": [
"AgentServiceV3"
],
"responses": {
"200": {
"description": "Successfully fetched agent document for given agentId",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentResponse"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "The specified agent configuration is not provisioned",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
},
"delete": {
"summary": "Delete an agent specified by the provided agentId.",
"tags": [
"AgentServiceV3"
],
"responses": {
"200": {
"description": "Successfully deleted agent with given agentId",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentResponse"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "The specified agent configuration is not provisioned",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/orchestrate/v3/agents/configuration": {
"post": {
"summary": "Create an agent configuration",
"tags": [
"AgentServiceV3"
],
"requestBody": {
"required": true,
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentConfigCreateRequest"
}
}
}
},
"responses": {
"201": {
"description": "Agent configuration create request successfully processed",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentConfigResponse"
}
}
}
},
"400": {
"description": "Invalid payload provided",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"409": {
"description": "The Connector being provisioned already exists",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
},
"get": {
"summary": "Retrieve all agent configurations",
"tags": [
"AgentServiceV3"
],
"responses": {
"200": {
"description": "",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentConfigListResponse"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "No agent configurations are provisioned",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
},
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"description": "Page number - zero counting",
"default": 0,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Page size",
"default": 1000,
"schema": {
"type": "integer"
}
}
]
},
"/api/orchestrate/v3/agents/configuration/{agentId}": {
"parameters": [
{
"name": "agentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieve an agent configuration by agentId.",
"tags": [
"AgentServiceV3"
],
"responses": {
"200": {
"description": "Successfully fetched configuration for given agentId",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentConfigResponse"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "The specified agent configuration is not provisioned",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
},
"put": {
"summary": "Update an agent configuration specified by the provided agentId.",
"tags": [
"AgentServiceV3"
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentConfigUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successfully updated agent configuration for given agentId",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentConfigResponse"
}
}
}
},
"400": {
"description": "Request data does not pass validation",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "The specified agent configuration is not provisioned",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"409": {
"description": "Incorrect revision number passed in to the agent configuration being updated",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
},
"delete": {
"summary": "Delete an agent configuration specified by the provided agentId.",
"tags": [
"AgentServiceV3"
],
"responses": {
"200": {
"description": "Successfully deleted agent configuration for given agentId",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentConfigResponse"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "The specified agent configuration is not provisioned",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/orchestrate/v3/agents/{agentId}/command": {
"parameters": [
{
"name": "agentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Sends a given command to be run for the agent specified by agentId",
"tags": [
"AgentServiceV3"
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentCommandRequest"
}
}
}
},
"responses": {
"200": {
"description": "Run agent command request successfully processed",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/requestId"
}
}
}
},
"400": {
"description": "Invalid payload provided",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/orchestrate/v3/agents/sessions": {
"get": {
"summary": "Retrieve all sessions",
"tags": [
"AgentServiceV3"
],
"responses": {
"200": {
"description": "",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentSessionListResponse"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "No sessions are provisioned",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
},
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"description": "Page number - zero counting",
"default": 0,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"description": "Page size",
"default": 1000,
"schema": {
"type": "integer"
}
}
],
"post": {
"summary": "Create agent sessions",
"tags": [
"AgentServiceV3"
],
"requestBody": {
"required": true,
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentSessionListCreateRequest"
}
}
}
},
"responses": {
"201": {
"description": "Agent sessions create request successfully processed",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentSessionListResponse"
}
}
}
},
"400": {
"description": "Invalid payload provided",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/orchestrate/v3/agents/session": {
"post": {
"summary": "Create an agent session",
"tags": [
"AgentServiceV3"
],
"requestBody": {
"required": true,
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentSessionCreateRequest"
}
}
}
},
"responses": {
"201": {
"description": "Agent session create request successfully processed",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentSessionResponse"
}
}
}
},
"400": {
"description": "Invalid payload provided",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
},
"put": {
"summary": "Update an agent session.",
"tags": [
"AgentServiceV3"
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentSessionUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successfully updated agent session",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentSessionResponse"
}
}
}
},
"400": {
"description": "Request data does not pass validation",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "The specified agent configuration is not provisioned",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"409": {
"description": "Incorrect revision number passed in for session being updated",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/orchestrate/v3/agents/session/{sessionId}": {
"parameters": [
{
"name": "sessionId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieve an agent session by sessionId.",
"tags": [
"AgentServiceV3"
],
"responses": {
"200": {
"description": "Successfully fetched sessions for given sessionId",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentSessionResponse"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "The specified session is not provisioned",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
},
"delete": {
"summary": "Delete an agent session by sessionId.",
"tags": [
"AgentServiceV3"
],
"responses": {
"200": {
"description": "Successfully deleted agent configuration with given sessionId",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentSessionResponse"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "The specified session is not provisioned",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/orchestrate/v3/agents/sessions/{agentId}": {
"parameters": [
{
"name": "agentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieve agent sessions by agentId.",
"tags": [
"AgentServiceV3"
],
"responses": {
"200": {
"description": "Successfully fetched sessions for given agentId",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentSessionListResponse"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "The specified agent is not provisioned",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
},
"delete": {
"summary": "Delete all sessions for the provided agentId.",
"tags": [
"AgentServiceV3"
],
"responses": {
"200": {
"description": "Successfully deleted sessions for given agentId",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/AgentSessionListResponse"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "The specified agent is not found",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/orchestrate/v3/agents/sessionstatus/{sessionId}": {
"parameters": [
{
"name": "sessionId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"summary": "Retrieves the session status for session with sessionId",
"tags": [
"AgentServiceV3"
],
"responses": {
"200": {
"description": "Session Status successfully retrieved",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/SessionStatusResponse"
}
}
}
},
"400": {
"description": "Invalid payload provided",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "The specified session is not found",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/orchestrate/v3/agents/{agentId}/secrets": {
"parameters": [
{
"name": "agentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"post": {
"summary": "Generates and returns the agent secrets required to start an agent",
"tags": [
"AgentServiceV3"
],
"responses": {
"200": {
"description": "Secrets successfully generated",
"content": {
"text/yaml": {
"schema": {
"$ref": "#/components/schemas/AgentSecrets"
}
}
}
},
"400": {
"description": "Invalid payload provided",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"403": {
"description": "Requestor does not have authorization to perform this action",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "The specified agent is not found",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Unexpected error processing request",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AgentUpdateRequest": {
"type": "object",
"required": [
"data"
],
"description": "Object used to update an existing agent",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"agents"
]
},
"id": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"_rev": {
"type": "string",
"description": "Value used to ensure updates to this object are handled in order."
},
"agentName": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/AgentMetadata"
}
}
}
}
}
}
},
"AgentCreateRequest": {
"type": "object",
"required": [
"data"
],
"description": "Object used to create an agent",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"agents"
]
},
"attributes": {
"type": "object",
"properties": {
"agentName": {
"type": "string"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/AgentMetadata"
}
}
}
}
}
}
},
"AgentListResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Agent"
}
}
}
},
"AgentResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/Agent"
}
}
},
"AgentConfigUpdateRequest": {
"type": "object",
"required": [
"data"
],
"description": "Object used to update an existing agent configuration",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"agentConfigs"
]
},
"id": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"_rev": {
"type": "string",
"description": "Value used to ensure updates to this object are handled in order."
},
"agentId": {
"type": "string"
},
"dataGateway": {
"$ref": "#/components/schemas/dataGatewayConfig"
},
"reflector": {
"$ref": "#/components/schemas/agentReflectors"
},
"metadata": {
"$ref": "#/components/schemas/AgentMetadata"
},
"identification": {
"$ref": "#/components/schemas/AgentConfigIdentification"
}
}
}
}
}
}
},
"AgentConfigCreateRequest": {
"type": "object",
"required": [
"data"
],
"description": "Object used to create an agent configuration",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"agentConfigs"
]
},
"attributes": {
"type": "object",
"properties": {
"agentId": {
"type": "string"
},
"dataGateway": {
"$ref": "#/components/schemas/dataGatewayConfig"
},
"reflector": {
"$ref": "#/components/schemas/agentReflectors"
},
"metadata": {
"$ref": "#/components/schemas/AgentMetadata"
},
"identification": {
"$ref": "#/components/schemas/AgentConfigIdentification"
}
}
}
}
}
}
},
"AgentConfigListResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentConfig"
}
}
}
},
"AgentConfigResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/AgentConfig"
}
}
},
"AgentCommand": {
"description": "Execute a command on the agent.",
"type": "object",
"required": [
"command"
],
"properties": {
"command": {
"$ref": "#/components/schemas/command"
},
"args": {
"type": "array",
"items": {
"type": "object",
"description": "List of arguments, dependent on the test. Execute the command on a test or on a session. Use appropriate argument.",
"properties": {
"type": {
"$ref": "#/components/schemas/commandType"
},
"sessionId": {
"$ref": "#/components/schemas/sessionId"
},
"overrides": {
"$ref": "#/components/schemas/override"
},
"populateFields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"networkMtuBytes",
"networkBottleneckBandwidthBitsPerSec",
"networkRttMs"
]
}
}
}
}
}
}
},
"AgentCommandRequest": {
"type": "object",
"required": [
"data"
],
"description": "Object used to create a command for the agent to run",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"agentCommands"
]
},
"attributes": {
"$ref": "#/components/schemas/AgentCommand"
}
}
}
}
},
"AgentConfigIdentification": {
"type": "object",
"description": "Identification Information",
"properties": {
"agentName": {
"type": "string"
}
}
},
"AgentSecrets": {
"type": "object",
"description": "Secrets required to start an agent",
"required": [
"agentConfig"
],
"properties": {
"agentConfig": {
"type": "object",
"required": [
"identification"
],
"properties": {
"identification": {
"type": "object",
"properties": {
"agentId": {
"type": "string",
"format": "uuid",
"descripton": "UUID of the agent"
},
"authenticationToken": {
"type": "string"
}
}
}
}
}
}
},
"Agent": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"agents"
]
},
"id": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"_rev": {
"type": "string",
"description": "Value used to ensure updates to this object are handled in order."
},
"agentId": {
"type": "string"
},
"agentName": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"state": {
"type": "string"
},
"version": {
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/AgentMetadata"
},
"agentConfigRevision": {
"type": "string"
},
"agentConfigRevisionAck": {
"type": "string"
}
}
}
}
},
"AgentConfig": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"agentConfigs"
]
},
"id": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"_rev": {
"type": "string",
"description": "Value used to ensure updates to this object are handled in order."
},
"agentId": {
"type": "string"
},
"dataGateway": {
"$ref": "#/components/schemas/dataGatewayConfig"
},
"reflector": {
"$ref": "#/components/schemas/agentReflectors"
},
"metadata": {
"$ref": "#/components/schemas/AgentMetadata"
},
"identification": {
"$ref": "#/components/schemas/AgentConfigIdentification"
}
}
}
}
},
"AgentMetadata": {
"type": "object"
},
"AgentSession": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"agentSessions"
]
},
"id": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"_rev": {
"type": "string",
"description": "Value used to ensure updates to this object are handled in order."
},
"agentId": {
"type": "string"
},
"session": {
"$ref": "#/components/schemas/session"
}
}
}
}
},
"AgentSessionListResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentSession"
}
}
}
},
"AgentSessionResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/AgentSession"
}
}
},
"AgentSessionCreateRequest": {
"type": "object",
"required": [
"data"
],
"description": "Object used to create an agent session",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"agentSessions"
]
},
"attributes": {
"type": "object",
"properties": {
"agentId": {
"type": "string"
},
"session": {
"$ref": "#/components/schemas/session"
}
}
}
}
}
}
},
"AgentSessionUpdateRequest": {
"type": "object",
"required": [
"data"
],
"description": "Object used to update an existing agent session",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"agentSessions"
]
},
"id": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"_rev": {
"type": "string",
"description": "Value used to ensure updates to this object are handled in order."
},
"agentId": {
"type": "string"
},
"session": {
"$ref": "#/components/schemas/session"
}
}
}
}
}
}
},
"AgentSessionListCreateRequest": {
"type": "object",
"required": [
"data"
],
"description": "Object used to bulk create sessions",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"agentSessionLists"
]
},
"attributes": {
"type": "object",
"properties": {
"agentId": {
"type": "string"
},
"sessionlist": {
"$ref": "#/components/schemas/sessions"
}
}
}
}
}
}
},
"SessionStatusResponse": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"type": {
"type": "string",
"enum": [
"sessionStatuses"
]
},
"attributes": {
"$ref": "#/components/schemas/sessionStatus"
}
}
}
}
},
"dataGatewayConfig": {
"description": "Configuration elements for the data gateway.",
"type": "object",
"properties": {
"server": {
"type": "string",
"description": "IP or FQDN for the data broker to connect to."
},
"port": {
"type": "number",
"default": 55888,
"minimum": 1024,
"maximum": 65535,
"description": "The data broker connection port."
},
"dataBrokerUseSsl": {
"type": "boolean",
"description": "Enable secure connection."
},
"dataBrokerSslAllowSelfsigned": {
"type": "boolean",
"description": "Allow self signed certificates on the secure connection."
},