Get OTLP destination by ID or name

Retrieve a customer-visible OTLP destination in the authenticated organization by its ID or name. Project-scoped credentials can retrieve these destinations for selection by workloads in their project. Non-dashboard reads return header values redacted.

GET /telemetry/destinations/{id_or_name}

Get OTLP destination by ID or name

cURL

curl --request GET \
  --url https://api.onkernel.com/telemetry/destinations/{id_or_name} \
  --header 'Authorization: Bearer <token>'

200

{
  "consecutive_failures": 1,
  "created_at": "2023-11-07T05:31:56Z",
  "endpoint": "<string>",
  "headers": {},
  "id": "<string>",
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "last_error": "<string>",
  "last_error_at": "2023-11-07T05:31:56Z",
  "last_export_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id_or_name · string · required

OTLP destination ID or name

Response

200

application/json

OTLP destination details

An OTLP endpoint to export browser session telemetry to. Reference one from telemetry.export.otlp.destination when creating a browser to export that session's captured telemetry to it.

consecutive_failures · integer<int32> · required

Failed deliveries since the last success, as observed by the relay process that wrote the latest outcome. Zero means the most recently recorded outcome succeeded.

Required range: x >= 0

created_at · string<date-time> · required

endpoint · string · required

OTLP/HTTP endpoint telemetry is sent to.

Maximum string length: 2048

headers · object · required

Headers sent with each export request. Names are returned in canonical form (Authorization, not authorization). Non-dashboard reads return values redacted as empty strings, so the keys are visible but the credentials are not. Dashboard reads return the stored values.

Show child attributes

id · string · required

Maximum string length: 128

name · string · required

Unique within the organization. Usable in place of the ID when selecting a destination, so it cannot be shaped like an ID.

Pattern: ^[a-zA-Z0-9._-]{1,255}$

updated_at · string<date-time> · required

description · string

Maximum string length: 1024

last_error · string

Sanitized class of the delivery failure recorded at last_error_at. It is retained after a later success, so its presence does not mean the destination is currently failing. Response bodies, endpoint URLs, credentials, and raw transport errors are never returned.

Maximum string length: 512

last_error_at · string<date-time>

Timestamp of the most recent failed delivery. It is retained after a later success, so it can predate last_export_at. Read consecutive_failures to tell whether the destination is currently failing.

last_export_at · string<date-time>

Timestamp of the most recent successful delivery. Moves only on success.