Skip to content
Docs

Drains

Configure Drains to send your Vercel observability data to an external destination. You can inspect existing Drains, update their configuration, and test delivery before relying on them.

Create a new Drain.

Parameters

ParameterTypeRequiredDescription
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyobjectNoRequest body for this tool.

Find a Drain by id.

Parameters

ParameterTypeRequiredDescription
idstringYesThe drain ID.
teamIdstringNoTeam ID.
slugstringNoTeam slug.

Retrieve a list of all Drains.

Parameters

ParameterTypeRequiredDescription
projectIdstringNoThe project ID.
includeMetadatabooleanNoDefault: false.
teamIdstringNoTeam ID.
slugstringNoTeam slug.

Validate Drain delivery configuration.

Parameters

ParameterTypeRequiredDescription
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyobjectNoRequest body for this tool.

Update an existing Drain.

Parameters

ParameterTypeRequiredDescription
idstringYesThe drain ID.
teamIdstringNoTeam ID.
slugstringNoTeam slug.
requestBodyobjectNoRequest body for this tool.

Was this helpful?

supported.