Trace sessions

Trace session

get

Authorizations

userproject

Path parameters

sessionIDstring · uuidRequired

Responses

application/json

objectOptional

Trace session model. There can only be one active session at a moment on a pipeline. Either terminate it and create a new one, or update and extend the lifespan of the current active one.

get

HTTPcURLJavaScriptPython

GET /v1/trace_sessions/{sessionID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "pipelineID": "123e4567-e89b-12d3-a456-426614174000",
  "plugins": [
    "dummy.0"
  ],
  "lifespan": "10m",
  "createdAt": "2025-04-24T07:33:44.104Z",
  "updatedAt": "2025-04-24T07:33:44.104Z"
}

Update trace session

patch

Authorizations

userproject

Path parameters

sessionIDstring · uuidRequired

Body

Request body to update an active trace session on a pipeline.

pluginsstring[] | nullableOptional

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

Default: nullExample: dummy.0

lifespanstring · duration | nullableOptional

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

Default: nullExample: 10m

Responses

application/json

objectOptional

Response body for an updated trace session.

patch

HTTPcURLJavaScriptPython

PATCH /v1/trace_sessions/{sessionID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "plugins": [
    "dummy.0"
  ],
  "lifespan": "10m"
}

200

OK

{
  "updatedAt": "2025-04-24T07:33:44.104Z"
}