Trace session

Active trace session

GEThttps://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/trace_session

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Response

200

OK

Body

application/json

id*string (uuid)

pipelineID*string (uuid)

plugins*array of string

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

lifespan*string (duration)

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

Example: "10m"

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurl

const response = await fetch('https://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/trace_session', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "pipelineID": "123e4567-e89b-12d3-a456-426614174000",
  "plugins": [
    "dummy.0"
  ],
  "lifespan": "10m",
  "createdAt": "2024-07-27T07:42:47.576Z",
  "updatedAt": "2024-07-27T07:42:47.576Z"
}

Terminate active trace session

DELETEhttps://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/trace_session

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Response

200

OK

Body

application/json

id*string (uuid)

lifespan*string (duration)

Example: "10m"

updatedAt*string (date-time)

Request

JavaScriptCurl

const response = await fetch('https://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/trace_session', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lifespan": "10m",
  "updatedAt": "2024-07-27T07:42:47.576Z"
}