Connection API specification (11303d1a132df8e6acffce9476ea55cade4869ba)

Download OpenAPI specification:Download

The connection service hosts the connection API. It is responsible for managing connections between organizations and external services over Websockets, WDX3, IMAP or MQTT.

connection

ConnectionUpdates

Creates a sse endpoint to listen for connection changes

Authorizations:
API-TOKENPersonal-Access-Token
query Parameters
organizationID
required
integer

Responses

ListConnections

List all connections for a organization

Authorizations:
API-TOKENPersonal-Access-Token
query Parameters
organizationID
required
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreateConnection

Creates a connection with the passed parameters

Authorizations:
API-TOKENPersonal-Access-Token
Request Body schema: application/json
required
object (CobraConfigurationCreate)

CobraConfigurationCreate contains the information needed to create a cobra configuration

connectionType
string (ConnectionType)

ConnectionType indicates what type of configuration is used for the connection

description
string
enabled
boolean
name
string
organizationID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "cobraConfiguration": {
    },
  • "connectionType": "string",
  • "description": "string",
  • "enabled": true,
  • "name": "string",
  • "organizationID": 0
}

Response samples

Content type
application/json
{
  • "cobraConfiguration": {
    },
  • "connectedAt": null,
  • "connectionStatus": "string",
  • "connectionType": "string",
  • "description": "string",
  • "disconnectedAt": null,
  • "enabled": true,
  • "id": 0,
  • "lastMessageAt": null,
  • "name": "string",
  • "organizationID": 0
}

VerifyConnection

Verifies the parameters of a connection are valid and allow connection

Authorizations:
API-TOKENPersonal-Access-Token
Request Body schema: application/json
required
object (CobraConfigurationCreate)

CobraConfigurationCreate contains the information needed to create a cobra configuration

connectionType
string (ConnectionType)

ConnectionType indicates what type of configuration is used for the connection

description
string
enabled
boolean
name
string
organizationID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "cobraConfiguration": {
    },
  • "connectionType": "string",
  • "description": "string",
  • "enabled": true,
  • "name": "string",
  • "organizationID": 0
}

GetConnection

Returns a connection with the passed connectionID

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
connectionID
required
integer

Responses

Response samples

Content type
application/json
{
  • "cobraConfiguration": {
    },
  • "connectedAt": null,
  • "connectionStatus": "string",
  • "connectionType": "string",
  • "description": "string",
  • "disconnectedAt": null,
  • "enabled": true,
  • "id": 0,
  • "lastMessageAt": null,
  • "name": "string",
  • "organizationID": 0
}

DeleteConnection

Deletes a connection with the passed connectionID

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
connectionID
required
integer

Responses

UpdateConnection

Updates editable connection parameters. If configuration parameters are empty, they will not be updated

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
connectionID
required
integer
Request Body schema: application/json
required
object (CobraConfigurationPatch)

CobraConfigurationPatch is used to update a CobraConfiguration

connectionType
string

add the name of the new configurations to the oneof

description
string
enabled
boolean
name
string
organizationID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "cobraConfiguration": {
    },
  • "connectionType": "string",
  • "description": "string",
  • "enabled": true,
  • "name": "string",
  • "organizationID": 0
}

EnableConnection

Enables or disables a connection (default: disable)

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
connectionID
required
integer
query Parameters
enabled
required
boolean

Responses

LiveViewConnection

Creates a SSE endpoint to listen for incoming messages

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
connectionID
required
integer

Responses

GetLogs

Returns the logs for a connection

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
connectionID
required
integer
query Parameters
limit
integer
offset
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

VerifyConnectionPatch

Verifies the parameters of a connection are valid and allow connection

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
connectionID
required
integer
Request Body schema: application/json
required
object (CobraConfiguration)

CobraConfiguration contains the unencrypted access information for connecting to a WDX3 server

connectedAt
any
connectionStatus
string (ConnectionStatus)

ConnectionStatus indicates the status of the connection

connectionType
string (ConnectionType)

ConnectionType indicates what type of configuration is used for the connection

description
string
disconnectedAt
any
enabled
boolean
id
integer <int64>
lastMessageAt
any
name
string
organizationID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "cobraConfiguration": {
    },
  • "connectedAt": null,
  • "connectionStatus": "string",
  • "connectionType": "string",
  • "description": "string",
  • "disconnectedAt": null,
  • "enabled": true,
  • "id": 0,
  • "lastMessageAt": null,
  • "name": "string",
  • "organizationID": 0
}

filter

UpdateFilter

Update a filter

Authorizations:
API-TOKENPersonal-Access-Token
Request Body schema: application/json
required
connectionId
integer <int64>
Array of objects (OrganizationValues)
paths
Array of strings

Responses

Request samples

Content type
application/json
{
  • "connectionId": 0,
  • "organizationValues": [
    ],
  • "paths": [
    ]
}

GetFilter

Get a filter

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
connectionID
required
integer

Responses

Response samples

Content type
application/json
{
  • "connectionId": 0,
  • "organizationValues": [
    ],
  • "paths": [
    ]
}

DeleteFilter

Delete a filter

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
connectionID
required
integer

Responses