aliases

List aliases

Changed on

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.

get/v4/aliases

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v4/aliases
  • Auth: HTTP bearer

Query parameters

string[]
OR
string
fromnumber

Get only aliases created after the provided timestamp

Example:1540095775951
limitnumber

Maximum number of aliases to list from a request

Example:10
projectIdstring

Filter aliases from the given projectId

Example:prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB
sincenumber

Get aliases created after this JavaScript timestamp

Example:1540095775941
untilnumber

Get aliases created before this JavaScript timestamp

Example:1540095775951
rollbackDeploymentIdstring

Get aliases that would be rolled back for the given deployment

Example:dpl_XXX
teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

The paginated list of aliases

Example response

{
  "aliases": [
    {
      "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",
        "url": "my-instant-deployment-3ij3cxz9qr.now.sh"
      },
      "deploymentId": "dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx",
      "projectId": "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
      "updatedAt": 1540095775941
    }
  ],
  "pagination": {
    "count": 20,
    "next": 1540095775951,
    "prev": 1540095775951
  }
}

Changes

  • b7b824605094Revision changes
    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

  • 2ae10ee9d21cRevision changes
    • info

      added the non-success response with the status