Skip to main content

Introduction

APIs and Models to manage your connections

API​

Here is the list of APIs existing under the connections category.

APIDescription
GetAllConnectionsAsyncGets the list of all Connections from the connected Control Room.
GetConnectionDataAsyncGets the connection using the connection ID from the connected Control Room.
GetConnectionByNameAsyncGets the connection using the connection name from the connected Control Room.

Models​

Here is the list of models used in connection APIs.

ModelsDescription
ConnectionThe structure represents an instance of the Connection entity.
ConnectionDataThe structure represents an instance of the ConnectionData entity.