CancelDeploymentResponseBody

Returns the updated deployment object with readyState set to CANCELED. The build has been stopped and this action is irreversible.

Example Usage

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

let value: CancelDeploymentResponseBody = {
  build: {
    env: [
      "<value 1>",
    ],
  },
  env: [
    "<value 1>",
    "<value 2>",
    "<value 3>",
  ],
  inspectorUrl: "https://sniveling-rawhide.org/",
  isInConcurrentBuildsQueue: true,
  isInSystemBuildsQueue: true,
  projectSettings: {},
  alias: [],
  aliasAssigned: true,
  bootedAt: 2648.29,
  buildingAt: 4945.71,
  buildSkipped: false,
  creator: {
    uid: "96SnxkFiMyVKsK3pnoHfx3Hz",
    username: "john-doe",
  },
  public: false,
  status: "QUEUED",
  userAliases: [
    "sub1.example.com",
    "sub2.example.com",
  ],
  previewCommentsEnabled: false,
  id: "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ",
  target: null,
  readyState: "READY",
  aliasError: null,
  createdAt: 1540257589405,
  name: "my-project",
  type: "LAMBDAS",
  deletedAt: 1540257589405,
  meta: {
    "key": "<value>",
    "key1": "<value>",
  },
  regions: [
    "sfo1",
  ],
  softDeletedByRetention: true,
  source: "cli",
  undeletedAt: 1540257589405,
  url: "my-instant-deployment-3ij3cxz9qr.now.sh",
  userConfiguredDeploymentId: "abc123",
  version: 2,
  projectId: "<id>",
  plan: "pro",
  createdIn: "<value>",
  ownerId: "<id>",
  routes: [
    {
      src: "<value>",
      continue: true,
      middleware: 3028.54,
    },
  ],
};

Fields

