canceldeploymentresponsebody.md

CancelDeploymentResponseBody

The private deployment representation of a Deployment.

Example Usage

import { CancelDeploymentResponseBody } from "@vercel/sdk/models/canceldeploymentop.js";

let value: CancelDeploymentResponseBody = {
  build: {
    env: [
      "<value>",
    ],
  },
  env: [
    "<value>",
  ],
  inspectorUrl: "https://tough-schnitzel.info/",
  isInConcurrentBuildsQueue: false,
  isInSystemBuildsQueue: false,
  projectSettings: {},
  aliasAssigned: false,
  bootedAt: 7652.95,
  buildingAt: 7318.56,
  buildSkipped: false,
  creator: {
    uid: "<id>",
  },
  public: false,
  status: "CANCELED",
  id: "<id>",
  createdAt: 779.91,
  name: "<value>",
  meta: {
    "key": "<value>",
  },
  readyState: "ERROR",
  regions: [
    "<value>",
  ],
  type: "LAMBDAS",
  url: "https://majestic-step.net/",
  version: 6840.28,
  createdIn: "<value>",
  ownerId: "<id>",
  plan: "pro",
  projectId: "<id>",
  routes: [
    {
      src: "<value>",
      continue: false,
      middleware: 3006.32,
    },
  ],
};

Fields

Field	Type	Required	Description
aliasAssignedAt	models.CancelDeploymentAliasAssignedAt	➖	N/A
alwaysRefuseToBuild	boolean	➖	N/A
build	models.CancelDeploymentBuild	✔️	N/A
buildArtifactUrls	string[]	➖	N/A
builds	models.CancelDeploymentBuilds[]	➖	N/A
env	string[]	✔️	N/A
inspectorUrl	string	✔️	N/A
isInConcurrentBuildsQueue	boolean	✔️	N/A
isInSystemBuildsQueue	boolean	✔️	N/A
projectSettings	models.CancelDeploymentProjectSettings	✔️	N/A
readyStateReason	string	➖	N/A
integrations	models.CancelDeploymentIntegrations	➖	N/A
images	models.CancelDeploymentImages	➖	N/A
alias	string[]	➖	N/A
aliasAssigned	boolean	✔️	N/A
bootedAt	number	✔️	N/A
buildingAt	number	✔️	N/A
buildSkipped	boolean	✔️	N/A
creator	models.CancelDeploymentCreator	✔️	N/A
initReadyAt	number	➖	N/A
isFirstBranchDeployment	boolean	➖	N/A
lambdas	models.CancelDeploymentLambdas[]	➖	N/A
public	boolean	✔️	N/A
ready	number	➖	N/A
status	models.CancelDeploymentStatus	✔️	N/A
team	models.CancelDeploymentTeam	➖	N/A
userAliases	string[]	➖	N/A
previewCommentsEnabled	boolean	➖	N/A
ttyBuildLogs	boolean	➖	N/A
customEnvironment	models.CancelDeploymentCustomEnvironment	➖	N/A
id	string	✔️	N/A
aliasError	models.CancelDeploymentAliasError	➖	N/A
aliasFinal	string	➖	N/A
aliasWarning	models.CancelDeploymentAliasWarning	➖	N/A
autoAssignCustomDomains	boolean	➖	applies to custom domains only, defaults to true
automaticAliases	string[]	➖	N/A
buildErrorAt	number	➖	N/A
checksState	models.CancelDeploymentChecksState	➖	N/A
checksConclusion	models.CancelDeploymentChecksConclusion	➖	N/A
createdAt	number	✔️	N/A
deletedAt	number	➖	N/A
defaultRoute	string	➖	Computed field that is only available for deployments with a microfrontend configuration.
canceledAt	number	➖	N/A
errorCode	string	➖	N/A
errorLink	string	➖	N/A
errorMessage	string	➖	N/A
errorStep	string	➖	N/A
passiveRegions	string[]	➖	Since November 2023 this field defines a set of regions that we will deploy the lambda to passively Lambdas will be deployed to these regions but only invoked if all of the primary regions are marked as out of service
gitSource	models.CancelDeploymentGitSource	➖	N/A
name	string	✔️	N/A
meta	Record<string, string>	✔️	N/A
originCacheRegion	string	➖	N/A
project	models.CancelDeploymentProject	➖	N/A
readyState	models.CancelDeploymentReadyState	✔️	N/A
readySubstate	models.CancelDeploymentReadySubstate	➖	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 having production traffic gradually transitioned. - PROMOTED: has seen production traffic
regions	string[]	✔️	N/A
softDeletedByRetention	boolean	➖	N/A
source	models.CancelDeploymentSource	➖	N/A
target	models.CancelDeploymentTarget	➖	N/A
type	models.CancelDeploymentType	✔️	N/A
undeletedAt	number	➖	N/A
url	string	✔️	N/A
version	number	✔️	N/A
oidcTokenClaims	models.CancelDeploymentOidcTokenClaims	➖	N/A
connectBuildsEnabled	boolean	➖	N/A
connectConfigurationId	string	➖	N/A
createdIn	string	✔️	N/A
crons	models.CancelDeploymentCrons[]	➖	N/A
functions	Record<string, models.CancelDeploymentFunctions>	➖	N/A
monorepoManager	string	➖	N/A
ownerId	string	✔️	N/A
passiveConnectConfigurationId	string	➖	Since November 2023 this field defines a Secure Compute network that will only be used to deploy passive lambdas to (as in passiveRegions)
plan	models.CancelDeploymentPlan	✔️	N/A
projectId	string	✔️	N/A
routes	models.CancelDeploymentRoutes[]	✔️	N/A
gitRepo	models.CancelDeploymentGitRepo	➖	N/A
flags	models.CancelDeploymentFlags	➖	N/A
microfrontends	models.CancelDeploymentMicrofrontends	➖	N/A
config	models.CancelDeploymentConfig	➖	Since February 2025 the configuration must include snapshot data at the time of deployment creation to capture properties for the /deployments/:id/config endpoint utilized for displaying Deployment Configuration on the frontend This is optional because older deployments may not have this data captured