Skip to content

Latest commit

 

History

History
71 lines (66 loc) · 45 KB

deployments.md

File metadata and controls

71 lines (66 loc) · 45 KB

Deployments

Example Usage

import { Deployments } from "@vercel/sdk/models/getdeploymentsop.js";

let value: Deployments = {
  uid: "dpl_2euZBFqxYdDMDG1jTrHFnNZ2eUVa",
  name: "docs",
  url: "docs-9jaeg38me.vercel.app",
  created: 1609492210000,
  defaultRoute: "/docs",
  deleted: 1609492210000,
  undeleted: 1609492210000,
  softDeletedByRetention: true,
  source: "cli",
  state: "READY",
  readyState: "READY",
  type: "LAMBDAS",
  creator: {
    uid: "eLrCnEgbKhsHyfbiNR7E8496",
    email: "[email protected]",
    username: "johndoe",
    githubLogin: "johndoe",
    gitlabLogin: "johndoe",
  },
  target: "production",
  createdAt: 1609492210000,
  buildingAt: 1609492210000,
  ready: 1609492210000,
  inspectorUrl: "https://vercel.com/acme/nextjs/J1hXN00qjUeoYfpEEf7dnDtpSiVq",
};

Fields

Field Type Required Description Example
uid string ✔️ The unique identifier of the deployment. dpl_2euZBFqxYdDMDG1jTrHFnNZ2eUVa
name string ✔️ The name of the deployment. docs
url string ✔️ The URL of the deployment. docs-9jaeg38me.vercel.app
created number ✔️ Timestamp of when the deployment got created. 1609492210000
defaultRoute string ➖ The default route that should be used for screenshots and links if configured with microfrontends. /docs
deleted number ➖ Timestamp of when the deployment got deleted. 1609492210000
undeleted number ➖ Timestamp of when the deployment was undeleted. 1609492210000
softDeletedByRetention boolean ➖ Optional flag to indicate if the deployment was soft deleted by retention policy. true
source models.GetDeploymentsSource ➖ The source of the deployment. cli
state models.GetDeploymentsState ➖ In which state is the deployment. READY
readyState models.GetDeploymentsReadyState ➖ In which state is the deployment. READY
type models.GetDeploymentsType ✔️ The type of the deployment. LAMBDAS
creator models.GetDeploymentsCreator ✔️ Metadata information of the user who created the deployment.
meta Record<string, string> ➖ Metadata information from the Git provider.
target models.GetDeploymentsTarget ➖ On which environment has the deployment been deployed to. production
aliasError models.GetDeploymentsAliasError ➖ An error object in case aliasing of the deployment failed.
aliasAssigned models.GetDeploymentsAliasAssigned ➖ N/A
createdAt number ➖ Timestamp of when the deployment got created. 1609492210000
buildingAt number ➖ Timestamp of when the deployment started building at. 1609492210000
ready number ➖ Timestamp of when the deployment got ready. 1609492210000
readySubstate models.GetDeploymentsReadySubstate ➖ Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - ROLLING: in the process of gradually transitioning production traffic - PROMOTED: has seen production traffic
checksState models.GetDeploymentsChecksState ➖ State of all registered checks
checksConclusion models.GetDeploymentsChecksConclusion ➖ Conclusion for checks
inspectorUrl string ✔️ Vercel URL to inspect the deployment. https://vercel.com/acme/nextjs/J1hXN00qjUeoYfpEEf7dnDtpSiVq
isRollbackCandidate boolean ➖ Deployment can be used for instant rollback
projectSettings models.GetDeploymentsProjectSettings ➖ The project settings which was used for this deployment
connectBuildsEnabled boolean ➖ The flag saying if Secure Compute network is used for builds
connectConfigurationId string ➖ The ID of Secure Compute network used for this deployment
passiveConnectConfigurationId string ➖ The ID of Secure Compute network used for this deployment's passive functions
expiration number ➖ The expiration configured by the project retention policy
proposedExpiration number ➖ The expiration proposed to replace the existing expiration
customEnvironment models.GetDeploymentsCustomEnvironment ➖ The custom environment used for this deployment, if any