VEvercel
drains

Retrieve a list of all Drains

Changed on

Allows to retrieve the list of Drains of the authenticated team.

get/v1/drains

Request

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

Query parameters

projectIdstring
includeMetadataboolean
includeDeliveryStatsboolean

Include deliveryStats with the delivery health of each drain over the last 24 hours. Ignored for teams without drain delivery metrics.

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.

Response

Changes

  • e93418e871dcRevision changes
    • info

      added the non-success response with the status

  • 4686ebfcdc1eRevision changes
    • breaking

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

    • info

      added the new optional query request parameter includeDeliveryStats

    • info

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