Sign in

v70

latestOpenAPI 3.0.0EUPLraw.githubusercontent.com2026-08-031426201.0 MB
South Connectors

Create south connector

Creates a new south connector with the provided configuration

post/api/south

Query parameters

duplicatestring required

Request body

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

Example request

{
  "name": "Production Data Files",
  "type": "folder-scanner",
  "description": "Scans production data CSV files",
  "enabled": true,
  "items": [
    {
      "enabled": true,
      "name": "Temperature Logs",
      "scanModeId": "periodic-5min",
      "groupId": "group-123",
      "groupName": "Production Line A",
      "syncWithGroup": true,
      "maxReadInterval": 3600,
      "readDelay": 200,
      "startTimeOffset": -1000
    }
  ],
  "groups": [
    {
      "standardSettings": {
        "scanModeId": "periodic-5min",
        "name": "Production Line A"
      },
      "historySettings": {
        "readDelay": 200,
        "maxReadInterval": 3600,
        "startTimeOffset": -1000
      }
    }
  ]
}

Response

Created

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

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",
  "type": "folder-scanner",
  "description": "Scans production data CSV files",
  "enabled": true,
  "items": [
    {
      "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": "Temperature Logs",
      "enabled": true,
      "scanMode": {
        "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": "Daily Backup Scan",
        "description": "Scans for new backup data every day at midnight",
        "cron": "0 0 * * *"
      },
      "group": {
        "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",
        "standardSettings": {
          "scanMode": {
            "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": "Daily Backup Scan",
            "description": "Scans for new backup data every day at midnight",
            "cron": "0 0 * * *"
          },
          "name": "Production Line A"
        },
        "historySettings": {
          "readDelay": 200,
          "maxReadInterval": 3600,
          "startTimeOffset": -1000
        }
      },
      "syncWithGroup": true,
      "maxReadInterval": 3600,
      "readDelay": 200,
      "startTimeOffset": -1000
    }
  ],
  "groups": [
    {
      "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",
      "standardSettings": {
        "scanMode": {
          "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": "Daily Backup Scan",
          "description": "Scans for new backup data every day at midnight",
          "cron": "0 0 * * *"
        },
        "name": "Production Line A"
      },
      "historySettings": {
        "readDelay": 200,
        "maxReadInterval": 3600,
        "startTimeOffset": -1000
      }
    }
  ]
}