# Create a log drain (/docs/api-reference/log-drains/create-log-drain)

Streams the environment's logs to a URL: every line `GET /v1/logs` returns (API requests, email events, webhook attempts) and the environment's audit events, posted as signed batches of up to 500 lines or 1 MB, usually within seconds. `format` picks the body: NDJSON for your own endpoint, or the intake API of Loki (Grafana Cloud), Datadog or an OTLP/HTTP collector, with `auth_header` carrying its key. Log drains belong to the API key's own environment: a `coss_test_…` key only ever sees sandbox drains, and a `coss_live_…` key only production ones. The response carries the signing secret, which is returned only here: store it, and verify every NDJSON batch with it (`verifyLogDrainBatch` in the SDK).

`POST https://api.coss.com/v1/log_drains`

Authenticate with your API key as a bearer token (`Authorization: Bearer coss_test_…`). Responses are JSON with snake_case fields; errors are `{ error: { type, code, message, param?, issues?, request_id } }` (https://coss.com/docs/api-reference/errors.md).

## Request body

- `url` (string, required, 1-2048 characters): An `https://` URL coss.com posts batches of log lines to.
- `description` (string | null, at most 256 characters): A note for your own reference. `null` clears it.
- `sources` (("api" | "email" | "webhook" | "risk" | "smtp" | "sms" | "sign" | "verify" | "forms" | "scheduling" | "audit")[], at most 11 items): 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. Defaults to every source.
- `format` ("ndjson" | "loki" | "datadog" | "otlp"): How 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…). Defaults to `ndjson`.
- `auth_header` (object | null): A header sent with every batch, for intake APIs that take a key: `Authorization` (`Basic …`, `Bearer …`), `DD-API-KEY`… Its value is stored encrypted and never returned. `null` removes it.
  - `name` (string, required, 1-128 characters): The header's name.
  - `value` (string, required, 1-4096 characters): The header's value. Encrypted, and never returned.

## Example request

TypeScript (the `coss` package):

```ts
import { Coss } from "coss";

const coss = new Coss({
  apiKey: process.env.COSS_API_KEY,
  baseUrl: "https://api.coss.com",
});

const { data, error } = await coss.logDrains.create({
  url: "https://logs.example.com/coss",
  description: "Production logs",
  sources: [
    "api",
    "email",
  ],
});
```

HTTP:

```sh
curl -X POST "https://api.coss.com/v1/log_drains" \
  -H "Authorization: Bearer $COSS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://logs.example.com/coss",
  "description": "Production logs",
  "sources": [
    "api",
    "email"
  ]
}'
```

Python:

```python
from coss import Coss

client = Coss()  # api_key= or COSS_API_KEY

client.log_drains.create(
    url="https://logs.example.com/coss",
    description="Production logs",
    sources=[
        "api",
        "email"
    ],
)
```

Go:

```go
import (
	"context"

	coss "github.com/cosscom/coss-go"
	cossclient "github.com/cosscom/coss-go/client"
)

client := cossclient.NewClient() // option.WithAPIKey(…) or COSS_API_KEY

request := &coss.CreateLogDrainRequest{
    URL: "https://logs.example.com/coss",
    Description: coss.String(
        "Production logs",
    ),
    Sources: []coss.LogDrainSource{
        coss.LogDrainSourceAPI,
        coss.LogDrainSourceEmail,
    },
}
client.LogDrains.Create(
    context.TODO(),
    request,
)
```

Ruby:

```ruby
require "coss"

client = Coss::Client.new # api_key: or COSS_API_KEY

client.log_drains.create(
  url: "https://logs.example.com/coss",
  description: "Production logs",
  sources: %w[api email]
)
```

PHP:

```php
<?php

use Coss\Coss;
use Coss\LogDrains\Requests\CreateLogDrainRequest;
use Coss\Types\LogDrainSource;

$client = new Coss(); // apiKey: or COSS_API_KEY

$client->logDrains->create(
    new CreateLogDrainRequest([
        'url' => 'https://logs.example.com/coss',
        'description' => 'Production logs',
        'sources' => [
            LogDrainSource::Api->value,
            LogDrainSource::Email->value,
        ],
    ]),
);
```

