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.

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' | 'folder-scanner' | 'ftp' | 'influxdb' | '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": {
      "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

Changed in 23 of the 73 revisions of this API.122031

    • added the new influxdb enum value to the items/type response property for the response status 200

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the influxdb enum value from the items/type response property for the response status 200

      response-property-enum-value-removed

    This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new influxdb enum value to the items/type response property for the response status 200

      response-property-enum-value-added

    • removed the influxdb enum value from the items/type response property for the response status 200

      response-property-enum-value-removed

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new influxdb enum value to the items/type response property for the response status 200

      response-property-enum-value-added

    • removed the influxdb enum value from the items/type response property for the response status 200

      response-property-enum-value-removed

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new influxdb enum value to the items/type response property for the response status 200

      response-property-enum-value-added

    • removed the influxdb enum value from the items/type response property for the response status 200

      response-property-enum-value-removed

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new influxdb enum value to the items/type response property for the response status 200

      response-property-enum-value-added

    • removed the influxdb enum value from the items/type response property for the response status 200

      response-property-enum-value-removed

    This revision also has 22 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog