Get an Alias

v1.0.0

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

Input

{
  "type": "object",
  "properties": {
    "from": {
      "type": "number",
      "description": "Get the alias only if it was created after the provided timestamp"
    },
    "idOrAlias": {
      "type": "string",
      "description": "The alias or alias ID to be retrieved"
    },
    "projectId": {
      "type": "string",
      "description": "Get the alias only if it is assigned to the provided project ID"
    },
    "since": {
      "type": "number",
      "description": "Get the alias only if it was created after this JavaScript timestamp"
    },
    "teamId": {
      "type": "string"
    },
    "until": {
      "type": "number",
      "description": "Get the alias only if it was created before this JavaScript timestamp"
    }
  },
  "required": [
    "idOrAlias"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "alias",
    "created",
    "deploymentId",
    "projectId",
    "uid"
  ],
  "properties": {
    "alias": {
      "type": "string",
      "description": "The alias name, it could be a `.vercel.app` subdomain or a custom domain"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "The date when the alias was created"
    },
    "createdAt": {
      "type": "number",
      "description": "The date when the alias was created in milliseconds since the UNIX epoch"
    },
    "creator": {
      "type": "object",
      "description": "Information of the user who created the alias",
      "required": [
        "email",
        "uid",
        "username"
      ],
      "properties": {
        "email": {
          "type": "string",
          "description": "Email of the user who created the alias"
        },
        "uid": {
          "type": "string",
          "description": "ID of the user who created the alias"
        },
        "username": {
          "type": "string",
          "description": "Username of the user who created the alias"
        }
      }
    },
    "deletedAt": {
      "type": "number",
      "description": "The date when the alias was deleted in milliseconds since the UNIX epoch"
    },
    "deployment": {
      "type": "object",
      "description": "A map with the deployment ID, URL and metadata",
      "required": [
        "id",
        "url"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The deployment unique identifier"
        },
        "meta": {
          "type": "string",
          "description": "The deployment metadata"
        },
        "url": {
          "type": "string",
          "description": "The deployment unique URL"
        }
      }
    },
    "deploymentId": {
      "type": [
        "string",
        "null"
      ],
      "description": "The deployment ID"
    },
    "projectId": {
      "type": [
        "string",
        "null"
      ],
      "description": "The unique identifier of the project"
    },
    "protectionBypass": {
      "type": "object",
      "description": "Construct a type with a set of properties K of type T"
    },
    "redirect": {
      "type": [
        "string",
        "null"
      ],
      "description": "Target destination domain for redirect when the alias is a redirect"
    },
    "redirectStatusCode": {
      "type": [
        "number",
        "null"
      ],
      "description": "Status code to be used on redirect",
      "enum": [
        301,
        302,
        307,
        308
      ]
    },
    "uid": {
      "type": "string",
      "description": "The unique identifier of the alias"
    },
    "updatedAt": {
      "type": "number",
      "description": "The date when the alias was updated in milliseconds since the UNIX epoch"
    }
  }
}