drains

Update an existing Drain

Changed on

Update the configuration of an existing drain.

patch/v1/drains/{id}

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/drains/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

namestring
projects'some' | 'all'
projectIdsstring[] nullable
schemasobject
status'enabled' | 'disabled'

Response

OR

Changes

  • 4686ebfcdc1eRevision changes
    • breaking

      added subschema #1 subschema #2 to the response body oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body oneOf list for the response status

  • 0f7ea3d3b39bRevision changes
    • breaking

      added subschema #1 subschema #2 to the response body oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body oneOf list for the response status