Data Sinks | Rollup API Reference

Get a data sink

Get a data sink based on it's id

get

/v1/workspace/{workspaceId}/data-sink/{dataSinkId}

Path parameters

workspaceIdstringrequired

dataSinkIdanyrequired

Data sink id

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

Header parameters

x-api-keystring

An x-api-key required for authentication

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/workspace/{workspaceId}/data-sink/{dataSinkId}'

200

{
  "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",
  "visibleId": "SNK-1",
  "serial": 1,
  "updatedAt": "2025-02-28T07:51:55.130Z",
  "updatedBy": "text",
  "createdAt": "2025-02-28T07:51:55.130Z",
  "createdBy": "text",
  "entries": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "sum",
      "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
      "value": "3",
      "dataType": "scalar",
      "updatedAt": "2025-02-28T07:51:55.130Z",
      "updatedBy": "text",
      "createdAt": "2025-02-28T07:51:55.130Z",
      "createdBy": "text"
    }
  ],
  "icon": "{ source: 'DevIcon', name: 'python' }"
}

Data sink fetched successfully

Get all data sinks including their entries

get

/v1/workspace/{workspaceId}/data-sink

Path parameters

workspaceIdstringrequired

Header parameters

x-api-keystring

An x-api-key required for authentication

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/workspace/{workspaceId}/data-sink'

200

[
  {
    "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",
    "visibleId": "SNK-1",
    "serial": 1,
    "updatedAt": "2025-02-28T07:51:55.130Z",
    "updatedBy": "text",
    "createdAt": "2025-02-28T07:51:55.130Z",
    "createdBy": "text",
    "entries": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "key": "sum",
        "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
        "value": "3",
        "dataType": "scalar",
        "updatedAt": "2025-02-28T07:51:55.130Z",
        "updatedBy": "text",
        "createdAt": "2025-02-28T07:51:55.130Z",
        "createdBy": "text"
      }
    ],
    "icon": "{ source: 'DevIcon', name: 'python' }"
  }
]

Data sinks fetched successfully

Get a data sink entry

Get a data sink entry based on it's key

get

/v1/workspace/{workspaceId}/data-sink/{dataSinkId}//{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-keystring

An x-api-key required for authentication

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/workspace/{workspaceId}/data-sink/{dataSinkId}/{key}'

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "sum",
  "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
  "value": "3",
  "dataType": "scalar",
  "updatedAt": "2025-02-28T07:51:55.130Z",
  "updatedBy": "text",
  "createdAt": "2025-02-28T07:51:55.130Z",
  "createdBy": "text"
}

Data sink entry fetched successfully

Update a data sink

Update a data sink based on it's id

patch

/v1/workspace/{workspaceId}/data-sink/{dataSinkId}

Path parameters

workspaceIdstringrequired

dataSinkIdanyrequired

Data sink id

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

Header parameters

x-api-keystring

An x-api-key required for authentication

ClientIdstringrequired

Body

labelstring

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

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

descriptionstring

Description of the data sink

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

tagsstring

Tags associated with the data sink

Example: python, local, sum

iconall of

Icon of the data sink

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/v1/workspace/{workspaceId}/data-sink/{dataSinkId}' \
  --header 'ClientId: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "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": {}
    }
  }'

200

No body

Delete a data sink

Delete a data sink based on it's id

delete

/v1/workspace/{workspaceId}/data-sink/{dataSinkId}

Path parameters

workspaceIdstringrequired

dataSinkIdanyrequired

Data sink id

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

Header parameters

x-api-keystring

An x-api-key required for authentication

ClientIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v1/workspace/{workspaceId}/data-sink/{dataSinkId}' \
  --header 'ClientId: text'

200

No body

Data sink deleted successfully

Update a data sink entry

Update a data sink entry based on it's key

patch

/v1/workspace/{workspaceId}/data-sink/{dataSinkId}//{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-keystring

An x-api-key required for authentication

ClientIdstringrequired

Body

valuestring

Value of the data sink entry

Example: 3

dataTypestring

