Sign in
South Connectors

List all south connectors

Retrieves a list of all configured south connectors

get/api/south

Response

Array of south connector objects

idstring required

The unique identifier of the entity.

createdBystring

The login of the user who created the entity.

updatedBystring

The login of the user who last updated the entity.

createdAtstring

Represents an instant in time as an ISO 8601 string.

updatedAtstring

Represents an instant in time as an ISO 8601 string.

namestring required

The name of the South connector.

type'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'ads' | 'folder-scanner' | 'ftp' | 'mssql' | 'mysql' | 'odbc' | 'oledb' | 'opc' | 'oracle' | 'osisoft-pi' | 'postgresql' | 'rest' | 'sftp' | 'sqlite' required

Type representing the possible types for a South connector.

descriptionstring required

Description of the South connector's purpose.

enabledboolean required

Whether the South connector is enabled and active.

Example response

[
  {
    "id": "entity123",
    "createdBy": "admin",
    "updatedBy": "admin",
    "createdAt": "2023-10-31T12:34:56.789Z",
    "updatedAt": "2023-10-31T12:34:56.789Z",
    "name": "Production Data Files",
    "description": "Scans production data CSV files",
    "enabled": true
  }
]

Changes