Sign in
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

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,
      "overlap": 1000
    }
  ]
}

Response

Created

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

Example response

{
  "id": "entity123",
  "creationDate": "2023-10-31T12:34:56.789Z",
  "lastEditInstant": "2023-10-31T12:34:56.789Z",
  "name": "Production Data Files",
  "type": "folder-scanner",
  "description": "Scans production data CSV files",
  "enabled": true,
  "items": [
    {
      "id": "entity123",
      "creationDate": "2023-10-31T12:34:56.789Z",
      "lastEditInstant": "2023-10-31T12:34:56.789Z",
      "name": "Temperature Logs",
      "enabled": true,
      "scanMode": {
        "id": "entity123",
        "creationDate": "2023-10-31T12:34:56.789Z",
        "lastEditInstant": "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",
        "creationDate": "2023-10-31T12:34:56.789Z",
        "lastEditInstant": "2023-10-31T12:34:56.789Z",
        "name": "Production Line A",
        "scanMode": {
          "id": "entity123",
          "creationDate": "2023-10-31T12:34:56.789Z",
          "lastEditInstant": "2023-10-31T12:34:56.789Z",
          "name": "Daily Backup Scan",
          "description": "Scans for new backup data every day at midnight",
          "cron": "0 0 * * *"
        },
        "overlap": 1000,
        "maxReadInterval": 3600,
        "readDelay": 200
      },
      "syncWithGroup": true,
      "maxReadInterval": 3600,
      "readDelay": 200,
      "overlap": 1000
    }
  ]
}

Changes