Skip to content
VercelVercel
'; user_status_content.firstChild.appendChild(avatarContainer); } else { // Placeholder for LoggedOutUserMenu let loggedOutContainer = document.createElement('div'); // if LoggedOutUserMenu fallback let userBtn = document.createElement('button'); userBtn.style.width = "33px"; userBtn.style.height = "33px"; userBtn.style.display = "flex"; userBtn.style.alignItems = "center"; userBtn.style.justifyContent = "center"; userBtn.style.color = "var(--ds-gray-900)"; userBtn.style.border = "1px solid var(--ds-gray-300)"; userBtn.style.borderRadius = "100%"; userBtn.style.cursor = "pointer"; userBtn.style.background = "transparent"; userBtn.style.padding = "0"; // user icon ( from geist) let svg = document.createElementNS('http://www.w3.org/2000/svg', 'svg'); svg.setAttribute('data-testid', 'geist-icon'); svg.setAttribute('height', '16'); svg.setAttribute('stroke-linejoin', 'round'); svg.setAttribute('style', 'color:currentColor'); svg.setAttribute('viewBox', '0 0 16 16'); svg.setAttribute('width', '16'); let path = document.createElementNS('http://www.w3.org/2000/svg', 'path'); path.setAttribute('fill-rule', 'evenodd'); path.setAttribute('clip-rule', 'evenodd'); path.setAttribute('d', 'M7.75 0C5.95507 0 4.5 1.45507 4.5 3.25V3.75C4.5 5.54493 5.95507 7 7.75 7H8.25C10.0449 7 11.5 5.54493 11.5 3.75V3.25C11.5 1.45507 10.0449 0 8.25 0H7.75ZM6 3.25C6 2.2835 6.7835 1.5 7.75 1.5H8.25C9.2165 1.5 10 2.2835 10 3.25V3.75C10 4.7165 9.2165 5.5 8.25 5.5H7.75C6.7835 5.5 6 4.7165 6 3.75V3.25ZM2.5 14.5V13.1709C3.31958 11.5377 4.99308 10.5 6.82945 10.5H9.17055C11.0069 10.5 12.6804 11.5377 13.5 13.1709V14.5H2.5ZM6.82945 9C4.35483 9 2.10604 10.4388 1.06903 12.6857L1 12.8353V13V15.25V16H1.75H14.25H15V15.25V13V12.8353L14.931 12.6857C13.894 10.4388 11.6452 9 9.17055 9H6.82945Z'); path.setAttribute('fill', 'currentColor'); svg.appendChild(path); userBtn.appendChild(svg); loggedOutContainer.appendChild(userBtn); loggedOutContainer.style.display = 'flex'; loggedOutContainer.style.gap = '8px'; loggedOutContainer.style.alignItems = 'center'; user_status_content.firstChild.appendChild(loggedOutContainer); } })();
Menu

Retrieve a list of all Drains

GEThttps://api.vercel.com/v1/drains
Allows to retrieve the list of Drains of the authenticated team.
https://api.vercel.com/v1/drains
const response = await fetch('https://api.vercel.com/v1/drains?projectId=string&includeMetadata=true&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
{
  "drains": [
    {
      "id": "icfg_1234567890",
      "createdAt": "123",
      "updatedAt": "123",
      "projectIds": [],
      "name": "Example Name",
      "teamId": "example_id",
      "ownerId": "example_id",
      "status": "enabled",
      "firstErrorTimestamp": "123",
      "disabledAt": "123",
      "disabledBy": "string",
      "disabledReason": "disabled-by-owner",
      "schemas": {
        "log": "value",
        "trace": "value",
        "analytics": "value",
        "speed_insights": "value",
        "ai_gateway": "value"
      },
      "delivery": {
        "type": "http",
        "endpoint": "string",
        "encoding": "json",
        "compression": "none",
        "headers": "value",
        "secret": "string"
      },
      "sampling": [
        {
          "type": "head_sampling",
          "rate": "123",
          "env": "production",
          "requestPath": "string"
        }
      ],
      "source": {
        "kind": "self-served"
      },
      "filter": "string",
      "filterV2": {
        "version": "v1"
      }
    }
  ]
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

projectIdstringOptional
includeMetadatabooleanOptional
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
drainsobjectRequired2 variants

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