Retrieve a log drain
The drain without its signing secret, which is only returned when created.
bearerAuthAuthorizationBearer <token>A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.
id*stringThe log drain's id.
Coss-Version?"2026-10-10"The API version (a date) to use for this request. Defaults to your organization's version, pinned to the latest one when it first used the API and upgraded from the dashboard. The SDK always sends the version it was built for.
"2026-10-10"The log drain.
application/json- response
- response
- …
object*"log_drain""log_drain"id*stringurl*stringWhere batches are posted.
description*|Your note about it. null: none.
sources*array<>What the drain forwards: api (requests made with the environment's API keys), email (email events), webhook (webhook delivery attempts) and audit (changes to the environment, from the organization's audit log). An empty array means every source, including ones added later.
format*LogDrainFormatHow batches are encoded. ndjson: one JSON object per line (application/x-ndjson), for your own endpoint. loki: Loki's push API (/loki/api/v1/push, Grafana Cloud Logs). datadog: Datadog's log intake (/api/v2/logs). otlp: OTLP/HTTP logs in JSON (/v1/logs, Grafana Cloud, Honeycomb, an OpenTelemetry Collector…).
"ndjson""loki""datadog""otlp"auth_header_name*|The header sent with every batch to authenticate it (e.g. Authorization, DD-API-KEY), or null. Its value is never returned.
enabled*booleanA disabled drain receives nothing, and lines logged while it is disabled are not kept for it.
disabled_reason*|manual: someone disabled it. failing: a batch failed every attempt, so coss.com disabled it. null while enabled.
"manual""failing"nulldisabled_at*|When it was disabled. null while enabled.
date-timecreated_at*stringdate-timeupdated_at*stringdate-timeimport { Coss } from "coss";const coss = new Coss({ apiKey: process.env.COSS_API_KEY, baseUrl: "https://api.coss.com",});const { data, error } = await coss.logDrains.get("drain_01k7c8m4q2f3e9v6t5r1n0p8yz");{ "object": "log_drain", "id": "drain_01k7c8m4q2f3e9v6t5r1n0p8yz", "url": "https://logs.example.com/coss", "description": "Production logs", "sources": [ "api", "email" ], "format": "ndjson", "auth_header_name": null, "enabled": true, "disabled_reason": null, "disabled_at": null, "created_at": "2026-01-15T09:30:00.000Z", "updated_at": "2026-01-15T09:30:00.000Z"}