Data Sinks

Get a data sink

get

Get a data sink based on it's id

Path parameters

workspaceIdstringRequired

dataSinkIdanyRequired

Data sink id

Example: 123e4567-e89b-12d3-a456-426614174000

Header parameters

x-api-keystringOptional

An x-api-key required for authentication

Responses

200

Data sink fetched successfully

application/json

get

HTTPcURLJavaScriptPython

GET /v1/workspace/{workspaceId}/data-sink/{dataSinkId} HTTP/1.1
Host: 
Accept: */*

200

Data sink fetched successfully

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "label": "Local python instance",
  "description": "This is a local python instance that runs on the local machine. Calculates the sum of two numbers.",
  "tags": "python, local, sum",
  "icon": "{ source: 'DevIcon', name: 'python' }",
  "visibleId": "SNK-1",
  "serial": 1,
  "entries": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "sum",
      "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
      "value": "3",
      "dataType": "scalar",
      "updatedAt": "2025-05-17T06:14:50.786Z",
      "updatedBy": "text",
      "createdAt": "2025-05-17T06:14:50.786Z",
      "createdBy": "text"
    }
  ],
  "updatedAt": "2025-05-17T06:14:50.786Z",
  "updatedBy": "text",
  "createdAt": "2025-05-17T06:14:50.786Z",
  "createdBy": "text"
}

Get all data sinks including their entries

get

Get all data sinks including their entries

Path parameters

workspaceIdstringRequired

Header parameters

x-api-keystringOptional

An x-api-key required for authentication

Responses

200

Data sinks fetched successfully

application/json

get

HTTPcURLJavaScriptPython

GET /v1/workspace/{workspaceId}/data-sink HTTP/1.1
Host: 
Accept: */*

200

Data sinks fetched successfully

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
    "label": "Local python instance",
    "description": "This is a local python instance that runs on the local machine. Calculates the sum of two numbers.",
    "tags": "python, local, sum",
    "icon": "{ source: 'DevIcon', name: 'python' }",
    "visibleId": "SNK-1",
    "serial": 1,
    "entries": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "key": "sum",
        "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
        "value": "3",
        "dataType": "scalar",
        "updatedAt": "2025-05-17T06:14:50.786Z",
        "updatedBy": "text",
        "createdAt": "2025-05-17T06:14:50.786Z",
        "createdBy": "text"
      }
    ],
    "updatedAt": "2025-05-17T06:14:50.786Z",
    "updatedBy": "text",
    "createdAt": "2025-05-17T06:14:50.786Z",
    "createdBy": "text"
  }
]

Get a data sink entry

get

Get a data sink entry based on it's key

Path parameters

workspaceIdstringRequired

keyanyRequired

Data sink entry key

Example: sum

dataSinkIdanyRequired

Data sink id

Example: 123e4567-e89b-12d3-a456-426614174000

Header parameters

x-api-keystringOptional

An x-api-key required for authentication

Responses

200

Data sink entry fetched successfully

application/json

get

HTTPcURLJavaScriptPython

GET /v1/workspace/{workspaceId}/data-sink/{dataSinkId}/{key} HTTP/1.1
Host: 
Accept: */*

200

Data sink entry fetched successfully

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "sum",
  "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
  "value": "3",
  "dataType": "scalar",
  "updatedAt": "2025-05-17T06:14:50.786Z",
  "updatedBy": "text",
  "createdAt": "2025-05-17T06:14:50.786Z",
  "createdBy": "text"
}

Update a data sink

patch

Update a data sink based on it's id

Path parameters

workspaceIdstringRequired

dataSinkIdanyRequired

Data sink id

Example: 123e4567-e89b-12d3-a456-426614174000

Header parameters

x-api-keystringOptional

An x-api-key required for authentication

ClientIdstringRequired

Body

labelstringOptional

Unique identifier of the data sink (UUIDv4). Specify only when its necessary to know the id before creation.

Example: 123e4567-e89b-12d3-a456-426614174000

descriptionstringOptional

Description of the data sink

Example: This is a local python instance that runs on the local machine. Calculates the sum of two numbers.

tagsstringOptional

Tags associated with the data sink

Example: python, local, sum

iconall ofOptional

Icon of the data sink

Responses

200Success

patch

HTTPcURLJavaScriptPython

PATCH /v1/workspace/{workspaceId}/data-sink/{dataSinkId} HTTP/1.1
Host: 
ClientId: text
Content-Type: application/json
Accept: */*
Content-Length: 267

