South Connectors

Create south item group

Creates a new group for a south connector

post/api/south/{southId}/groups

Path parameters

southIdstring required

Request body

idstring nullable required

The ID of the group (null when creating a new group).

Example request

{
  "standardSettings": {
    "scanModeId": "periodic-5min",
    "name": "Production Line A"
  },
  "historySettings": {
    "readDelay": 200,
    "maxReadInterval": 3600,
    "startTimeOffset": -1000
  }
}

Response

Created

idstring required

The unique identifier of the entity.

createdAtstring required

Represents an instant in time as an ISO 8601 string.

updatedAtstring required

Represents an instant in time as an ISO 8601 string.

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",
  "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
  }
}

Changes

Changed in 29 of the 73 revisions of this API.563350

Jul 28, 20269a6250881fa7413See the full diff
- ▲
  added the new required request property historySettings/endTimeOffset
  new-required-request-property
- ▲
  added the new required request property historySettings/recoveryStrategy
  new-required-request-property
- ▲
  added the new required request property historySettings/startTimeOffset
  new-required-request-property
- ▲
  removed the required property historySettings/overlap from the response with the 201 status
  response-required-property-removed
- ●
  removed the request property historySettings/overlap
  request-property-removed
- ○
  added the required property historySettings/endTimeOffset to the response with the 201 status
  response-required-property-added
- ○
  added the required property historySettings/recoveryStrategy to the response with the 201 status
  response-required-property-added
- ○
  added the required property historySettings/startTimeOffset to the response with the 201 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 2026ea1c80cb9c69431See the full diff
- ▲
  added the new required request property historySettings/overlap
  new-required-request-property
- ▲
  removed the required property historySettings/endTimeOffset from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property historySettings/recoveryStrategy from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property historySettings/startTimeOffset from the response with the 201 status
  response-required-property-removed
- ●
  removed the request property historySettings/endTimeOffset
  request-property-removed
- ●
  removed the request property historySettings/recoveryStrategy
  request-property-removed
- ●
  removed the request property historySettings/startTimeOffset
  request-property-removed
- ○
  added the required property historySettings/overlap to the response with the 201 status
  response-required-property-added
This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 20, 20266a232346b158413See the full diff
- ▲
  added the new required request property historySettings/endTimeOffset
  new-required-request-property
- ▲
  added the new required request property historySettings/recoveryStrategy
  new-required-request-property
- ▲
  added the new required request property historySettings/startTimeOffset
  new-required-request-property
- ▲
  removed the required property historySettings/overlap from the response with the 201 status
  response-required-property-removed
- ●
  removed the request property historySettings/overlap
  request-property-removed
- ○
  added the required property historySettings/endTimeOffset to the response with the 201 status
  response-required-property-added
- ○
  added the required property historySettings/recoveryStrategy to the response with the 201 status
  response-required-property-added
- ○
  added the required property historySettings/startTimeOffset to the response with the 201 status
  response-required-property-added
Jul 15, 202657cbe043ec5a431See the full diff
- ▲
  added the new required request property historySettings/overlap
  new-required-request-property
- ▲
  removed the required property historySettings/endTimeOffset from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property historySettings/recoveryStrategy from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property historySettings/startTimeOffset from the response with the 201 status
  response-required-property-removed
- ●
  removed the request property historySettings/endTimeOffset
  request-property-removed
- ●
  removed the request property historySettings/recoveryStrategy
  request-property-removed
- ●
  removed the request property historySettings/startTimeOffset
  request-property-removed
- ○
  added the required property historySettings/overlap to the response with the 201 status
  response-required-property-added
This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 6, 20264c50d4a73f66413See the full diff
- ▲
  added the new required request property historySettings/endTimeOffset
  new-required-request-property
- ▲
  added the new required request property historySettings/recoveryStrategy
  new-required-request-property
- ▲
  added the new required request property historySettings/startTimeOffset
  new-required-request-property
- ▲
  removed the required property historySettings/overlap from the response with the 201 status
  response-required-property-removed
- ●
  removed the request property historySettings/overlap
  request-property-removed
- ○
  added the required property historySettings/endTimeOffset to the response with the 201 status
  response-required-property-added
- ○
  added the required property historySettings/recoveryStrategy to the response with the 201 status
  response-required-property-added
- ○
  added the required property historySettings/startTimeOffset to the response with the 201 status
  response-required-property-added
Jul 3, 2026a460443e789e431See the full diff
- ▲
  added the new required request property historySettings/overlap
  new-required-request-property
- ▲
  removed the required property historySettings/endTimeOffset from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property historySettings/recoveryStrategy from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property historySettings/startTimeOffset from the response with the 201 status
  response-required-property-removed
- ●
  removed the request property historySettings/endTimeOffset
  request-property-removed
- ●
  removed the request property historySettings/recoveryStrategy
  request-property-removed
- ●
  removed the request property historySettings/startTimeOffset
  request-property-removed
- ○
  added the required property historySettings/overlap to the response with the 201 status
  response-required-property-added
This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 30, 2026c5a35475739f312See the full diff
- ▲
  added the new required request property historySettings/endTimeOffset
  new-required-request-property
- ▲
  added the new required request property historySettings/startTimeOffset
  new-required-request-property
- ▲
  removed the required property historySettings/overlap from the response with the 201 status
  response-required-property-removed
- ●
  removed the request property historySettings/overlap
  request-property-removed
- ○
  added the required property historySettings/endTimeOffset to the response with the 201 status
  response-required-property-added
- ○
  added the required property historySettings/startTimeOffset to the response with the 201 status
  response-required-property-added
Jun 29, 2026ea736a81a93111See the full diff
- ▲
  added the new required request property historySettings/recoveryStrategy
  new-required-request-property
- ○
  added the required property historySettings/recoveryStrategy to the response with the 201 status
  response-required-property-added
Jun 24, 20262c78cb2da647431See the full diff
- ▲
  added the new required request property historySettings/overlap
  new-required-request-property
- ▲
  removed the required property historySettings/endTimeOffset from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property historySettings/recoveryStrategy from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property historySettings/startTimeOffset from the response with the 201 status
  response-required-property-removed
- ●
  removed the request property historySettings/endTimeOffset
  request-property-removed
- ●
  removed the request property historySettings/recoveryStrategy
  request-property-removed
- ●
  removed the request property historySettings/startTimeOffset
  request-property-removed
- ○
  added the required property historySettings/overlap to the response with the 201 status
  response-required-property-added
This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 23, 20269eab61b4f349312See the full diff
- ▲
  added the new required request property historySettings/endTimeOffset
  new-required-request-property
- ▲
  added the new required request property historySettings/startTimeOffset
  new-required-request-property
- ▲
  removed the required property historySettings/overlap from the response with the 201 status
  response-required-property-removed
- ●
  removed the request property historySettings/overlap
  request-property-removed
- ○
  added the required property historySettings/endTimeOffset to the response with the 201 status
  response-required-property-added
- ○
  added the required property historySettings/startTimeOffset to the response with the 201 status
  response-required-property-added

Full history (29 revisions)