aliases

List Deployment Aliases

Changed on

Retrieves all Aliases for the Deployment with the given ID. The authenticated user or team must own the deployment.

get/v2/deployments/{id}/aliases

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v2/deployments/{id}/aliases
  • Auth: HTTP bearer

Path parameters

idstring required

The ID of the deployment the aliases should be listed for

Example:dpl_FjvFJncQHQcZMznrUm9EoB8sFuPa

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.

Response

The list of aliases assigned to the deployment

Example response

{
  "aliases": [
    {
      "alias": "my-alias.vercel.app",
      "created": "2017-04-26T23:00:34.232Z",
      "uid": "2WjyKQmM8ZnGcJsPWMrHRHrE"
    }
  ]
}

Changes

  • 2ae10ee9d21cRevision changes
    • info

      added the non-success response with the status

  • 50caddad4ae7Revision changes
    • info

      added the optional property ///// to the response with the status