For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Update the fields you send. Send credential_secret to rotate the
secret. kind and otlp_preset can’t change.
Authentication
AuthorizationBearer
A management key (mgmt_...), sent as Authorization: Bearer <key>. Reading /v1/routing-policies also accepts the organization’s gateway API keys; writing there needs a management key.
Path parameters
destination_idstringRequiredformat: "uuid"
The destination’s id.
Request
This endpoint expects an object.
credential_secretstringOptionalformat: "password"
Replaces the stored secret. The API key or token the destination authenticates with. Never returned; responses show credential_hint instead. Omit to keep the current value. null is rejected.
credential_usernamestring or nullOptional<=255 characters
grafana only: the Grafana Cloud instance ID. Not a secret, so it is returned. null clears it, where the preset doesn’t need it.
enabledbooleanOptional
Whether the gateway exports to the destination. Omit to keep the current value. null is rejected.
metrics_enabledbooleanOptional
Also export metrics. Datadog and Grafana Cloud bill these separately. Omit to keep the current value. null is rejected.
ml_appstring or nullOptional<=193 characters
Datadog only: the ml_app tag on exported spans. null clears it.
namestringOptional1-255 characters
A name for the destination, unique in the organization. Omit to keep the current value. null is rejected.
otlp_endpointstringOptional<=255 characters
generic only: the https URL of your OTLP collector. Omit to keep the current value. null is rejected.
privacy_modebooleanOptional
When true, prompts and completions are left out of exported spans. Omit to keep the current value. null is rejected.
sample_ratedoubleOptional0.0001-1
Fraction of requests exported, from 0.0001 to 1. Omit to keep the current value. null is rejected.
sitestringOptional
datadog: a Datadog site, like datadoghq.com. grafana: a Grafana Cloud zone, like prod-us-east-0. generic: not allowed; use otlp_endpoint. Omit to keep the current value. null is rejected.
Response
The updated export destination
consecutive_failuresintegerRead-only
Failed deliveries in a row.
created_atdatetimeRead-only
When the destination was created.
credential_hintstring or nullRead-only
The last 4 characters of the stored secret, to tell secrets apart. null when the secret is under 12 characters (4 would give away too much of it).
credential_usernamestring or null
grafana only: the Grafana Cloud instance ID. Not a secret, so it is returned.
delivery_suspended_untildatetime or nullRead-only
Set while delivery is paused after repeated failures.
enabledboolean
Whether the gateway exports to the destination.
idstringRead-onlyformat: "uuid"
The destination's id.
kind"otlp"
Can't be changed after creation.
last_error_atdatetime or nullRead-only
When a delivery last failed.
last_error_messagestring or nullRead-only
Why the last failed delivery failed.
last_success_atdatetime or nullRead-only
When a delivery last succeeded.
metrics_enabledboolean
Also export metrics. Datadog and Grafana Cloud bill these separately.
ml_appstring or null
Datadog only: the ml_app tag on exported spans.
namestring
A name for the destination, unique in the organization.
organization_idstringRead-onlyformat: "uuid"
The organization the destination belongs to.
otlp_endpointstring or null
generic only: the https URL of your OTLP collector.
otlp_presetenum
Where spans go. Besides the presets create accepts, datadog-apm: those destinations are created in the dashboard only. Can’t be changed after creation.
Allowed values:
privacy_modeboolean
When true, prompts and completions are left out of exported spans.
sample_ratedouble
Fraction of requests exported, from 0.0001 to 1.
sitestring or null
datadog: a Datadog site, like datadoghq.com. grafana: a Grafana Cloud zone, like prod-us-east-0. generic: not allowed; use otlp_endpoint.