{
  "label": "123e4567-e89b-12d3-a456-426614174000",
  "description": "This is a local python instance that runs on the local machine. Calculates the sum of two numbers.",
  "tags": "python, local, sum",
  "icon": {
    "source": "DevIcon",
    "name": "python",
    "color": "#3776AB",
    "metadata": {}
  }
}

200Success

No content

Delete a data sink

delete

Delete a data sink based on it's id

Path parameters

workspaceIdstringRequired

dataSinkIdanyRequired

Data sink id

Example: 123e4567-e89b-12d3-a456-426614174000

Header parameters

x-api-keystringOptional

An x-api-key required for authentication

ClientIdstringRequired

Responses

200

Data sink deleted successfully

delete

HTTPcURLJavaScriptPython

DELETE /v1/workspace/{workspaceId}/data-sink/{dataSinkId} HTTP/1.1
Host: 
ClientId: text
Accept: */*

200

Data sink deleted successfully

No content

Update a data sink entry

patch

Update a data sink entry based on it's key

Path parameters

workspaceIdstringRequired

keyanyRequired

Data sink entry key

Example: sum

dataSinkIdanyRequired

Data sink id

Example: 123e4567-e89b-12d3-a456-426614174000

Header parameters

x-api-keystringOptional

An x-api-key required for authentication

ClientIdstringRequired

Body

valuestringOptional

Value of the data sink entry

Example: 3

dataTypestringOptional

Data type of the data sink entry

Example: scalar

Responses

200

Data sink entry updated successfully

application/json

patch

HTTPcURLJavaScriptPython

PATCH /v1/workspace/{workspaceId}/data-sink/{dataSinkId}/{key} HTTP/1.1
Host: 
ClientId: text
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "value": "3",
  "dataType": "scalar"
}

200

Data sink entry updated successfully

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "sum",
  "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
  "value": "3",
  "dataType": "scalar",
  "updatedAt": "2025-05-17T06:14:50.786Z",
  "updatedBy": "text",
  "createdAt": "2025-05-17T06:14:50.786Z",
  "createdBy": "text"
}

Delete a data sink entry

delete

Delete a data sink entry based on it's key

Path parameters

workspaceIdstringRequired

keyanyRequired

Data sink entry key

Example: sum

dataSinkIdanyRequired

Data sink id

Example: 123e4567-e89b-12d3-a456-426614174000

Header parameters

x-api-keystringOptional

An x-api-key required for authentication

ClientIdstringRequired

Responses

200

Data sink entry deleted successfully

delete

HTTPcURLJavaScriptPython

DELETE /v1/workspace/{workspaceId}/data-sink/{dataSinkId}/{key} HTTP/1.1
Host: 
ClientId: text
Accept: */*

200

Data sink entry deleted successfully

No content

Get all data sinks excluding their entries

get

Get all data sinks. Entries are excluded in the response.

Path parameters

workspaceIdstringRequired

Header parameters

x-api-keystringOptional

An x-api-key required for authentication

Responses

200

Data sinks fetched successfully

application/json

get

HTTPcURLJavaScriptPython