Data type of the data sink entry

Example: scalar

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/v1/workspace/{workspaceId}/data-sink/{dataSinkId}/{key}' \
  --header 'ClientId: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "value": "3",
    "dataType": "scalar"
  }'

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "sum",
  "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
  "value": "3",
  "dataType": "scalar",
  "updatedAt": "2025-02-28T07:51:55.130Z",
  "updatedBy": "text",
  "createdAt": "2025-02-28T07:51:55.130Z",
  "createdBy": "text"
}

Data sink entry updated successfully

Delete a data sink entry

Delete a data sink entry based on it's key

delete

/v1/workspace/{workspaceId}/data-sink/{dataSinkId}//{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-keystring

An x-api-key required for authentication

ClientIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v1/workspace/{workspaceId}/data-sink/{dataSinkId}/{key}' \
  --header 'ClientId: text'

200

No body

Data sink entry deleted successfully

Get all data sinks excluding their entries

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

get

/v1/workspace/{workspaceId}/data-sink/list

Path parameters

workspaceIdstringrequired

Header parameters

x-api-keystring

An x-api-key required for authentication

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/workspace/{workspaceId}/data-sink/list'

200

[
  {
    "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",
    "visibleId": "SNK-1",
    "serial": 1,
    "updatedAt": "2025-02-28T07:51:55.130Z",
    "updatedBy": "text",
    "createdAt": "2025-02-28T07:51:55.130Z",
    "createdBy": "text",
    "icon": "{ source: 'DevIcon', name: 'python' }"
  }
]

Data sinks fetched successfully

Create a new data sink

Create a new data sink. Entries are optional

post

/v1/workspace/{workspaceId}/data-sink

Path parameters

workspaceIdstringrequired

Header parameters

x-api-keystring

An x-api-key required for authentication

ClientIdstringrequired

Body

idstring

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

descriptionstring

Description of the data sink

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

tagsstring

Tags associated with the data sink

Example: python, local, sum

entriesobject[]

iconall of

Icon of the data sink

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1/workspace/{workspaceId}/data-sink' \
  --header 'ClientId: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "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",
    "entries": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "key": "sum",
        "value": "3",
        "dataType": "scalar"
      }
    ],
    "icon": {
      "source": "DevIcon",
      "name": "python",
      "color": "#3776AB",
      "metadata": {}
    }
  }'

201

{
  "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",
  "visibleId": "SNK-1",
  "serial": 1,
  "updatedAt": "2025-02-28T07:51:55.130Z",
  "updatedBy": "text",
  "createdAt": "2025-02-28T07:51:55.130Z",
  "createdBy": "text",
  "entries": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "sum",
      "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
      "value": "3",
      "dataType": "scalar",
      "updatedAt": "2025-02-28T07:51:55.130Z",
      "updatedBy": "text",
      "createdAt": "2025-02-28T07:51:55.130Z",
      "createdBy": "text"
    }
  ],
  "icon": "{ source: 'DevIcon', name: 'python' }"
}

Data sink created successfully

Create a new data sink entry

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

post

/v1/workspace/{workspaceId}/data-sink/{dataSinkId}

Path parameters

workspaceIdstringrequired

dataSinkIdanyrequired

Data sink id

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

Header parameters

x-api-keystring

An x-api-key required for authentication

ClientIdstringrequired

Body

idstring

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

valuestring

Value of the data sink entry

Example: 3

dataTypestringrequired

Data type of the data sink entry

Example: scalar

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1/workspace/{workspaceId}/data-sink/{dataSinkId}' \
  --header 'ClientId: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "key": "sum",
    "value": "3",
    "dataType": "scalar"
  }'

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "sum",
  "dataSinkId": "123e4567-e89b-12d3-a456-426614174000",
  "value": "3",
  "dataType": "scalar",
  "updatedAt": "2025-02-28T07:51:55.130Z",
  "updatedBy": "text",
  "createdAt": "2025-02-28T07:51:55.130Z",
  "createdBy": "text"
}

Data sink entry created successfully