Update OTLP destination by ID or name

Update an OTLP destination. Sessions already exporting to it pick up the new values without restarting, which makes this the way to rotate credentials without interrupting export.

Names must be unique within the project. Renaming is refused with a 409 while a managed auth connection selects this destination by name, since that connection resolves the name on every login. Every other field, including headers, stays editable.

PATCH /telemetry/destinations/{id_or_name}

Update OTLP destination by ID or name

cURL

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

200

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

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

Body

application/json

Fields to update. Omitted fields are left unchanged.

description · string

Maximum string length: 1024

endpoint · string

Base endpoint of the OTLP/HTTP collector, without a signal path. Same rules as on create.

Required string length: 1 - 2048

headers · object

Edits stored headers key by key rather than replacing the map. A string value adds or replaces that header, null deletes it, and any key you omit is left as it is. Names are matched case-insensitively, so authorization replaces a stored Authorization rather than adding a second entry. This is the credential rotation path; sessions already exporting pick up the new values without restarting. Names and values must be valid HTTP header tokens, and the names and values together cannot exceed 8192 bytes.

Show child attributes

name · string

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

Response

200

application/json

OTLP destination updated

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.

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). Values are returned redacted as empty strings, so the keys are visible but the credentials are not.

Show child attributes

id · string · required

Maximum string length: 128

name · string · required

Unique within the project. 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