Skip to main content
GET
/
v1
/
drains
getDrains
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.drains.getDrains({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();
{
  "drains": [
    {
      "id": "<string>",
      "ownerId": "<string>",
      "name": "<string>",
      "createdAt": 123,
      "createdFrom": "self-served",
      "updatedAt": 123,
      "projectIds": [
        "<string>"
      ],
      "schemas": {
        "log": {},
        "trace": {},
        "analytics": {},
        "speed_insights": {}
      },
      "delivery": {
        "type": "http",
        "endpoint": "<string>",
        "encoding": "json",
        "compression": "gzip",
        "headers": {},
        "secret": "<string>"
      },
      "sampling": [
        {
          "type": "head_sampling",
          "rate": 123,
          "env": "production",
          "requestPath": "<string>"
        }
      ],
      "teamId": "<string>",
      "status": "enabled",
      "disabledAt": 123,
      "disabledReason": "disabled-by-owner",
      "disabledBy": "<string>",
      "firstErrorTimestamp": 123,
      "configurationId": "<string>",
      "clientId": "<string>",
      "source": {
        "kind": "self-served"
      },
      "filter": "<string>",
      "filterV2": {
        "version": "v1"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Default authentication mechanism

Query Parameters

projectId
string
includeMetadata
boolean
default:false
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

drains
required
I