Create an OTLP destination

Create an OTLP export destination in the authenticated organization. Names must be unique within the organization. Requires an organization-scoped credential or dashboard authentication; project-scoped credentials receive a 403.

POST /telemetry/destinations

Create an OTLP destination

cURL

curl --request POST \
  --url https://api.onkernel.com/telemetry/destinations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endpoint": "<string>",
  "name": "<string>",
  "description": "<string>",
  "headers": {}
}
'

201

{
  "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.

Body

application/json

endpoint · string · required

Base endpoint of the OTLP/HTTP collector, without a signal path. Kernel appends the signal path itself, so pass https://api.honeycomb.io rather than https://api.honeycomb.io/v1/logs. If your provider's docs give you a signal-specific URL, drop the trailing /v1/logs, /v1/traces, or /v1/metrics — an endpoint that already carries one is rejected.

Must be http or https, must resolve to a public address, and must carry no query string or fragment. Examples: https://api.honeycomb.io, https://otlp-gateway-prod-us-east-0.grafana.net/otlp, https://otlp.datadoghq.com (Datadog's OTLP intake for US1, not its logs intake).

Required string length: 1 - 2048

name · string · required

Unique within the organization.

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

description · string

Maximum string length: 1024

headers · object

Headers sent with each export request, typically an ingestion key. Encrypted at rest and returned redacted. Names and values must be valid HTTP header tokens, and the names and values together cannot exceed 8192 bytes. Names are matched case-insensitively and stored canonicalized, so supplying two spellings of one header is rejected.

Show child attributes

Response

201

application/json

OTLP destination created

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.