---
title: "List log streams"
method: GET
path: "/list_log_streams"
tags: ["Log Streams"]
---

# List log streams

`GET /list_log_streams`

## Request

- Base URL: `https://happy-animal-123.convex.cloud/api/v1`
- URL: `https://happy-animal-123.convex.cloud/api/v1/list_log_streams`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `Authorization`
  - API key in header `Authorization`
  - API key in header `Authorization`

List configs for all existing log streams in a deployment.

## Response `200`

- LogStreamConfig[]
  - union
    - object
      - `id` string, required
      - `status` union, required: Status of a log stream
        - object
          - `type` 'pending', required
        - object
          - `type` 'restarting', required
        - object
          - `reason` string, required
          - `type` 'failed', required
        - object
          - `type` 'active', required
        - object
          - `type` 'deleting', required
      - `siteLocation` 'US1' | 'US3' | 'US5' | 'EU' | 'US1_FED' | 'AP1', required: The Datadog deployment locations, used to construct URLs
      - `ddTags` string[], required: Optional comma-separated list of tags. These are sent to Datadog in each log event via the `ddtags` field.
      - `service` string, nullable: Service name used as a special tag in Datadog.
      - `topics` LogTopic[], nullable: The topics this log stream is subscribed to. `null` means subscribed to all topics, including ones added in the future.
      - `logStreamType` 'datadog', required
    - object
      - `id` string, required
      - `status` union, required: Status of a log stream
        - object
          - `type` 'pending', required
        - object
          - `type` 'restarting', required
        - object
          - `reason` string, required
          - `type` 'failed', required
        - object
          - `type` 'active', required
        - object
          - `type` 'deleting', required
      - `url` string, required: URL to send logs to.
      - `format` 'json' | 'jsonl', required
      - `hmacSecret` string, required: Use this secret to verify webhook signatures.
      - `topics` LogTopic[], nullable: The topics this log stream is subscribed to. `null` means subscribed to all topics, including ones added in the future.
      - `logStreamType` 'webhook', required
    - object
      - `id` string, required
      - `status` union, required: Status of a log stream
        - object
          - `type` 'pending', required
        - object
          - `type` 'restarting', required
        - object
          - `reason` string, required
          - `type` 'failed', required
        - object
          - `type` 'active', required
        - object
          - `type` 'deleting', required
      - `datasetName` string, required: Name of the dataset in Axiom. This is where the logs will be sent.
      - `attributes` AxiomAttribute[], required: Optional list of attributes. These are extra fields and values sent to Axiom in each log event.
        - `key` string, required
        - `value` string, required
      - `ingestUrl` string, nullable: Optional ingest endpoint for Axiom
      - `topics` LogTopic[], nullable: The topics this log stream is subscribed to. `null` means subscribed to all topics, including ones added in the future.
      - `logStreamType` 'axiom', required
    - object
      - `id` string, required
      - `status` union, required: Status of a log stream
        - object
          - `type` 'pending', required
        - object
          - `type` 'restarting', required
        - object
          - `reason` string, required
          - `type` 'failed', required
        - object
          - `type` 'active', required
        - object
          - `type` 'deleting', required
      - `tags` object, nullable: Tags to add to all events routed to Sentry.
      - `logStreamType` 'sentry', required
    - object
      - `id` string, required
      - `status` union, required: Status of a log stream
        - object
          - `type` 'pending', required
        - object
          - `type` 'restarting', required
        - object
          - `reason` string, required
          - `type` 'failed', required
        - object
          - `type` 'active', required
        - object
          - `type` 'deleting', required
      - `host` string, nullable: PostHog host URL.
      - `serviceName` string, nullable: OTLP service.name attribute.
      - `topics` LogTopic[], nullable: The topics this log stream is subscribed to. `null` means subscribed to all topics, including ones added in the future.
      - `logStreamType` 'postHogLogs', required
    - object
      - `id` string, required
      - `status` union, required: Status of a log stream
        - object
          - `type` 'pending', required
        - object
          - `type` 'restarting', required
        - object
          - `reason` string, required
          - `type` 'failed', required
        - object
          - `type` 'active', required
        - object
          - `type` 'deleting', required
      - `host` string, nullable: PostHog host URL.
      - `logStreamType` 'postHogErrorTracking', required

---

[API](https://skmtc.dev/operatornest/apis/convex-deployment-api.md) · [All operations](https://skmtc.dev/operatornest/apis/convex-deployment-api/llms.txt) · [OpenAPI document](https://skmtc.dev/operatornest/apis/convex-deployment-api/revisions/bd0de6c553a7?raw)