Gets a list of aliases with status for the current promote

APIs & SDKs

GET/__remote/api.vercel.com/v1/projects/{projectId}/promote/aliases

Get a list of aliases related to the last promote request with their mapping status

Request

import { Edgenivo } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.projects.listPromoteAliases({
    projectId: "<id>",
    limit: 20,
    since: 1609499532000,
    until: 1612264332000,
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Response

"value"

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

projectIdstringRequired

Query parameters

limitnumberOptional

Maximum number of aliases to list from a request (max 100).

sincenumberOptional

Get aliases created after this epoch timestamp.

untilnumberOptional

Get aliases created before this epoch timestamp.

failedOnlybooleanOptional

Filter results down to aliases that failed to map to the requested deployment

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Success

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.

404Error

410Error

Request

import { Edgenivo } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.projects.listPromoteAliases({
    projectId: "<id>",
    limit: 20,
    since: 1609499532000,
    until: 1612264332000,
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Response

"value"

OpenAPI Specification