Skip to content
Docs

List aliases

GET/__remote/api.vercel.com/v4/aliases
Retrieves a list of aliases for the authenticated User or Team. When domain is provided, only aliases for that domain will be returned. When projectId is provided, it will only return the given project aliases.
Request
import { Edgenivo } from "@vercel/sdk";


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


async function run() {
  const result = await vercel.aliases.listAliases({
    domain: "my-test-domain.com",
    from: 1540095775951,
    limit: 10,
    projectId: "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
    since: 1540095775941,
    until: 1540095775951,
    rollbackDeploymentId: "dpl_XXX",
    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",
      "createdAt": "1540095775941",
      "creator": {
        "email": "[email protected]",
        "uid": "96SnxkFiMyVKsK3pnoHfx3Hz",
        "username": "john-doe"
      },
      "deletedAt": "1540095775941",
      "deployment": {
        "id": "dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx",
        "meta": "[object Object]",
        "url": "my-instant-deployment-3ij3cxz9qr.now.sh"
      },
      "deploymentId": "dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx",
      "microfrontends": {
        "applications": [
          {
            "fallbackHost": "string",
            "projectId": "example_id"
          }
        ],
        "defaultApp": {
          "projectId": "example_id"
        }
      },
      "projectId": "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
      "protectionBypass": "value",
      "redirect": "string",
      "redirectStatusCode": "301",
      "uid": "example_id",
      "updatedAt": "1540095775941"
    }
  ],
  "pagination": {
    "count": "20",
    "next": "1540095775951",
    "prev": "1540095775951"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

domainanyOptional
Get only aliases of the given domain name
fromnumberOptionalDeprecated
Get only aliases created after the provided timestamp
limitnumberOptional
Maximum number of aliases to list from a request
projectIdstringOptional
Filter aliases from the given projectId
sincenumberOptional
Get aliases created after this JavaScript timestamp
untilnumberOptional
Get aliases created before this JavaScript timestamp
rollbackDeploymentIdstringOptional
Get aliases that would be rolled back for the given deployment
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200The paginated list of aliases
aliasesarrayRequired

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