Data Sources

Get Data Sources

get

Returns a list of data sources in your organization.

Authorizations

AuthorizationstringRequired

Query parameters

cursorstringOptional

uuidstring · uuid[] · max: 50 · nullableOptional

machinestring · uuid[] · max: 50 · nullableOptional

sparkstring · uuid[] · max: 50 · nullableOptional

limitinteger · min: 1 · max: 1000Optional

Caps the page size. Defaults to 1000, which is also the maximum; a value below 1 or above 1000 is rejected.

Default: 1000

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get/v2/data-sources

GET /api/v2/data-sources HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "readout_limit": 1,
      "readout_interval": 1,
      "readout_status": {
        "last_readout_at": "2026-01-01T00:00:00.000Z",
        "configured_variables": 1,
        "state": {
          "type": "OK"
        }
      },
      "name": "text",
      "spark": "123e4567-e89b-12d3-a456-426614174000",
      "manufacturer": "Siemens",
      "device_model": "S7-1214C",
      "note": "text",
      "capabilities": {
        "variable_discovery": true
      },
      "machine": "123e4567-e89b-12d3-a456-426614174000",
      "details": {
        "host": "text",
        "port": 44818,
        "type": "text"
      }
    }
  ],
  "metadata": {
    "next_cursor": "text"
  }
}

Post Data Source

post

Create a new data source

Authorizations

AuthorizationstringRequired

Body

namestringRequired

The human readable name of the data source.

sparkstring · uuidRequired

Which SPARK reads from the data source. It must be located at the same site as the current SPARK.

manufacturerstring · nullableOptional

Manufacturer of the data source.

Example: Siemens

device_modelstring · nullableOptional

Specific model or name describing the data source as concretely as possible.

Example: S7-1214C

notestring · nullableOptional

General remarks concerning this data source.

machinestring · uuidRequired

On which machine the data source is located.

detailsone ofRequired

Data Source specific properties required for the connection to the data source

or

or

or

or

or

or

or

or

or

Responses

201

Successful Response

application/json

uuidstring · uuidRequired

typestringRequired

readout_limitinteger · nullableRequired

readout_intervalintegerRequired

namestringRequired

The human readable name of the data source.

sparkstring · uuidRequired

Which SPARK reads from the data source. It must be located at the same site as the current SPARK.

manufacturerstring · nullableRequired

Manufacturer of the data source.

Example: Siemens

device_modelstring · nullableRequired

Specific model or name describing the data source as concretely as possible.

Example: S7-1214C

notestring · nullableRequired

General remarks concerning this data source.

machinestring · uuidRequired

On which machine the data source is located.

last_readout_atstring · date-time · nullableRequiredDeprecated

This field is deprecated, use the readout_status.last_readout_at

detailsone of · nullableRequired

Data Source specific properties required for the connection to the data source

or

or

or

or

or

or

or

or

or

422

Validation Error

application/json

post/v2/data-sources

POST /api/v2/data-sources HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "name": "text",
  "spark": "123e4567-e89b-12d3-a456-426614174000",
  "manufacturer": "Siemens",
  "device_model": "S7-1214C",
  "note": "text",
  "machine": "123e4567-e89b-12d3-a456-426614174000",
  "details": {
    "host": "text",
    "port": 44818,
    "type": "text"
  }
}

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "readout_limit": 1,
  "readout_interval": 1,
  "readout_status": {
    "last_readout_at": "2026-01-01T00:00:00.000Z",
    "configured_variables": 1,
    "state": {
      "type": "OK"
    }
  },
  "name": "text",
  "spark": "123e4567-e89b-12d3-a456-426614174000",
  "manufacturer": "Siemens",
  "device_model": "S7-1214C",
  "note": "text",
  "capabilities": {
    "variable_discovery": true
  },
  "machine": "123e4567-e89b-12d3-a456-426614174000",
  "details": {
    "host": "text",
    "port": 44818,
    "type": "text"
  }
}

Get Data Source

get

Returns details for a specific data source.

Authorizations

AuthorizationstringRequired

Path parameters

