PATCH /v1/drains/{id}

Update the configuration of an existing drain.

Servers

https://api.vercel.com

Path parameters

Name	Type	Required	Description
`id`	String	Yes

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Query parameters

Name	Type	Required	Description
`teamId`	String	No	The Team identifier to perform the request on behalf of.
`slug`	String	No	The Team slug to perform the request on behalf of.

Request body fields

Name	Type	Required	Description
`projectIds[]`	Array	No
`source`	Object	No
`schemas`	Object	No
`schemas.name`	Object	No
`schemas.name.version`	String	Yes
`name`	String	No
`transforms[]`	Array	No
`transforms[].id`	String	Yes
`filter`		No
`projects`	String	No	Valid values: `"some"` `"all"`
`status`	String	No	Valid values: `"disabled"` `"enabled"`
`delivery`	Object	No
`sampling[]`	Array	No
`sampling[].rate`	Number	Yes	Sampling rate from 0 to 1 (e.g., 0.1 for 10%)
`sampling[].env`	String	No	Environment to apply sampling to Valid values: `"preview"` `"production"`
`sampling[].requestPath`	String	No	Request path prefix to apply the sampling rule to
`sampling[].type`	String	Yes

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.