Skip to main content
POST
/
v2
/
deployments
/
{id}
/
aliases
assignAlias
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.aliases.assignAlias({
    id: "<id>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      alias: "my-alias.vercel.app",
      redirect: null,
    },
  });

  console.log(result);
}

run();
{
  "uid": "2WjyKQmM8ZnGcJsPWMrHRHrE",
  "alias": "my-alias.vercel.app",
  "created": "2017-04-26T23:00:34.232Z",
  "oldDeploymentId": "dpl_FjvFJncQHQcZMznrUm9EoB8sFuPa"
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
id
string
required

The ID of the deployment the aliases should be listed for

Example:

"dpl_FjvFJncQHQcZMznrUm9EoB8sFuPa"

Query Parameters

​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Body

application/json
​
alias
string

The alias we want to assign to the deployment defined in the URL

Example:

"my-alias.vercel.app"

​
redirect
string | null

The redirect property will take precedence over the deployment id from the URL and consists of a hostname (like test.com) to which the alias should redirect using status code 307

Example:

null

Response

The alias was successfully assigned to the deployment

​
uid
string
required

The unique identifier of the alias

Example:

"2WjyKQmM8ZnGcJsPWMrHRHrE"

​
alias
string
required

The assigned alias name

Example:

"my-alias.vercel.app"

​
created
string<date-time>
required

The date when the alias was created

Example:

"2017-04-26T23:00:34.232Z"

​
oldDeploymentId
string | null

The unique identifier of the previously aliased deployment, only received when the alias was used before

Example:

"dpl_FjvFJncQHQcZMznrUm9EoB8sFuPa"