Creates a new Integration Log Drain (deprecated)

APIs & SDKs

POSThttps://api.vercel.com/v2/integrations/log-drains

Creates an Integration log drain. This endpoint must be called with an OAuth2 client (integration), since log drains are tied to integrations. If it is called with a different token type it will produce a 400 error.

https://api.vercel.com/v2/integrations/log-drains

const response = await fetch('https://api.vercel.com/v2/integrations/log-drains?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "My first log drain",
    "projectIds": [],
    "secret": "a1Xsfd325fXcs",
    "deliveryFormat": "json",
    "url": "https://example.com/log-drain",
    "sources": [],
    "headers": "value",
    "environments": []
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "branch": "feature/*",
  "clientId": "oac_xRhY4LAB7yLhUADD69EvV7ct",
  "configurationId": "icfg_3bwCLgxL8qt5kjRLcv2Dit7F",
  "createdAt": "1558531915505",
  "createdFrom": "integration",
  "deliveryFormat": "json",
  "environments": [],
  "headers": "{\"Authorization\": \"Bearer 123\"}",
  "id": "ld_nBuA7zCID8g4QZ8g",
  "name": "My first log drain",
  "ownerId": "kr1PsOIzqEL5Xg6M4VZcZosf",
  "projectId": "AbCgVkqoxXeXCDWehVir51LHGrrcWL4mkYm14W6UBPWQeb",
  "projectIds": [],
  "samplingRate": "0.5",
  "source": {
    "defaultFor": "eve-tracing",
    "kind": "self-served"
  },
  "sources": [],
  "url": "https://example.com/log-drain"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Body

application/json

namestringRequired

The name of the log drain

projectIdsarrayOptional

secretstringOptional

A secret to sign log drain notification headers so a consumer can verify their authenticity

deliveryFormatobjectOptional

The delivery log format

urlstringRequired

The url where you will receive logs. The protocol must be https:// or http:// when type is json and ndjson.

sourcesarrayOptional

headersobjectOptional

Headers to be sent together with the request

environmentsarrayOptional

Response

200The log drain was successfully created

branchstringOptional

The branch regexp of log drain

clientIdstringOptional

The oauth2 client application id that created this log drain

configurationIdstringOptional

The client configuration this log drain was created with

createdAtnumberRequired

A timestamp that tells you when the log drain was created

createdFromstringOptional

Whether the log drain was created by an integration or by a user

deliveryFormatstringOptional

The delivery log format

environmentsarrayOptional

The environment of log drain

headersobjectOptional

The headers to send with the request

idstringRequired

The unique identifier of the log drain. Always prefixed with ld_

namestringRequired

The name of the log drain

ownerIdstringRequired

The identifier of the team or user whose events will trigger the log drain

projectIdstringOptional

projectIdsarrayOptional

The identifier of the projects this log drain is associated with

samplingRatenumberOptional

The sampling rate of log drain

sourceobjectRequired2 variants

sourcesarrayOptional

The sources from which logs are currently being delivered to this log drain.

urlstringRequired

The URL to call when logs are generated

Errors

400One of the provided values in the request body is invalid. The provided token is not from an OAuth2 Client

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

Cross-link map: Creates a new Integration Log Drain \(deprecated\) (/docs/rest-api/logdrains/creates-a-new-integration-log-drain-deprecated)

From the Vercel docs graph (built 2026-10-14T10:24:21.026Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Creates a Configurable Log Drain \(deprecated\) — POST /v1/log-drains — Creates a configurable log drain. This endpoint must be called with a team AccessToken \(integrati
Retrieves a list of Integration log drains \(deprecated\) — GET /v2/integrations/log-drains — Retrieves a list of all Integration log drains that are defined for the authenticated
Retrieves a Configurable Log Drain \(deprecated\) — GET /v1/log-drains/{id} — Retrieves a Configurable Log Drain. This endpoint must be called with a team AccessToken \(int
Retrieves a list of all the Log Drains \(deprecated\) — GET /v1/log-drains — Retrieves a list of all the Log Drains owned by the account. This endpoint must be called with an a
Deletes the Integration log drain with the provided \id\\ \(deprecated\) — DELETE /v1/integrations/log-drains/{id} — Deletes the Integration log drain with the provided \id\\. When using an OAut

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v2/integrations/log-drains

const response = await fetch('https://api.vercel.com/v2/integrations/log-drains?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "My first log drain",
    "projectIds": [],
    "secret": "a1Xsfd325fXcs",
    "deliveryFormat": "json",
    "url": "https://example.com/log-drain",
    "sources": [],
    "headers": "value",
    "environments": []
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "branch": "feature/*",
  "clientId": "oac_xRhY4LAB7yLhUADD69EvV7ct",
  "configurationId": "icfg_3bwCLgxL8qt5kjRLcv2Dit7F",
  "createdAt": "1558531915505",
  "createdFrom": "integration",
  "deliveryFormat": "json",
  "environments": [],
  "headers": "{\"Authorization\": \"Bearer 123\"}",
  "id": "ld_nBuA7zCID8g4QZ8g",
  "name": "My first log drain",
  "ownerId": "kr1PsOIzqEL5Xg6M4VZcZosf",
  "projectId": "AbCgVkqoxXeXCDWehVir51LHGrrcWL4mkYm14W6UBPWQeb",
  "projectIds": [],
  "samplingRate": "0.5",
  "source": {
    "defaultFor": "eve-tracing",
    "kind": "self-served"
  },
  "sources": [],
  "url": "https://example.com/log-drain"
}

OpenAPI Specification