Deployments

Example Usage

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

let value: Deployments = {
  createdAt: 6246.82,
  readyState: "CANCELED",
  uid: "dpl_2euZBFqxYdDMDG1jTrHFnNZ2eUVa",
  name: "docs",
  projectId: "<id>",
  url: "docs-9jaeg38me.vercel.app",
  created: 1609492210000,
  defaultRoute: "/docs",
  deleted: 1609492210000,
  undeleted: 1609492210000,
  softDeletedByRetention: true,
  source: "cli",
  state: "READY",
  type: "LAMBDAS",
  creator: {
    uid: "eLrCnEgbKhsHyfbiNR7E8496",
    email: "example@example.com",
    username: "johndoe",
    githubLogin: "johndoe",
    gitlabLogin: "johndoe",
  },
  target: "production",
  buildingAt: 1609492210000,
  ready: 1609492210000,
  inspectorUrl: "https://vercel.com/acme/nextjs/J1hXN00qjUeoYfpEEf7dnDtpSiVq",
  errorCode: "BUILD_FAILED",
  errorMessage:
    "The Deployment has been canceled because this project was not affected",
  oomReport: "out-of-memory",
};

Fields

Field	Type	Required	Description	Example
createdAt	number	:heavy_check_mark:	N/A
readyState	models.GetDeploymentsReadyState	:heavy_check_mark:	N/A
uid	string	:heavy_check_mark:	The unique identifier of the deployment.	dpl_2euZBFqxYdDMDG1jTrHFnNZ2eUVa
name	string	:heavy_check_mark:	The name of the deployment.	docs
projectId	string	:heavy_check_mark:	The project ID of the deployment
url	string	:heavy_check_mark:	The URL of the deployment.	docs-9jaeg38me.vercel.app
created	number	:heavy_check_mark:	Timestamp of when the deployment got created.	1609492210000
defaultRoute	string	:heavy_minus_sign:	The default route that should be used for screenshots and links if configured with microfrontends.	/docs
deleted	number	:heavy_minus_sign:	Timestamp of when the deployment got deleted.	1609492210000
undeleted	number	:heavy_minus_sign:	Timestamp of when the deployment was undeleted.	1609492210000
softDeletedByRetention	boolean	:heavy_minus_sign:	Optional flag to indicate if the deployment was soft deleted by retention policy.	true
source	models.GetDeploymentsSource	:heavy_minus_sign:	The source of the deployment.	cli
state	models.GetDeploymentsState	:heavy_minus_sign:	In which state is the deployment.	READY
type	models.GetDeploymentsType	:heavy_check_mark:	The type of the deployment.	LAMBDAS
creator	models.GetDeploymentsCreator	:heavy_check_mark:	Metadata information of the user who created the deployment.
meta	Record<string, string>	:heavy_minus_sign:	Metadata information from the Git provider.
target	models.GetDeploymentsTarget	:heavy_minus_sign:	On which environment has the deployment been deployed to.	production
aliasError	models.GetDeploymentsAliasError	:heavy_minus_sign:	An error object in case aliasing of the deployment failed.
aliasAssigned	models.GetDeploymentsAliasAssigned	:heavy_minus_sign:	N/A
buildingAt	number	:heavy_minus_sign:	Timestamp of when the deployment started building at.	1609492210000
ready	number	:heavy_minus_sign:	Timestamp of when the deployment got ready.	1609492210000
readySubstate	models.GetDeploymentsReadySubstate	:heavy_minus_sign:	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	:heavy_minus_sign:	State of all registered checks
checksConclusion	models.GetDeploymentsChecksConclusion	:heavy_minus_sign:	Conclusion for checks
checks	models.GetDeploymentsChecks	:heavy_minus_sign:	Detailed information about v2 deployment checks. Includes information about blocked workflows in the deployment lifecycle.
inspectorUrl	string	:heavy_check_mark:	Vercel URL to inspect the deployment.	https://vercel.com/acme/nextjs/J1hXN00qjUeoYfpEEf7dnDtpSiVq
errorCode	string	:heavy_minus_sign:	Error code when the deployment is in an error state.	BUILD_FAILED
errorMessage	string	:heavy_minus_sign:	Error message when the deployment is in an canceled or error state.	The Deployment has been canceled because this project was not affected
oomReport	models.GetDeploymentsOomReport	:heavy_minus_sign:	Indicates if the deployment encountered an out-of-memory error.	out-of-memory
isRollbackCandidate	boolean	:heavy_minus_sign:	Deployment can be used for instant rollback
prebuilt	boolean	:heavy_minus_sign:	N/A
manualProvisioning	models.GetDeploymentsManualProvisioning	:heavy_minus_sign:	N/A
projectSettings	models.GetDeploymentsProjectSettings	:heavy_minus_sign:	The project settings which was used for this deployment
connectBuildsEnabled	boolean	:heavy_minus_sign:	The flag saying if Secure Compute network is used for builds
connectConfigurationId	string	:heavy_minus_sign:	The ID of Secure Compute network used for this deployment
passiveConnectConfigurationId	string	:heavy_minus_sign:	The ID of Secure Compute network used for this deployment's passive functions
expiration	number	:heavy_minus_sign:	The expiration configured by the project retention policy
proposedExpiration	number	:heavy_minus_sign:	The expiration proposed to replace the existing expiration
platform	models.GetDeploymentsPlatform	:heavy_minus_sign:	Metadata about the source platform that triggered the deployment.
customEnvironment	models.GetDeploymentsCustomEnvironment	:heavy_minus_sign:	The custom environment used for this deployment, if any
seatBlock	models.GetDeploymentsSeatBlock	:heavy_minus_sign:	NSNB Blocked metadata
attribution	models.GetDeploymentsAttribution	:heavy_minus_sign:	Commit attribution metadata