Data Sinks

⚠️ Experimental — this resource is under active development and may change without notice.

Experimental

Get Data Sinks

get

Returns the data sinks in your organization. A data sink is a target a SPARK publishes its captured values to: an OPC UA server it hosts, an MQTT broker, or the ENLYZE platform.

Authorizations

AuthorizationstringRequired

Query parameters

cursorstringOptional

uuidstring · uuid[] · max: 50 · nullableOptional

sparkstring · uuid[] · max: 50 · nullableOptional

Responses

200

Successful Response

application/json

422

Unprocessable Content

application/json

get/v2/data-sinks

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

{
  "data": [
    {
      "name": "opcua-server",
      "spark": "123e4567-e89b-12d3-a456-426614174000",
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "type": "mqtt",
      "details": {
        "type": "text",
        "host": "text",
        "port": 1,
        "client_id": "text",
        "topic": "text",
        "publish_interval": 10000
      }
    }
  ],
  "metadata": {
    "next_cursor": "text"
  }
}

Experimental

Post Data Sink

post

Create a new data sink on a SPARK.

Authorizations

AuthorizationstringRequired

Body

namestring · min: 1 · max: 200 · nullableOptional

Human readable name of the data sink, unique per SPARK.

Example: opcua-server

sparkstring · uuidRequired

The SPARK that publishes to this data sink.

detailsone ofRequired

Sink type specific connection and publishing properties.

or

or

Responses

201

Successful Response

application/json

namestringRequired

Human readable name of the data sink, unique per SPARK.

Example: opcua-server

sparkstring · uuidRequired

The SPARK that publishes to this data sink.

uuidstring · uuidRequired

Unique identifier of the data sink.

typestring · enumRequired

Kind of data sink; matches details.type.

Possible values:

detailsone ofRequired

Sink type specific connection and publishing properties.

or

or

404

Not Found

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

post/v2/data-sinks

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

{
  "name": "opcua-server",
  "spark": "123e4567-e89b-12d3-a456-426614174000",
  "details": {
    "type": "text",
    "host": "text",
    "port": 1883,
    "client_id": "",
    "topic": "text",
    "publish_interval": 10000
  }
}

{
  "name": "opcua-server",
  "spark": "123e4567-e89b-12d3-a456-426614174000",
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "type": "mqtt",
  "details": {
    "type": "text",
    "host": "text",
    "port": 1,
    "client_id": "text",
    "topic": "text",
    "publish_interval": 10000
  }
}

Experimental

Get Data Sink

get

Returns details for a specific data sink.

Authorizations

AuthorizationstringRequired

Path parameters

uuidstring · uuidRequired

Responses

200

Successful Response

application/json

namestringRequired

Human readable name of the data sink, unique per SPARK.

Example: opcua-server

sparkstring · uuidRequired

The SPARK that publishes to this data sink.

uuidstring · uuidRequired

Unique identifier of the data sink.

typestring · enumRequired

Kind of data sink; matches details.type.

Possible values:

detailsone ofRequired

Sink type specific connection and publishing properties.

or

or

404

Not Found

application/json

422

Validation Error

application/json

get/v2/data-sinks/{uuid}

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

{
  "name": "opcua-server",
  "spark": "123e4567-e89b-12d3-a456-426614174000",
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "type": "mqtt",
  "details": {
    "type": "text",
    "host": "text",
    "port": 1,
    "client_id": "text",
    "topic": "text",
    "publish_interval": 10000
  }
}

Experimental

Delete Data Sink

delete

Delete a data sink. The SPARK stops publishing to it.

Authorizations

AuthorizationstringRequired

Path parameters

uuidstring · uuidRequired

Responses

204

Successful Response

No content

404

Not Found

application/json

422

Validation Error

application/json

delete/v2/data-sinks/{uuid}

DELETE /api/v2/data-sinks/{uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Experimental

Update Data Sink

patch

Partially update a data sink. Only fields present in the request change. Neither the sink's type nor its spark can be changed; details.users of an OPC UA sink replaces the full list of users.

Authorizations

AuthorizationstringRequired

Path parameters

uuidstring · uuidRequired

Body

namestring · min: 1 · max: 200Optional

Human readable name of the data sink, unique per SPARK.

Example: opcua-server

detailsone ofOptional

Sink type specific connection and publishing properties.

or

or

Responses

204

Successful Response

No content

404

Not Found

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

patch/v2/data-sinks/{uuid}

PATCH /api/v2/data-sinks/{uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "name": "opcua-server",
  "details": {
    "type": "text",
    "host": "text",
    "port": 1,
    "client_id": "text",
    "topic": "text",
    "publish_interval": 1
  }
}

No content