Connection API specification (61595c9d962b0d01a0ca36cb3823ee7b3ed56d45)

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

200

Content type

application/json

[{"cobraConfiguration": {"certificate": "string",
"id": 0,
"lastOperationMessageID": 0,
"lastOperationalResourceMessageID": 0,
"password": "string",
"privateKey": "string",
"server": "string",
"username": "string"
},
"connectedAt": null,
"connectionStatus": "string",
"connectionType": "string",
"description": "string",
"disconnectedAt": null,
"enabled": true,
"id": 0,
"lastMessageAt": null,
"name": "string",
"organizationID": 0
}
]

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

Payload

Content type

application/json

{"cobraConfiguration": {"certificate": "string",
"password": "string",
"privateKey": "string",
"server": "string",
"username": "string"
},
"connectionType": "string",
"description": "string",
"enabled": true,
"name": "string",
"organizationID": 0
}

Response samples

201

Content type

application/json

{"cobraConfiguration": {"certificate": "string",
"id": 0,
"lastOperationMessageID": 0,
"lastOperationalResourceMessageID": 0,
"password": "string",
"privateKey": "string",
"server": "string",
"username": "string"
},
"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

Payload

Content type

application/json

{"cobraConfiguration": {"certificate": "string",
"password": "string",
"privateKey": "string",
"server": "string",
"username": "string"
},
"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

200

Content type

application/json

{"cobraConfiguration": {"certificate": "string",
"id": 0,
"lastOperationMessageID": 0,
"lastOperationalResourceMessageID": 0,
"password": "string",
"privateKey": "string",
"server": "string",
"username": "string"
},
"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

Payload

Content type

application/json

{"cobraConfiguration": {"certificate": "string",
"password": "string",
"privateKey": "string",
"server": "string",
"username": "string"
},
"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

200

Content type

application/json

[{"logs": [{"connectionID": 0,
"id": 0,
"message": "string",
"severity": "string",
"timestamp": null
}
],
"totalLogs": 0
}
]

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

Payload

Content type

application/json

{"cobraConfiguration": {"certificate": "string",
"id": 0,
"lastOperationMessageID": 0,
"lastOperationalResourceMessageID": 0,
"password": "string",
"privateKey": "string",
"server": "string",
"username": "string"
},
"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

Payload

Content type

application/json

{"connectionId": 0,
"organizationValues": [{"filterValues": ["string"
],
"organizationId": 0
}
],
"paths": ["string"
]
}

GetFilter

Get a filter

Authorizations:

API-TOKENPersonal-Access-Token

path Parameters

connectionID

required

integer

Responses

Response samples

200

Content type

application/json

{"connectionId": 0,
"organizationValues": [{"filterValues": ["string"
],
"organizationId": 0
}
],
"paths": ["string"
]
}

DeleteFilter

Delete a filter

Authorizations:

API-TOKENPersonal-Access-Token

path Parameters

connectionID

required

integer

Connection API specification (61595c9d962b0d01a0ca36cb3823ee7b3ed56d45)

connection

ConnectionUpdates

Authorizations:

query Parameters

Responses

ListConnections

Authorizations:

query Parameters

Responses

Response samples

CreateConnection

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

VerifyConnection

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

GetConnection

Authorizations:

path Parameters

Responses

Response samples

DeleteConnection

Authorizations:

path Parameters

Responses

UpdateConnection

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

EnableConnection

Authorizations:

path Parameters

query Parameters

Responses

LiveViewConnection

Authorizations:

path Parameters

Responses

GetLogs

Authorizations:

path Parameters

query Parameters

Responses

Response samples

VerifyConnectionPatch

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

filter

UpdateFilter

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

GetFilter

Authorizations:

path Parameters

Responses

Response samples

DeleteFilter

Authorizations:

path Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required