CIcircleci
OTel

🧪 Create an OTLP exporter

[EXPERIMENTAL] Creates a new OTLP exporter configuration for the given organization. A maximum of 5 exporter configurations are allowed per organization.

post/otel/exporters

Request

  • Base URL
    https://circleci.com/api/v2
  • URL
    https://circleci.com/api/v2/otel/exporters
  • Auth
    • API key in header Circle-Token
    • or HTTP bearer
    • or HTTP basic
    • or API key in query parameter circle-token

Request body

org_idstring uuid required

The organization ID to create the exporter for.

endpointstring required

The OTLP endpoint to send spans to. Don't include https:// or grpc://. Just the hostname and port are required.

protocol'grpc' | 'http' required

The OTLP transport to use when exporting data.

insecureboolean

Whether to use an insecure connection to the endpoint.

headersobject

Additional headers to include in export requests.

Example request

{
  "org_id": "b9291e0d-a11e-41fb-8517-c545388b5953",
  "endpoint": "otel.example.com:4317",
  "protocol": "grpc"
}

Response

OTLP exporter created.

idstring uuid

The exporter ID.

org_idstring uuid

The organization ID that owns this exporter.

endpointstring

The OTLP endpoint to send spans to.

protocol'grpc' | 'http'

The OTLP transport to use when exporting data.

insecureboolean

Whether to use an insecure connection to the endpoint.

headersobject

Additional headers to include in export requests. Header values are encrypted at rest and will appear redacted as "xxxx" in responses.

issuesstring[]

A list of validation issues detected with this exporter configuration, such as an endpoint that no longer resolves. Only present when issues are detected.

Example response

{
  "id": "123e4127-e89b-12d3-a456-426123417400",
  "org_id": "b9291e0d-a11e-41fb-8517-c545388b5953",
  "endpoint": "otel.example.com:4317",
  "protocol": "grpc"
}

Changes

No recorded changes to this operation across all 1 revision of this API.