South Connectors

List all south connector types

Changed on

Retrieves a list of all available south connector types

get/api/south/types

Request

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

Response

Array of south connector type objects

id'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.

category'file' | 'iot' | 'database' | 'api' required

Type representing the possible categories for a South connector.

betaboolean

Whether this connector type is in beta.

Example response

[
  {
    "modes": {
      "lastFile": 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

    • info

      added the optional property / to the response with the status

  • 21b34a490fa3Revision changes
    • warning

      removed the optional property / from the response with the status

    • 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