drains

Find a Drain by id

Changed on

Get the information for a specific Drain by passing the drain id in the URL.

get/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

includeDeliveryStatsboolean

Include deliveryStats with the delivery health of the drain over the last 24 hours.

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

createdAtnumber required
disabledAtnumber
disabledBystring
disabledReason'account-plan-downgrade' | 'disabled-by-admin' | 'disabled-by-owner' | 'feature-not-available' | 'limits-exceeded'
firstErrorTimestampnumber
idstring required
namestring required
ownerIdstring required
projectIdsstring[]
status'disabled' | 'enabled' | 'errored'
teamIdstring nullable
updatedAtnumber required

Changes

    • info

      added the non-success response with the status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the new optional query request parameter includeDeliveryStats

    • info

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status