Skip to content
MCP Gateway

Update telemetry mode and destination references with write-only secret refs.

PUT
/v1/telemetry

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
tenant_id
required
string
>= 1 characters
environment_id
required
string
>= 1 characters
mode
required
Allowed values: disabled local customer_managed managed_metadata
destination_refs
Array<string>
endpoint_ref

Opaque gateway-owned destination handle. Raw http(s) URLs, path/query token shapes, and secret-bearing endpoint material are rejected; real endpoint/token values use write-only reference fields.

string
/^(otel|siem|webhook|audit-export|disabled)://(?!.*(?:secret|token|password|api_key|client_secret))[a-z0-9][a-z0-9_-]{0,127}$/
write_only_secret_ref

Optional secret manager reference accepted only on write and never returned.

string
reason_code
required
string
/^[a-z0-9_]+$/
retention_policy
object
metadata_retention_days
required
integer
<= 3650
export_format
required
Allowed values: metadata otlp_metadata siem_ndjson_metadata webhook_json_metadata
redaction
required
object
include_payloads
required
boolean
private_payload_egress
required
boolean
secret_material_returned
required
boolean
no_payload_guarantee
required
boolean
audit_material
Allowed values: metadata_only

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated settings; secret references are not returned.

object
schemaVersion
required
request_id
required
string
>= 1 characters
tenant_id
required
string
>= 1 characters
environment_id
required
string
>= 1 characters
enabled
required
boolean
mode
required
Allowed values: disabled local customer_managed managed_metadata
destination_refs
required
Array<string>
retention_policy
required
object
metadata_retention_days
required
integer
<= 3650
export_format
required
Allowed values: metadata otlp_metadata siem_ndjson_metadata webhook_json_metadata
redaction
required
object
include_payloads
required
boolean
private_payload_egress
required
boolean
secret_material_returned
required
boolean
no_payload_guarantee
required
boolean
audit_material
Allowed values: metadata_only
opentelemetry_exporter_status
required
object
status
required
Allowed values: healthy degraded failed disabled unknown
checked_at
required
string format: date-time
reason_code
required
string
/^[a-z0-9_]+$/
last_error
object
reason_code
required
string
/^[a-z0-9_]+$/
retryable
boolean
audit_export_status
required

Linked health for audit export readiness; does not duplicate export job APIs.

object
status
required
Allowed values: healthy degraded failed disabled unknown
checked_at
required
string format: date-time
reason_code
required
string
/^[a-z0-9_]+$/
last_error
object
reason_code
required
string
/^[a-z0-9_]+$/
retryable
boolean
permissions
required
object
allowed_actions
required
Array
Allowed values: read create update test disable

403

Section titled “403 ”

Caller lacks permission to update telemetry settings.

object
schemaVersion
required
requestId
required
string
>= 1 characters
status
required
integer
>= 400 <= 599
reasonCode
required
string
/^[a-z0-9_]+$/
message
required
string
>= 1 characters
retryable
required
boolean
machineSafe
required
boolean
redactionStatus
required
Allowed values: redacted metadata_only
field

Optional metadata-only field identifier for validation errors.

string
details

Optional metadata-only diagnostic details. Never include secret material, payloads, prompts, raw endpoint URLs, or customer data.

object
requiredAction
string
>= 1 characters
resourceRef
string
>= 1 characters
key
additional properties
One of:
string

Type set in Geist, Source Serif 4, and Departure Mono.