Get Destinations

client.workers.observability.destinations.list(, ?): SinglePage<DestinationListResponse { configuration, enabled, name, 2 more } >

GET/accounts/{account_id}/workers/observability/destinations

List your Workers Observability Telemetry Destinations.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

User Service Key

Used when interacting with the Origin CA certificates API. View/change your key.

Example:

X-Auth-User-Service-Key: v1.0-144c9defac04969c7bfad8ef-631a41d003a32d25fe878081ef365c49503f7fada600da935e2851a1c7326084b85cbf6429c4b859de8475731dc92a9c329631e6d59e6c73da7b198497172b4cefe071d90d0f5d2719

Accepted Permissions (at least one required)

Workers Observability WriteWorkers Observability Read

ParametersExpand Collapse

params: DestinationListParams { account_id, order, orderBy, 2 more }

account_id: string

Path param: Your Cloudflare account ID.

order?: "asc" | "desc"

Query param

One of the following:

"asc"

"desc"

orderBy?: "created" | "updated"

Query param

One of the following:

"created"

"updated"

page?: number

Query param

minimum1

perPage?: number

Query param

maximum50

minimum5

ReturnsExpand Collapse

DestinationListResponse { configuration, enabled, name, 2 more }

configuration: Configuration { destination_conf, headers, jobStatus, 3 more }

destination_conf: string

headers: Record<string, string>

jobStatus: JobStatus { error_message, last_complete, last_error }

error_message: string

last_complete: string

last_error: string

logpushDataset: "opentelemetry-traces" | "opentelemetry-logs" | "opentelemetry-metrics"

One of the following:

"opentelemetry-traces"

"opentelemetry-logs"

"opentelemetry-metrics"

type: "logpush"

url: string

enabled: boolean

name: string

scripts: Array<string>

slug: string

Get Destinations

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const destinationListResponse of client.workers.observability.destinations.list({
  account_id: 'account_id',
})) {
  console.log(destinationListResponse.configuration);
}

{
  "errors": [
    {
      "message": "message"
    }
  ],
  "messages": [
    {
      "message": "Successful request"
    }
  ],
  "result": [
    {
      "configuration": {
        "destination_conf": "destination_conf",
        "headers": {
          "foo": "string"
        },
        "jobStatus": {
          "error_message": "error_message",
          "last_complete": "last_complete",
          "last_error": "last_error"
        },
        "logpushDataset": "opentelemetry-traces",
        "type": "logpush",
        "url": "url"
      },
      "enabled": true,
      "name": "name",
      "scripts": [
        "string"
      ],
      "slug": "slug"
    }
  ],
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "message": "message"
    }
  ],
  "messages": [
    {
      "message": "Successful request"
    }
  ],
  "result": [
    {
      "configuration": {
        "destination_conf": "destination_conf",
        "headers": {
          "foo": "string"
        },
        "jobStatus": {
          "error_message": "error_message",
          "last_complete": "last_complete",
          "last_error": "last_error"
        },
        "logpushDataset": "opentelemetry-traces",
        "type": "logpush",
        "url": "url"
      },
      "enabled": true,
      "name": "name",
      "scripts": [
        "string"
      ],
      "slug": "slug"
    }
  ],
  "success": true
}