Java:

```java
import com.coss.Coss;
import com.coss.resources.logdrains.requests.CreateLogDrainRequest;
import com.coss.types.LogDrainSource;
import java.util.Arrays;
import java.util.Optional;

Coss client = Coss.builder().build(); // .apiKey(…) or COSS_API_KEY

client.logDrains().create(
    CreateLogDrainRequest
        .builder()
        .url("https://logs.example.com/coss")
        .description(
            OptionalNullable.of("Production logs")
        )
        .sources(
            Optional.of(
                Arrays.asList(LogDrainSource.API, LogDrainSource.EMAIL)
            )
        )
        .build()
);
```

.NET:

```csharp
using Coss;

var client = new CossClient(); // apiKey: or COSS_API_KEY

await client.LogDrains.CreateAsync(
    new CreateLogDrainRequest
    {
        Url = "https://logs.example.com/coss",
        Description = "Production logs",
        Sources = new List<LogDrainSource>() { LogDrainSource.Api, LogDrainSource.Email },
    }
);
```

## Response 200

The drain and its signing secret.

- `object` ("log_drain", required)
- `id` (string, required)
- `url` (string, required): Where batches are posted.
- `description` (string | null, required): Your note about it. `null`: none.
- `sources` (("api" | "email" | "webhook" | "risk" | "smtp" | "sms" | "sign" | "verify" | "forms" | "scheduling" | "audit")[], required): 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` ("ndjson" | "loki" | "datadog" | "otlp", required): How 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…).
- `auth_header_name` (string | null, required): The header sent with every batch to authenticate it (e.g. `Authorization`, `DD-API-KEY`), or `null`. Its value is never returned.
- `enabled` (boolean, required): A disabled drain receives nothing, and lines logged while it is disabled are not kept for it.
- `disabled_reason` ("manual" | "failing" | null, required): `manual`: someone disabled it. `failing`: a batch failed every attempt, so coss.com disabled it. `null` while enabled.
- `disabled_at` (string | null, required, date-time): When it was disabled. `null` while enabled.
- `created_at` (string, required, date-time)
- `updated_at` (string, required, date-time)
- `secret` (string, required): The drain's `whsec_…` signing secret, used to verify the batches coss.com sends. Returned only when the drain is created — store it now; it cannot be read back through the API.

Example:

```json
{
  "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",
  "secret": "whsec_6Jk…"
}
```

## Errors

- `400`: The body is not valid JSON (`invalid_json`). Also when the `Coss-Version` header names an unknown API version (`invalid_api_version`).
- `401`: The API key is missing, invalid, revoked or expired (`authentication_error`).
- `402`: The organization's plan doesn't include log drains (`plan_feature_unavailable`) (`billing_error`). Never retried: it needs a plan change or a payment.
- `403`: The API key lacks the permission this endpoint needs (`permission_error`), or its organization is suspended (`organization_suspended`).
- `413`: The request body is larger than 5 MB (`payload_too_large`).
- `415`: The body is not sent as `application/json` (`unsupported_media_type`).
- `422`: The body failed validation (`validation_error`), the URL is not a usable https:// URL (`invalid_url`), the auth header can't be sent (`invalid_auth_header`), or the environment already has 5 drains (`too_many_log_drains`).
- `429`: Too many requests with this API key (`rate_limited`), or too many requests with invalid keys from this address (`too_many_failed_authentications`). Retry after `Retry-After` seconds. Successful responses carry `RateLimit-Limit`, `RateLimit-Remaining` and `RateLimit-Reset` (seconds until the limit is fully restored).
- `500`: Unexpected server error (`api_error` / `internal_error`).
- `503`: The API key could not be verified right now; retry (`service_unavailable`).