South Connectors

Test south connection

Tests the connection for a south connector

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

Path parameters

southIdstring required

Query parameters

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

Request body

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

Response

Ok

Changes

Changed in 30 of the 73 revisions of this API.685132

    • added the new required request property anyOf[SouthFTPSettings]/retryInterval

      new-required-request-property

    • added the new required request property anyOf[SouthSFTPSettings]/retryInterval

      new-required-request-property

  • 9a6250881fa715See the full diff
    • added the new required request property anyOf[SouthOPCUASettings]/maxParallelRun

      new-required-request-property

    • added the new optional request property anyOf[SouthFolderScannerSettings]/domain

      new-optional-request-property

    • added the new optional request property anyOf[SouthFolderScannerSettings]/password

      new-optional-request-property

    • added the new optional request property anyOf[SouthFolderScannerSettings]/username

      new-optional-request-property

    • added SouthInfluxDBSettings to the request body anyOf list

      request-body-any-of-added

    • added the new enum value influxdb to the query request parameter southType

      request-parameter-enum-value-added

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

  • ea1c80cb9c6923See the full diff
    • removed SouthInfluxDBSettings from the request body anyOf list

      request-body-any-of-removed

    • removed the enum value influxdb from the query request parameter southType

      request-parameter-enum-value-removed

    • removed the request property anyOf[SouthFolderScannerSettings]/domain

      request-property-removed

    • removed the request property anyOf[SouthFolderScannerSettings]/password

      request-property-removed

    • removed the request property anyOf[SouthFolderScannerSettings]/username

      request-property-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 optional request property anyOf[SouthFolderScannerSettings]/domain

      new-optional-request-property

    • added the new optional request property anyOf[SouthFolderScannerSettings]/password

      new-optional-request-property

    • added the new optional request property anyOf[SouthFolderScannerSettings]/username

      new-optional-request-property

    • added SouthInfluxDBSettings to the request body anyOf list

      request-body-any-of-added

    • added the new enum value influxdb to the query request parameter southType

      request-parameter-enum-value-added

  • 57cbe043ec5a23See the full diff
    • removed SouthInfluxDBSettings from the request body anyOf list

      request-body-any-of-removed

    • removed the enum value influxdb from the query request parameter southType

      request-parameter-enum-value-removed

    • removed the request property anyOf[SouthFolderScannerSettings]/domain

      request-property-removed

    • removed the request property anyOf[SouthFolderScannerSettings]/password

      request-property-removed

    • removed the request property anyOf[SouthFolderScannerSettings]/username

      request-property-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 optional request property anyOf[SouthFolderScannerSettings]/domain

      new-optional-request-property

    • added the new optional request property anyOf[SouthFolderScannerSettings]/password

      new-optional-request-property

    • added the new optional request property anyOf[SouthFolderScannerSettings]/username

      new-optional-request-property

    • added SouthInfluxDBSettings to the request body anyOf list

      request-body-any-of-added

    • added the new enum value influxdb to the query request parameter southType

      request-parameter-enum-value-added

    • removed SouthInfluxDBSettings from the request body anyOf list

      request-body-any-of-removed

    • removed the enum value influxdb from the query request parameter southType

      request-parameter-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 SouthInfluxDBSettings to the request body anyOf list

      request-body-any-of-added

    • added the new enum value influxdb to the query request parameter southType

      request-parameter-enum-value-added

  • 2c78cb2da64723See the full diff
    • removed SouthInfluxDBSettings from the request body anyOf list

      request-body-any-of-removed

    • removed the enum value influxdb from the query request parameter southType

      request-parameter-enum-value-removed

    • removed the request property anyOf[SouthFolderScannerSettings]/domain

      request-property-removed

    • removed the request property anyOf[SouthFolderScannerSettings]/password

      request-property-removed

    • removed the request property anyOf[SouthFolderScannerSettings]/username

      request-property-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 required request property anyOf[SouthFolderScannerSettings]/domain

      new-required-request-property

    • added the new required request property anyOf[SouthFolderScannerSettings]/password

      new-required-request-property

    • added the new required request property anyOf[SouthFolderScannerSettings]/username

      new-required-request-property