Get Observability Exporter by ID

GET /admin/v1/observability_exporters/{id}

Get Observability Exporter by ID

Get an observability exporter resource by ID.

Parameters

• id (path, string, required): Observability exporter resource ID, as assigned by the active resource source (a UUIDv5 derived from the entry name in file mode; the etcd key's ID segment otherwise).

Responses

• 200: OK
• id (string, required): Resource ID, as assigned by the active resource source.
• revision (integer, required): Monotonic resource revision: the etcd mod_revision of the entry, or the load generation in file mode.
• value (object, required): Stored observability exporter configuration.
• allOf variant 1
• value.enabled (boolean, optional): Whether this exporter is active. Disabled exporters remain configured but do not receive telemetry.
• value.name (string, required): Operator-facing label, surfaced in logs and dashboard lists. The etcd key UUID is the resource identity.
• oneOf variant 1: OTLP HTTP
• value.content_max_bytes (integer, optional): Maximum bytes per captured prompt or response field when content_mode is full.
• value.content_mode (object, optional): Controls whether spans include prompt and response content. metadata_only omits content. full includes content truncated by content_max_bytes.
• allOf variant 1
• oneOf variant 1: Metadata only
• oneOf variant 2: Full content
• value.enabled (boolean, optional): Whether this exporter is active. Disabled exporters remain configured but do not receive telemetry.
• value.endpoint (string, required): Full URL of the OTLP/HTTP traces endpoint. Include the receiver's expected path, such as /v1/traces.
• value.headers (object, optional): Static headers attached to every export request, such as authorization or vendor-specific API-key headers.
• value.kind (string, required): Exporter type. Use otlp_http to send telemetry to an OTLP HTTP endpoint.
• value.name (string, optional): Operator-facing label, surfaced in logs and dashboard lists. The etcd key UUID is the resource identity.
• value.sample_rate (number, optional): Fraction of requests exported as traces, from 0.0 to 1.0.
• oneOf variant 2: Aliyun SLS
• value.content_max_bytes (integer, optional): Maximum bytes per captured prompt or response field when content_mode is full.
• value.content_mode (object, optional): Controls whether logs include prompt and response content. metadata_only omits content. full includes content truncated by content_max_bytes.
• allOf variant 1
• oneOf variant 1: Metadata only
• oneOf variant 2: Full content
• value.credential_ref (string, required): Credential reference resolved by the gateway at delivery time. The plaintext AccessKey is not stored in this resource.
• value.enabled (boolean, optional): Whether this exporter is active. Disabled exporters remain configured but do not receive telemetry.
• value.endpoint (string, required): SLS regional endpoint host without a scheme, such as ap-southeast-3.log.aliyuncs.com. Signed requests are sent to this endpoint with the SLS project as the host prefix.
• value.kind (string, required): Exporter type. Use aliyun_sls to send telemetry to Aliyun SLS.
• value.logstore (string, required): SLS logstore that receives the request-event logs.
• value.name (string, optional): Operator-facing label, surfaced in logs and dashboard lists. The etcd key UUID is the resource identity.
• value.project (string, required): SLS project that prefixes the regional endpoint in signed requests.
• oneOf variant 3: Object storage
• value.auth_mode (object, optional): How the gateway authenticates to the bucket.
• allOf variant 1
• oneOf variant 1: Credential reference
• oneOf variant 2: Cloud identity
• value.bucket (string, required): Bucket for S3 or GCS, or container for Azure Blob, that receives exported files.
• value.compression (object, optional): Compression applied to each NDJSON file before upload.
• allOf variant 1
• oneOf variant 1: Gzip
• oneOf variant 2: None
• value.credential_ref (string, optional): Credential reference resolved by the gateway at delivery time. Required when auth_mode is credential_ref.
• value.enabled (boolean, optional): Whether this exporter is active. Disabled exporters remain configured but do not receive telemetry.
• value.endpoint (string, optional): Backend host override for S3-compatible stores such as MinIO, Aliyun OSS, or Cloudflare R2. When omitted, the provider's native endpoint is used.
• value.kind (string, required): Exporter type. Use object_store to write telemetry batches to object storage.
• value.name (string, optional): Operator-facing label, surfaced in logs and dashboard lists. The etcd key UUID is the resource identity.
• value.prefix (string, required): Key prefix the partition path is appended to, e.g. ai-gateway. The full key is <prefix>/org=…/env=…/table=…/dt=…/hh=…/<file>.
• value.provider (object, required): Which object-storage backend the bucket lives in.
• allOf variant 1
• value.region (string, optional): AWS region for S3 SigV4 signature scope. Set this for S3 buckets outside us-east-1. Ignored for GCS and Azure Blob.
• allOf variant 1
• oneOf variant 4: Datadog
• value.content_max_bytes (integer, optional): Maximum bytes per captured prompt or response field when content_mode is full. Keep this under Datadog intake limits to avoid delivery errors.
• value.content_mode (object, optional): Controls whether logs include prompt and response content. metadata_only omits content. full includes content truncated by content_max_bytes.
• allOf variant 1
• oneOf variant 1: Metadata only
• oneOf variant 2: Full content
• value.credential_ref (string, required): Credential reference resolved by the gateway at delivery time. The plaintext Datadog API key is not stored in this resource.
• value.ddsource (string, optional): Datadog ddsource reserved attribute. Identifies the integration or source.
• value.enabled (boolean, optional): Whether this exporter is active. Disabled exporters remain configured but do not receive telemetry.
• value.kind (string, required): Exporter type. Use datadog to send telemetry to Datadog Logs intake.
• value.name (string, optional): Operator-facing label, surfaced in logs and dashboard lists. The etcd key UUID is the resource identity.
• value.service (string, required): Datadog service reserved attribute. Every log from this exporter is tagged with this service name in Datadog Log Explorer.
• value.site (string, required): Datadog site, such as datadoghq.com, us3.datadoghq.com, or datadoghq.eu.
• value.tags (array, optional): Operator-defined tags rendered into Datadog's comma-joined ddtags reserved attribute. For example, ["team:platform", "tier:prod"] becomes team:platform,tier:prod. Leave empty when no tags should be sent.
• 401: Missing or invalid admin key
• error_msg (string, required): Human-readable error message.
• 404: Resource not found Response fields (application/json): identical to GET /admin/v1/observability_exporters/{id}, response 401 above.
• 500: Configuration store operation failed Response fields (application/json): identical to GET /admin/v1/observability_exporters/{id}, response 401 above.

cURL

curl -X GET 'http://127.0.0.1:3001/admin/v1/observability_exporters/{id}'