GET /v1/workspace/{workspaceId}/data-sink/list HTTP/1.1
Host: 
Accept: */*

200

Data sinks fetched successfully

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
    "label": "Local python instance",
    "description": "This is a local python instance that runs on the local machine. Calculates the sum of two numbers.",
    "tags": "python, local, sum",
    "icon": "{ source: 'DevIcon', name: 'python' }",
    "visibleId": "SNK-1",
    "serial": 1,
    "updatedAt": "2025-05-17T06:14:50.786Z",
    "updatedBy": "text",
    "createdAt": "2025-05-17T06:14:50.786Z",
    "createdBy": "text"
  }
]

Create a new data sink

post

Create a new data sink. Entries are optional

Path parameters

workspaceIdstringRequired

Header parameters

x-api-keystringOptional

An x-api-key required for authentication

ClientIdstringRequired

Body

idstringOptional

Unique identifier of the data sink (UUIDv4). Specify only when its necessary to know the id before creation.

Example: 123e4567-e89b-12d3-a456-426614174000

labelstringRequired

Label of the data sink

Example: Local python instance

descriptionstringOptional

Description of the data sink

Example: This is a local python instance that runs on the local machine. Calculates the sum of two numbers.

tagsstringOptional

Tags associated with the data sink

Example: python, local, sum

iconall ofOptional

Icon of the data sink

Responses

201

Data sink created successfully

application/json

post

HTTPcURLJavaScriptPython

POST /v1/workspace/{workspaceId}/data-sink HTTP/1.1
Host: 
ClientId: text
Content-Type: application/json
Accept: */*
Content-Length: 398

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "label": "Local python instance",
  "description": "This is a local python instance that runs on the local machine. Calculates the sum of two numbers.",
  "tags": "python, local, sum",
  "icon": {
    "source": "DevIcon",
    "name": "python",
    "color": "#3776AB",
    "metadata": {}
  },
  "entries": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "sum",
      "value": "3",
      "dataType": "scalar"
    }
  ]
}

201

Data sink created successfully

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "label": "Local python instance",
  "description": "This is a local python instance that runs on the local machine. Calculates the sum of two numbers.",
  "tags": "python, local, sum",
  "icon": "{ source: 'DevIcon', name: 'python' }",
  "visibleId": "SNK-1",
  "serial": 1,
  "entries": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "sum",
      "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
      "value": "3",
      "dataType": "scalar",
      "updatedAt": "2025-05-17T06:14:50.786Z",
      "updatedBy": "text",
      "createdAt": "2025-05-17T06:14:50.786Z",
      "createdBy": "text"
    }
  ],
  "updatedAt": "2025-05-17T06:14:50.786Z",
  "updatedBy": "text",
  "createdAt": "2025-05-17T06:14:50.786Z",
  "createdBy": "text"
}

Create a new data sink entry

post

Create a new data sink entry based on it's key

Path parameters

workspaceIdstringRequired

dataSinkIdanyRequired

Data sink id

Example: 123e4567-e89b-12d3-a456-426614174000

Header parameters

x-api-keystringOptional

An x-api-key required for authentication

ClientIdstringRequired

Body

idstringOptional

Unique identifier of the data sink entry (UUIDv4). Specify only when its necessary to know the id before creation.

Example: 123e4567-e89b-12d3-a456-426614174000

keystringRequired

Key of the data sink entry

Example: sum

valuestringOptional

Value of the data sink entry

Example: 3

dataTypestringRequired

Data type of the data sink entry

Example: scalar

Responses

201

Data sink entry created successfully

application/json

post

HTTPcURLJavaScriptPython

POST /v1/workspace/{workspaceId}/data-sink/{dataSinkId} HTTP/1.1
Host: 
ClientId: text
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "sum",
  "value": "3",
  "dataType": "scalar"
}

201

Data sink entry created successfully

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "sum",
  "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
  "value": "3",
  "dataType": "scalar",
  "updatedAt": "2025-05-17T06:14:50.786Z",
  "updatedBy": "text",
  "createdAt": "2025-05-17T06:14:50.786Z",
  "createdBy": "text"
}