Skip to content
Docs

List Deployment Aliases

GEThttps://api.vercel.com/v2/deployments/{id}/aliases
Retrieves all Aliases for the Deployment with the given ID. The authenticated user or team must own the deployment.
Request
import { Vercel } from "@vercel/sdk";


const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.aliases.listDeploymentAliases({
    id: "dpl_FjvFJncQHQcZMznrUm9EoB8sFuPa",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });


  console.log(result);
}


run();
Response
{
  "aliases": [
    {
      "alias": "my-alias.vercel.app",
      "created": "2017-04-26T23:00:34.232Z",
      "protectionBypass": "value",
      "redirect": "string",
      "uid": "2WjyKQmM8ZnGcJsPWMrHRHrE"
    }
  ]
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idstringRequired
The ID of the deployment the aliases should be listed for

Query parameters

teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200The list of aliases assigned to the deployment
aliasesarrayRequired
A list of the aliases assigned to the deployment

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404The deployment was not found
410Error