South Connectors

List all south connectors

Changed on

Retrieves a list of all configured south connectors

get/api/south

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/south
  • Auth: none required

Response

Array of south connector objects

idstring required

The unique identifier of the entity.

createdAtstring required

Represents an instant in time as an ISO 8601 string.

updatedAtstring required

Represents an instant in time as an ISO 8601 string.

namestring required

The name of the South connector.

type'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'ads' | 'bacnet' | 'folder-scanner' | 'ftp' | 'influxdb' | 'mongodb' | 'mssql' | 'mysql' | 'odbc' | 'oledb' | 'opc' | 'oracle' | 'osisoft-pi' | 'postgresql' | 'rest' | 's7' | '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": {
      "id": "abc123",
      "friendlyName": "John Doe (john.doe)"
    },
    "updatedBy": {
      "id": "abc123",
      "friendlyName": "John Doe (john.doe)"
    },
    "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

  • 0df3f625a5c2Revision changes
    • warning

      added the new bacnet enum value to the / response property for the response status

    • warning

      added the new mongodb enum value to the / response property for the response status

    • warning

      added the new s7 enum value to the / response property for the response status

  • 21b34a490fa3Revision changes
    • info

      removed the bacnet enum value from the / response property for the response status

    • info

      removed the mongodb enum value from the / response property for the response status

    • info

      removed the s7 enum value from the / response property for the response status