Explore documentation
  1. Welcome to Telemetry 👋
  2. Quick start guide
  3. Wide events vs. metrics
  4. Ingesting data
    1. Better Stack collector
    2. OpenTelemetry
    3. Vector
    4. Ingesting via HTTP API
    5. Ingesting metrics
    6. Ingesting logs
    7. Migrating to Better Stack
  5. Using the product
    1. AI SRE ↗
    2. MCP server ↗
    3. Transforming ingested data
    4. Querying data
    5. Tracing
    6. Grafana
    7. Alerts
  6. Telemetry API
    1. Getting an API token
    2. Sources & collectors
      1. Sources API
      2. Collectors API
        1. List all collectors GET
        2. Get a single collector GET
        3. Create a collector POST
        4. Update a collector PATCH
        5. Remove a collector DELETE
        6. List hosts where a collector is running GET
        7. Lists databases monitored by a collector GET
      3. Collector metrics targets API
      4. Metrics API
      5. Source groups API
    3. Dashboards
    4. Explorations
    5. Alerts API
    6. Connections API
    7. Query API ↗
    8. Usage API ↗
  7. Alternative to
    1. Lightstep

Lists databases monitored by a collector

Returns a list of databases currently being monitored by the specified collector.

For security reasons, passwords are never included in the API response.

GET https://telemetry.betterstack.com/api/v1/collectors/{id}/databases

URL parameters

id
required string

The unique identifier of the collector.

Headers

Authorization
required string

Bearer $TOKEN

200

Returns the databases the collector monitors.

Response body

{
  "data": [
    {
      "id": "201",
      "type": "collector_database",
      "attributes": {
        "service_type": "postgres",
        "host": "db1.example.com",
        "port": 5432,
        "username": "betterstack_user",
        "status": "up",
        "ssl_mode": "require",
        "tls": null,
        "service": "db1",
        "container": null,
        "autogenerated": false
      }
    },
    {
      "id": "202",
      "type": "collector_database",
      "attributes": {
        "service_type": "redis",
        "host": "cache.example.com",
        "port": 6379,
        "username": null,
        "status": "up",
        "ssl_mode": null,
        "tls": null,
        "service": "cache",
        "container": null,
        "autogenerated": false
      }
    }
  ]
}
401

Invalid or missing authentication token.

404

A collector with the specified ID was not found.

Response attributes

id
string

The ID of the database, the same ID the collector targets endpoints use.

type
string

Always collector_database.

attributes.service_type
string

The database type: postgres, pgcat, pgbouncer, mysql, redis, mongodb, memcached or elasticsearch.

attributes.host
string

The hostname or IP address of the database.

attributes.port
integer

The port of the database.

attributes.username
string or null

The username used to connect, or null when none is set.

attributes.status
string

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

attributes.ssl_mode
string or null

The SSL mode for PostgreSQL and its connection poolers, disable, require or verify-ca, or null when not set.

attributes.tls
string or null

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

attributes.service
string or null

The service the database is grouped under, discovered by the collector or taken from the first label of the hostname, or null when there is none.

attributes.container
string or null

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

attributes.autogenerated
boolean

Whether the collector discovered the database automatically rather than a user adding it.

Example Request

cURL
curl -L -H "Authorization: Bearer $TOKEN" \
     "https://telemetry.betterstack.com/api/v1/collectors/1/databases"


Previous article

List hosts where a collector is running

Next article

List collector metrics targets