List collector metrics targets

GET https://telemetry.betterstack.com/api/v1/collectors/{collector_id}/targets

Query parameters

page

integer

Page number for pagination.

per_page

integer

Number of items per page. Default 50, maximum 250.

Headers

Authorization

required string

Bearer $TOKEN

200

Returns a paginated list of the collector's targets.

Response body

{
  "data": [
    {
      "id": "1",
      "type": "collector_target",
      "attributes": {
        "kind": "postgres",
        "host": "db.example.com",
        "port": 5432,
        "username": "monitor",
        "ssl_mode": "require",
        "status": "up",
        "enabled": true,
        "container": null,
        "created_at": "2025-06-01T12:00:00.000Z",
        "updated_at": "2025-06-15T14:32:00.000Z"
      }
    },
    {
      "id": "2",
      "type": "collector_target",
      "attributes": {
        "kind": "nginx",
        "host": "collector-host-1",
        "port": 80,
        "service": "edge-nginx",
        "listen_ip": "10.0.0.1",
        "status": "up",
        "enabled": true,
        "container": null,
        "created_at": "2025-06-01T12:00:00.000Z",
        "updated_at": "2025-06-15T14:30:00.000Z"
      }
    }
  ],
  "pagination": {
    "first": "https://telemetry.betterstack.com/api/v1/collectors/1/targets?page=1",
    "last": "https://telemetry.betterstack.com/api/v1/collectors/1/targets?page=1",
    "prev": null,
    "next": null
  }
}

Response attributes

string

The ID of the target.

type

string

Always collector_target.

attributes.kind

string

The target type: postgres, pgcat, pgbouncer, mysql, redis, mongodb, memcached, elasticsearch, nginx, apache, kafka, node_exporter, prometheus, traefik or kube_state_metrics.

attributes.host

string

The hostname or IP address of the target.

attributes.port

integer or null

The port of the target, or null when not set, present for every kind except prometheus.

attributes.service

string

The service name of the target, present only for nginx, apache, kafka, prometheus and traefik.

attributes.listen_ip

string or null

The IP address the process listens on, or null when not set, present only for nginx, apache, kafka and traefik.

attributes.endpoint

string or null

The full scrape URL, or null when not set, present only for prometheus.

attributes.scheme

string

The connection scheme, http or https, present only for elasticsearch.

attributes.username

string or null

The username used to connect, or null when not set, present only for postgres, pgbouncer, mysql, redis, mongodb, memcached and elasticsearch.

attributes.ssl_mode

string or null

The SSL mode, disable, require or verify-ca, or null when not set, present only for postgres and pgbouncer.

attributes.tls

string or null

The TLS mode, false, true, skip-verify or preferred, or null when not set, present only for mysql.

attributes.status

string

The connection status: pending, up, unreachable, down, invalid_credentials, configuration_required, disabled or removed.

attributes.enabled

boolean

Whether the target is enabled, false when its status is disabled.

attributes.container

string or null

The container the target runs in, or null when it wasn't discovered in a container.

attributes.created_at

string

When the target was created, as an ISO 8601 date-time in UTC.

attributes.updated_at

string

When the target was last updated, as an ISO 8601 date-time in UTC.

pagination.first

string

URL of the first page. Read more about pagination.

pagination.last

string

URL of the last page.

pagination.prev

string or null

URL of the previous page, or null on the first page.

pagination.next

string or null

URL of the next page, or null on the last page.

Explore documentation

Please accept cookies