Field	Type	Required	Description	Example
aliasAssignedAt	models.AliasAssignedAt	:heavy_minus_sign:	N/A
alwaysRefuseToBuild	boolean	:heavy_minus_sign:	N/A
build	models.Build	:heavy_check_mark:	N/A
buildArtifactUrls	string[]	:heavy_minus_sign:	N/A
builds	models.Builds[]	:heavy_minus_sign:	N/A
env	string[]	:heavy_check_mark:	N/A
resourceConfig	models.CancelDeploymentResourceConfig	:heavy_minus_sign:	N/A
inspectorUrl	string	:heavy_check_mark:	N/A
isInConcurrentBuildsQueue	boolean	:heavy_check_mark:	N/A
isInSystemBuildsQueue	boolean	:heavy_check_mark:	N/A
projectSettings	models.CancelDeploymentProjectSettings	:heavy_check_mark:	N/A
integrations	models.Integrations	:heavy_minus_sign:	N/A
images	models.Images	:heavy_minus_sign:	N/A
alias	string[]	:heavy_minus_sign:	A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation	[]
aliasAssigned	boolean	:heavy_check_mark:	A boolean that will be true when the aliases from the alias property were assigned successfully	true
bootedAt	number	:heavy_check_mark:	N/A
buildingAt	number	:heavy_check_mark:	N/A
buildContainerFinishedAt	number	:heavy_minus_sign:	Since April 2025 it necessary for On-Demand Concurrency Minutes calculation
buildSkipped	boolean	:heavy_check_mark:	N/A
creator	models.CancelDeploymentCreator	:heavy_check_mark:	Information about the deployment creator
initReadyAt	number	:heavy_minus_sign:	N/A
isFirstBranchDeployment	boolean	:heavy_minus_sign:	N/A
lambdas	models.Lambdas[]	:heavy_minus_sign:	N/A
public	boolean	:heavy_check_mark:	A boolean representing if the deployment is public or not. By default this is false	false
ready	number	:heavy_minus_sign:	N/A
status	models.CancelDeploymentStatus	:heavy_check_mark:	N/A
team	models.CancelDeploymentTeam	:heavy_minus_sign:	The team that owns the deployment if any
userAliases	string[]	:heavy_minus_sign:	An array of domains that were provided by the user when creating the Deployment.	[ "sub1.example.com", "sub2.example.com" ]
previewCommentsEnabled	boolean	:heavy_minus_sign:	Whether or not preview comments are enabled for the deployment	false
ttyBuildLogs	boolean	:heavy_minus_sign:	N/A
customEnvironment	models.CustomEnvironment	:heavy_minus_sign:	N/A
oomReport	models.OomReport	:heavy_minus_sign:	N/A
readyStateReason	string	:heavy_minus_sign:	N/A
id	string	:heavy_check_mark:	A string holding the unique ID of the deployment	dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ
target	models.CancelDeploymentTarget	:heavy_minus_sign:	If defined, either staging if a staging alias in the format <project>.<team>.now.sh was assigned upon creation, or production if the aliases from alias were assigned. null value indicates the "preview" deployment.	null
readyState	models.ReadyState	:heavy_check_mark:	The state of the deployment depending on the process of deploying, or if it is ready or in an error state	READY
aliasError	models.AliasError	:heavy_minus_sign:	An object that will contain a code and a message when the aliasing fails, otherwise the value will be null	null
aliasWarning	models.AliasWarning	:heavy_minus_sign:	N/A
errorCode	string	:heavy_minus_sign:	N/A
errorMessage	string	:heavy_minus_sign:	N/A
createdAt	number	:heavy_check_mark:	A number containing the date when the deployment was created in milliseconds	1540257589405
name	string	:heavy_check_mark:	The name of the project associated with the deployment at the time that the deployment was created	my-project
type	models.CancelDeploymentType	:heavy_check_mark:	N/A
aliasFinal	string	:heavy_minus_sign:	N/A
autoAssignCustomDomains	boolean	:heavy_minus_sign:	applies to custom domains only, defaults to true
automaticAliases	string[]	:heavy_minus_sign:	N/A
buildErrorAt	number	:heavy_minus_sign:	N/A
checksState	models.ChecksState	:heavy_minus_sign:	N/A
checksConclusion	models.ChecksConclusion	:heavy_minus_sign:	N/A
deletedAt	number	:heavy_minus_sign:	A number containing the date when the deployment was deleted at milliseconds	1540257589405
defaultRoute	string	:heavy_minus_sign:	Computed field that is only available for deployments with a microfrontend configuration.
canceledAt	number	:heavy_minus_sign:	N/A
errorLink	string	:heavy_minus_sign:	N/A
errorStep	string	:heavy_minus_sign:	N/A
passiveRegions	string[]	:heavy_minus_sign:	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	:heavy_minus_sign:	N/A
manualProvisioning	models.ManualProvisioning	:heavy_minus_sign:	Present when deployment was created with manual provisioning enabled, either explicitly or via the experimental BYOC git flow. The deployment stays in INITIALIZING until /continue is called.
meta	Record<string, string>	:heavy_check_mark:	N/A
originCacheRegion	string	:heavy_minus_sign:	N/A
nodeVersion	models.CancelDeploymentNodeVersion	:heavy_minus_sign:	If set it overrides the projectSettings.nodeVersion for this deployment.
project	models.CancelDeploymentProject	:heavy_minus_sign:	The public project information associated with the deployment.
prebuilt	boolean	:heavy_minus_sign:	N/A
readySubstate	models.ReadySubstate	: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 having production traffic gradually transitioned. - PROMOTED: has seen production traffic
regions	string[]	:heavy_check_mark:	The regions the deployment exists in	[ "sfo1" ]
softDeletedByRetention	boolean	:heavy_minus_sign:	flag to indicate if the deployment was deleted by retention policy	true
source	models.CancelDeploymentSource	:heavy_minus_sign:	Where was the deployment created from. Best-effort guess for metrics only — not authoritative; do not gate behavior on it.	cli
undeletedAt	number	:heavy_minus_sign:	A number containing the date when the deployment was undeleted at milliseconds	1540257589405
url	string	:heavy_check_mark:	A string with the unique URL of the deployment	my-instant-deployment-3ij3cxz9qr.now.sh
userConfiguredDeploymentId	string	:heavy_minus_sign:	Since January 2025 User-configured deployment ID for skew protection with pre-built deployments. This is set when users configure a custom deploymentId in their next.config.js file. This allows Next.js to use skew protection even when deployments are pre-built outside of Vercel's build system.	abc123
version	number	:heavy_check_mark:	The platform version that was used to create the deployment.	2
oidcTokenClaims	models.OidcTokenClaims	:heavy_minus_sign:	N/A
projectId	string	:heavy_check_mark:	N/A
plan	models.CancelDeploymentPlan	:heavy_check_mark:	N/A
connectBuildsEnabled	boolean	:heavy_minus_sign:	N/A
connectConfigurationId	string	:heavy_minus_sign:	N/A
createdIn	string	:heavy_check_mark:	N/A
crons	models.Crons[]	:heavy_minus_sign:	N/A
functions	Record<string, models.Functions>	:heavy_minus_sign:	N/A
monorepoManager	string	:heavy_minus_sign:	N/A
ownerId	string	:heavy_check_mark:	N/A
passiveConnectConfigurationId	string	:heavy_minus_sign:	Since November 2023 this field defines a Secure Compute network that will only be used to deploy passive lambdas to (as in passiveRegions)
routes	models.CancelDeploymentRoutes[]	:heavy_check_mark:	N/A
services	models.Services[]	:heavy_minus_sign:	Services detected during build from vercel.json experimentalServices or auto-detected from project structure. Used to inject service URLs as environment variables at runtime.
gitRepo	models.GitRepo	:heavy_minus_sign:	N/A
flags	models.Flags	:heavy_minus_sign:	N/A
microfrontends	models.CancelDeploymentMicrofrontends	:heavy_minus_sign:	N/A
platform	models.Platform	:heavy_minus_sign:	Metadata about the source platform that triggered the deployment. Allows us to map a deployment back to a platform (e.g. the chat that created it)
config	models.CancelDeploymentConfig	:heavy_minus_sign:	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
checks	models.CancelDeploymentChecks	:heavy_minus_sign:	N/A
seatBlock	models.SeatBlock	:heavy_minus_sign:	NSNB Blocked metadata
attribution	models.CancelDeploymentAttribution	:heavy_minus_sign:	Attribution metadata for the deployment, linking commit author to git and Vercel users. Only populated when the enable-deployment-attribution flag is enabled.