Skip to content

Latest commit

 

History

History
48 lines (42 loc) · 7.78 KB

getaliasresponsebody.md

File metadata and controls

48 lines (42 loc) · 7.78 KB

GetAliasResponseBody

The alias information

Example Usage

import { GetAliasResponseBody } from "@vercel/sdk/models/getaliasop.js";

let value: GetAliasResponseBody = {
  alias: "my-alias.vercel.app",
  created: new Date("2017-04-26T23:00:34.232Z"),
  createdAt: 1540095775941,
  creator: {
    uid: "96SnxkFiMyVKsK3pnoHfx3Hz",
    email: "[email protected]",
    username: "john-doe",
  },
  deletedAt: 1540095775941,
  deployment: {
    id: "dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx",
    url: "my-instant-deployment-3ij3cxz9qr.now.sh",
    meta: "{}",
  },
  deploymentId: "dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx",
  projectId: "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB",
  uid: "<id>",
  updatedAt: 1540095775941,
};

Fields

Field Type Required Description Example
alias string ✔️ The alias name, it could be a .vercel.app subdomain or a custom domain my-alias.vercel.app
created Date ✔️ The date when the alias was created 2017-04-26T23:00:34.232Z
createdAt number ➖ The date when the alias was created in milliseconds since the UNIX epoch 1540095775941
creator models.GetAliasCreator ➖ Information of the user who created the alias
deletedAt number ➖ The date when the alias was deleted in milliseconds since the UNIX epoch 1540095775941
deployment models.GetAliasDeployment ➖ A map with the deployment ID, URL and metadata
deploymentId string ✔️ The deployment ID dpl_5m8CQaRBm3FnWRW1od3wKTpaECPx
projectId string ✔️ The unique identifier of the project prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB
redirect string ➖ Target destination domain for redirect when the alias is a redirect
redirectStatusCode number ➖ Status code to be used on redirect
uid string ✔️ The unique identifier of the alias
updatedAt number ➖ The date when the alias was updated in milliseconds since the UNIX epoch 1540095775941
protectionBypass Record<string, models.GetAliasProtectionBypass> ➖ The protection bypass for the alias