South Connectors

Test south connection

Changed on

Tests the connection for a south connector

post/api/south/{southId}/test/connection

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/south/{southId}/test/connection
  • Auth: none required

Path parameters

southIdstring required

Query parameters

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

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Response

Ok

Changes

  • 0df3f625a5c2Revision changes
    • info

      added to the request body anyOf list

    • info

      added the new enum value bacnet to the query request parameter southType

    • info

      added the new enum value mongodb to the query request parameter southType

    • info

      added the new enum value s7 to the query request parameter southType

  • 21b34a490fa3Revision changes
    • breaking

      removed from the request body anyOf list

    • breaking

      removed the enum value bacnet from the query request parameter southType

    • breaking

      removed the enum value mongodb from the query request parameter southType

    • breaking

      removed the enum value s7 from the query request parameter southType