Find a Drain by id | Vercel REST API

APIs & SDKs

Find a Drain by id

GEThttps://api.vercel.com/v1/drains/{id}

Get the information for a specific Drain by passing the drain id in the URL.

https://api.vercel.com/v1/drains/{id}

const response = await fetch('https://api.vercel.com/v1/drains/id?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

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

Response

{
  "createdAt": "123",
  "delivery": {
    "compression": "gzip",
    "encoding": "json",
    "endpoint": "string",
    "headers": "value",
    "secret": "string",
    "type": "http"
  },
  "disabledAt": "123",
  "disabledBy": "string",
  "disabledReason": "account-plan-downgrade",
  "firstErrorTimestamp": "123",
  "id": "icfg_1234567890",
  "name": "Example Name",
  "ownerId": "example_id",
  "projectIds": [],
  "sampling": [
    {
      "env": "preview",
      "rate": "123",
      "requestPath": "string",
      "type": "head_sampling"
    }
  ],
  "schemas": {
    "ai_gateway": "value",
    "analytics": "value",
    "audit_log": "value",
    "connect": "value",
    "log": "value",
    "speed_insights": "value",
    "trace": "value"
  },
  "source": {
    "defaultFor": "eve-tracing",
    "kind": "self-served"
  },
  "status": "disabled",
  "teamId": "example_id",
  "updatedAt": "123",
  "filterV2": {
    "filter": {
      "deployment": {
        "environments": []
      },
      "log": {
        "legacy_excludeCachedStaticAssetLogs": "false",
        "sources": []
      },
      "project": {
        "ids": []
      },
      "type": "basic"
    },
    "version": "v2"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idstringRequired

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Success

createdAtnumberRequired

deliveryobjectRequired5 variants

disabledAtnumberOptional

disabledBystringOptional

disabledReasonstringOptional

firstErrorTimestampnumberOptional

idstringRequired

namestringRequired

ownerIdstringRequired

projectIdsarrayOptional

samplingarrayOptional

schemasobjectRequired

sourceobjectRequired2 variants

statusstringOptional

teamIdstringOptional

updatedAtnumberRequired

filterV2objectOptional

Errors

400One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

Cross-link map: Find a Drain by id (/docs/rest-api/drains/find-a-drain-by-id)

From the Vercel docs graph (built 2026-10-08T05:38:39.548Z), 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

Retrieve a list of all Drains — GET /v1/drains — Allows to retrieve the list of Drains of the authenticated team.
Update an existing Drain — PATCH /v1/drains/{id} — Update the configuration of an existing drain.
Delete a drain — DELETE /v1/drains/{id} — Delete a specific Drain by passing the drain id in the URL.
Validate Drain delivery configuration — POST /v1/drains/test — Validate the delivery configuration of a Drain using sample events.
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

This page links to (1)

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

Pages that link here (1)

By site: vercel-docs (1)

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

https://api.vercel.com/v1/drains/{id}

const response = await fetch('https://api.vercel.com/v1/drains/id?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

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

Response

{
  "createdAt": "123",
  "delivery": {
    "compression": "gzip",
    "encoding": "json",
    "endpoint": "string",
    "headers": "value",
    "secret": "string",
    "type": "http"
  },
  "disabledAt": "123",
  "disabledBy": "string",
  "disabledReason": "account-plan-downgrade",
  "firstErrorTimestamp": "123",
  "id": "icfg_1234567890",
  "name": "Example Name",
  "ownerId": "example_id",
  "projectIds": [],
  "sampling": [
    {
      "env": "preview",
      "rate": "123",
      "requestPath": "string",
      "type": "head_sampling"
    }
  ],
  "schemas": {
    "ai_gateway": "value",
    "analytics": "value",
    "audit_log": "value",
    "connect": "value",
    "log": "value",
    "speed_insights": "value",
    "trace": "value"
  },
  "source": {
    "defaultFor": "eve-tracing",
    "kind": "self-served"
  },
  "status": "disabled",
  "teamId": "example_id",
  "updatedAt": "123",
  "filterV2": {
    "filter": {
      "deployment": {
        "environments": []
      },
      "log": {
        "legacy_excludeCachedStaticAssetLogs": "false",
        "sources": []
      },
      "project": {
        "ids": []
      },
      "type": "basic"
    },
    "version": "v2"
  }
}

OpenAPI Specification