Data Sinks
Get a data sink based on it's id
Data sink id
123e4567-e89b-12d3-a456-426614174000
An x-api-key
required for authentication
GET /v1/workspace/{workspaceId}/data-sink/{dataSinkId} HTTP/1.1
Host:
Accept: */*
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-06-27T03:19:45.875Z",
"updatedBy": "text",
"createdAt": "2025-06-27T03:19:45.875Z",
"createdBy": "text"
}
],
"updatedAt": "2025-06-27T03:19:45.875Z",
"updatedBy": "text",
"createdAt": "2025-06-27T03:19:45.875Z",
"createdBy": "text"
}
Get all data sinks including their entries
An x-api-key
required for authentication
GET /v1/workspace/{workspaceId}/data-sink HTTP/1.1
Host:
Accept: */*
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-06-27T03:19:45.875Z",
"updatedBy": "text",
"createdAt": "2025-06-27T03:19:45.875Z",
"createdBy": "text"
}
],
"updatedAt": "2025-06-27T03:19:45.875Z",
"updatedBy": "text",
"createdAt": "2025-06-27T03:19:45.875Z",
"createdBy": "text"
}
]
Get a data sink entry based on it's key
Data sink entry key
sum
Data sink id
123e4567-e89b-12d3-a456-426614174000
An x-api-key
required for authentication
GET /v1/workspace/{workspaceId}/data-sink/{dataSinkId}/{key} HTTP/1.1
Host:
Accept: */*
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-06-27T03:19:45.875Z",
"updatedBy": "text",
"createdAt": "2025-06-27T03:19:45.875Z",
"createdBy": "text"
}
Update a data sink based on it's id
Data sink id
123e4567-e89b-12d3-a456-426614174000
An x-api-key
required for authentication
Unique identifier of the data sink (UUIDv4). Specify only when its necessary to know the id before creation.
123e4567-e89b-12d3-a456-426614174000
Description of the data sink
This is a local python instance that runs on the local machine. Calculates the sum of two numbers.
Tags associated with the data sink
python, local, sum
Icon of the data sink
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": {}
}
}
No content
Delete a data sink based on it's id
Data sink id
123e4567-e89b-12d3-a456-426614174000
An x-api-key
required for authentication
DELETE /v1/workspace/{workspaceId}/data-sink/{dataSinkId} HTTP/1.1
Host:
ClientId: text
Accept: */*
Data sink deleted successfully
No content
Update a data sink entry based on it's key
Data sink entry key
sum
Data sink id
123e4567-e89b-12d3-a456-426614174000
An x-api-key
required for authentication
Value of the data sink entry
3
Data type of the data sink entry
scalar
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"
}
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-06-27T03:19:45.875Z",
"updatedBy": "text",
"createdAt": "2025-06-27T03:19:45.875Z",
"createdBy": "text"
}
Delete a data sink entry based on it's key
Data sink entry key
sum
Data sink id
123e4567-e89b-12d3-a456-426614174000
An x-api-key
required for authentication
DELETE /v1/workspace/{workspaceId}/data-sink/{dataSinkId}/{key} HTTP/1.1
Host:
ClientId: text
Accept: */*
Data sink entry deleted successfully
No content
Get all data sinks. Entries are excluded in the response.
An x-api-key
required for authentication
GET /v1/workspace/{workspaceId}/data-sink/list HTTP/1.1
Host:
Accept: */*
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-06-27T03:19:45.875Z",
"updatedBy": "text",
"createdAt": "2025-06-27T03:19:45.875Z",
"createdBy": "text"
}
]
Create a new data sink. Entries are optional
An x-api-key
required for authentication
Unique identifier of the data sink (UUIDv4). Specify only when its necessary to know the id before creation.
123e4567-e89b-12d3-a456-426614174000
Label of the data sink
Local python instance
Description of the data sink
This is a local python instance that runs on the local machine. Calculates the sum of two numbers.
Tags associated with the data sink
python, local, sum
Icon of the data sink
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"
}
]
}
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-06-27T03:19:45.875Z",
"updatedBy": "text",
"createdAt": "2025-06-27T03:19:45.875Z",
"createdBy": "text"
}
],
"updatedAt": "2025-06-27T03:19:45.875Z",
"updatedBy": "text",
"createdAt": "2025-06-27T03:19:45.875Z",
"createdBy": "text"
}
Create a new data sink entry based on it's key
Data sink id
123e4567-e89b-12d3-a456-426614174000
An x-api-key
required for authentication
Unique identifier of the data sink entry (UUIDv4). Specify only when its necessary to know the id before creation.
123e4567-e89b-12d3-a456-426614174000
Key of the data sink entry
sum
Value of the data sink entry
3
Data type of the data sink entry
scalar
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"
}
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-06-27T03:19:45.875Z",
"updatedBy": "text",
"createdAt": "2025-06-27T03:19:45.875Z",
"createdBy": "text"
}
Last updated
Was this helpful?