uuidstring · uuidRequired

Responses

200

Successful Response

application/json

uuidstring · uuidRequired

typestringRequired

readout_limitinteger · nullableRequired

readout_intervalintegerRequired

namestringRequired

The human readable name of the data source.

sparkstring · uuidRequired

Which SPARK reads from the data source. It must be located at the same site as the current SPARK.

manufacturerstring · nullableRequired

Manufacturer of the data source.

Example: Siemens

device_modelstring · nullableRequired

Specific model or name describing the data source as concretely as possible.

Example: S7-1214C

notestring · nullableRequired

General remarks concerning this data source.

machinestring · uuidRequired

On which machine the data source is located.

last_readout_atstring · date-time · nullableRequiredDeprecated

This field is deprecated, use the readout_status.last_readout_at

detailsone of · nullableRequired

Data Source specific properties required for the connection to the data source

or

or

or

or

or

or

or

or

or

422

Validation Error

application/json

get/v2/data-sources/{uuid}

GET /api/v2/data-sources/{uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "readout_limit": 1,
  "readout_interval": 1,
  "readout_status": {
    "last_readout_at": "2026-01-01T00:00:00.000Z",
    "configured_variables": 1,
    "state": {
      "type": "OK"
    }
  },
  "name": "text",
  "spark": "123e4567-e89b-12d3-a456-426614174000",
  "manufacturer": "Siemens",
  "device_model": "S7-1214C",
  "note": "text",
  "capabilities": {
    "variable_discovery": true
  },
  "machine": "123e4567-e89b-12d3-a456-426614174000",
  "details": {
    "host": "text",
    "port": 44818,
    "type": "text"
  }
}

Experimental

Get Data Source Credentials

get

Reveal what a data source authenticates with, in the shape its own type uses — a password for S7+, a user identity for OPC UA, the whole connection URL for SQL. Regular reads never include any of it, and a type that stores no credential answers unauthenticated. This is a step-up guarded read: the session's last active authentication must be no older than the server's maximum, otherwise the response is a 403 naming the max_age to re-authenticate with (OIDC max_age). Only an interactive user session can be stepped up — API keys and delegated OAuth clients are refused.

Authorizations

AuthorizationstringRequired

Path parameters

uuidstring · uuidRequired

Responses

200

Successful Response

application/json

or

or

or

or

or

or

or

or

403

Forbidden

application/json

404

Not Found

application/json

422

Validation Error

application/json

get/v2/data-sources/{uuid}/credentials

GET /api/v2/data-sources/{uuid}/credentials HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "username": "text",
  "password": "text",
  "type": "text"
}

Delete Data Source

delete

Delete a data source

Authorizations

AuthorizationstringRequired

Path parameters

data_source_uuidstring · uuidRequired

Responses

204

Successful Response

No content

422

Validation Error

application/json

delete/v2/data-sources/{data_source_uuid}

DELETE /api/v2/data-sources/{data_source_uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Update Data Source

patch

Update a data source

Authorizations

AuthorizationstringRequired

Path parameters

data_source_uuidstring · uuidRequired

Body

namestringOptional

The human readable name of the data source.

sparkstring · uuidOptional

Which SPARK reads from the data source. It must be located at the same site as the current SPARK.

manufacturerstring · nullableOptional

Manufacturer of the data source.

Example: Siemens

device_modelstring · nullableOptional

Specific model or name describing the data source as concretely as possible.

Example: S7-1214C

notestring · nullableOptional

General remarks concerning this data source.

detailsone ofOptional

Data Source specific properties required for the connection to the data source

or

or

or

or

or

or

or

or

or

Responses

201

Successful Response

application/json

anyOptional

422

Validation Error

application/json

patch/v2/data-sources/{data_source_uuid}

PATCH /api/v2/data-sources/{data_source_uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "name": "text",
  "spark": "123e4567-e89b-12d3-a456-426614174000",
  "manufacturer": "Siemens",
  "device_model": "S7-1214C",
  "note": "text",
  "details": {
    "type": "text",
    "host": "text",
    "port": 1
  }
}

No content