Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Calyptia trace_session API

The trace_session API from Calyptia — 3 operation(s) for trace_session.

Calyptia trace_session API is one of 41 APIs that Calyptia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include trace_session. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.4, at version 1.0.

Requests are made against 4 base URLs: https://cloud-api.calyptia.com, https://cloud-api-dev.calyptia.com, https://cloud-api-staging.calyptia.com, http://localhost:{port}.

6 operations 3 paths 6 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
1.0
Base URL
https://cloud-api.calyptia.com
Authentication
HTTP Bearer, API Key, OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 3

Calyptia trace_session API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (user). An API key is passed in the header as X-Project-Token (project). It supports OAuth 2.0 (auth0) using the clientCredentials and authorizationCode flows.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

trace_session 6
POST
/v1/pipelines/{pipelineID}/trace_sessions
Create trace session
createTraceSession 1 param body → 201
GET
/v1/pipelines/{pipelineID}/trace_sessions
Trace sessions
traceSessions 1 param → 200
GET
/v1/pipelines/{pipelineID}/trace_session
Active trace session
activeTraceSession 1 param → 200
DELETE
/v1/pipelines/{pipelineID}/trace_session
Terminate active trace session
terminateActiveTraceSession 1 param → 200
GET
/v1/trace_sessions/{sessionID}
Trace session
traceSession 1 param → 200
PATCH
/v1/trace_sessions/{sessionID}
Update trace session
updateTraceSession 1 param body → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are TraceSession (6 properties), TerminatedTraceSession (3 properties), UpdateTraceSession (2 properties), CreateTraceSession (2 properties). Each schema is shown below with its type and property counts.

UpdatedTraceSession
object
Response body for an updated trace session.
1 property 1 required
TerminatedTraceSession
object
Response body when a trace session is terminated.
3 properties 3 required
CreatedTraceSession
object
Response body for a newly created trace session.
2 properties 2 required
CreateTraceSession
object
Request body to create a new trace session on a pipeline.
2 properties 2 required
UpdateTraceSession
object
Request body to update an active trace session on a pipeline.
2 properties
TraceSession
object
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 lifespa…
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calyptia-trace-session-api-openapi.yml Raw ↑

Other APIs Calyptia publishes across the network.

Calyptia agent API
Calyptia agent_config API
Calyptia agent_error API
Calyptia aggregator API
Calyptia audit_log API
Calyptia aws_marketplace API
Calyptia cluster_object API
Calyptia cluster_object_regex API
Calyptia config_section API
Calyptia config_validator API
Calyptia config_validator_v2 API
Calyptia core_instance API