Update OTLP destination by ID or name

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>"
}
'

import requests

url = "https://api.onkernel.com/telemetry/destinations/{id_or_name}"

payload = {
    "description": "<string>",
    "endpoint": "<string>",
    "headers": {},
    "name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({description: '<string>', endpoint: '<string>', headers: {}, name: '<string>'})
};

fetch('https://api.onkernel.com/telemetry/destinations/{id_or_name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onkernel.com/telemetry/destinations/{id_or_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'endpoint' => '<string>',
    'headers' => [
        
    ],
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onkernel.com/telemetry/destinations/{id_or_name}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"headers\": {},\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.onkernel.com/telemetry/destinations/{id_or_name}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"headers\": {},\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onkernel.com/telemetry/destinations/{id_or_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"headers\": {},\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

Browser Telemetry

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 organization. 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. Requires an organization-scoped credential or dashboard authentication; project-scoped credentials receive a 403.

PATCH

telemetry

destinations

{id_or_name}

Update OTLP destination by ID or name

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>"
}
'

import requests

url = "https://api.onkernel.com/telemetry/destinations/{id_or_name}"

payload = {
    "description": "<string>",
    "endpoint": "<string>",
    "headers": {},
    "name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({description: '<string>', endpoint: '<string>', headers: {}, name: '<string>'})
};

fetch('https://api.onkernel.com/telemetry/destinations/{id_or_name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onkernel.com/telemetry/destinations/{id_or_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'endpoint' => '<string>',
    'headers' => [
        
    ],
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onkernel.com/telemetry/destinations/{id_or_name}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"headers\": {},\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.onkernel.com/telemetry/destinations/{id_or_name}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"headers\": {},\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onkernel.com/telemetry/destinations/{id_or_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"headers\": {},\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

{
  "code": "bad_request",
  "message": "Missing required field: app_name",
  "details": [
    {
      "code": "invalid_input",
      "message": "Provided version string is not semver compliant"
    }
  ],
  "inner_error": {
    "code": "invalid_input",
    "message": "Provided version string is not semver compliant"
  }
}

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

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.

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

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.

Apps

Audit Logs

Managed Auth

Authentication

Browser Pools

Browsers

Browser Computer Controls

Browser Filesystem

Browser Logs

Browser Playwright

Browser Processes

Browser Replays

Browser Telemetry

Browser WebMCP

Deployments

Extensions

Invocations

API Keys

Organization

Projects

Profiles

Proxies

Vaults

Update OTLP destination by ID or name

Authorizations

Path Parameters

Body

Response