Get an Alias | Vercel REST API

APIs & SDKs

Get an Alias

GEThttps://api.vercel.com/v4/aliases/{idOrAlias}

Retrieves an Alias for the given host name or alias ID.

https://api.vercel.com/v4/aliases/{idOrAlias}

const response = await fetch('https://api.vercel.com/v4/aliases/idOrAlias?from=123&projectId=string&since=123&until=123&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "alias": "my-alias.vercel.app",
  "created": "2017-04-26T23:00:34.232Z",
  "createdAt": "1540095775941",
  "creator": {
    "email": "john-doe@gmail.com",
    "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"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idOrAliasstringRequired

The alias or alias ID to be retrieved

Query parameters

fromnumberOptionalDeprecated

Get the alias only if it was created after the provided timestamp

projectIdstringOptional

Get the alias only if it is assigned to the provided project ID

sincenumberOptional

Get the alias only if it was created after this JavaScript timestamp

untilnumberOptional

Get the alias only if it was created before this JavaScript timestamp

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200The alias information

aliasstringRequired

The alias name, it could be a .vercel.app subdomain or a custom domain

createdstringRequired

The date when the alias was created

createdAtnumberOptional

The date when the alias was created in milliseconds since the UNIX epoch

creatorobjectOptional

Information of the user who created the alias

deletedAtnumberOptional

The date when the alias was deleted in milliseconds since the UNIX epoch

deploymentobjectOptional

A map with the deployment ID, URL and metadata

deploymentIdstringRequired

The deployment ID

microfrontendsobjectOptional

The microfrontends for the alias including the routing configuration

projectIdstringRequired

The unique identifier of the project

protectionBypassobjectOptional

The protection bypass for the alias

redirectstringOptional

Target destination domain for redirect when the alias is a redirect

redirectStatusCodenumberOptional

Status code to be used on redirect

uidstringRequired

The unique identifier of the alias

updatedAtnumberOptional

The date when the alias was updated in milliseconds since the UNIX epoch

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 alias was not found

410Error

Cross-link map: Get an Alias (/docs/rest-api/aliases/get-an-alias)

From the Vercel docs graph (built 2026-10-06T09:42:32.185Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

List aliases — GET /v4/aliases — Retrieves a list of aliases for the authenticated User or Team. When \domain\\ is provided, only alia
Assign an Alias — POST /v2/deployments/{id}/aliases — Creates a new alias for the deployment resolved from the given deployment or alias I
Delete an Alias — DELETE /v2/aliases/{aliasId} — Delete an Alias with the specified ID.
List Deployment Aliases — GET /v2/deployments/{id}/aliases — Retrieves all Aliases for the Deployment with the given ID. The authenticated user or
Gets a list of aliases with status for the current promote — GET /v1/projects/{projectId}/promote/aliases — Get a list of aliases related to the last promote request with their mapp

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v4/aliases/{idOrAlias}

const response = await fetch('https://api.vercel.com/v4/aliases/idOrAlias?from=123&projectId=string&since=123&until=123&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "alias": "my-alias.vercel.app",
  "created": "2017-04-26T23:00:34.232Z",
  "createdAt": "1540095775941",
  "creator": {
    "email": "john-doe@gmail.com",
    "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"
}

OpenAPI Specification