Trace sessions

Trace session

get

/v1/trace_sessions/{sessionID}

Authorizations

userproject

Path parameters

sessionIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/trace_sessions/{sessionID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "pipelineID": "123e4567-e89b-12d3-a456-426614174000",
  "plugins": [
    "dummy.0"
  ],
  "lifespan": "10m",
  "createdAt": "2025-03-12T04:25:03.214Z",
  "updatedAt": "2025-03-12T04:25:03.214Z"
}

OK

Update trace session

patch

/v1/trace_sessions/{sessionID}

Authorizations

userproject

Path parameters

sessionIDstring · uuidrequired

Body

pluginsstring[] | nullable

List of Fluent-bit plugin IDs ar aliases to trace.

Example: dummy.0

lifespanstring · duration | nullable

For how long will this session be active and process records.

Example: 10m

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://cloud-api.calyptia.com/v1/trace_sessions/{sessionID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "plugins": null,
    "lifespan": "10m"
  }'

200

200

{
  "updatedAt": "2025-03-12T04:25:03.214Z"
}

OK