createdeploymentresponsebody.md

CreateDeploymentResponseBody

The successfully created deployment

Example Usage

import { CreateDeploymentResponseBody } from "@vercel/sdk/models/createdeploymentop.js";

let value: CreateDeploymentResponseBody = {
  build: {
    env: [
      "<value>",
    ],
  },
  env: [
    "<value>",
  ],
  inspectorUrl: "https://charming-cafe.biz",
  isInConcurrentBuildsQueue: false,
  isInSystemBuildsQueue: false,
  projectSettings: {},
  aliasAssigned: false,
  bootedAt: 1341.2,
  buildingAt: 9295.3,
  buildSkipped: false,
  creator: {
    uid: "<id>",
  },
  public: false,
  status: "BUILDING",
  type: "LAMBDAS",
  name: "<value>",
  createdAt: 8175.48,
  id: "<id>",
  version: 2714.37,
  meta: {
    "key": "<value>",
  },
  readyState: "QUEUED",
  regions: [
    "<value>",
  ],
  url: "https://feline-hexagon.com/",
  plan: "hobby",
  projectId: "<id>",
  ownerId: "<id>",
  routes: [
    {
      src: "<value>",
      continue: false,
      middleware: 7379.07,
    },
  ],
  createdIn: "<value>",
};

Fields

Field	Type	Required	Description
aliasAssignedAt	models.AliasAssignedAt	➖	N/A
alwaysRefuseToBuild	boolean	➖	N/A
build	models.Build	✔️	N/A
buildArtifactUrls	string[]	➖	N/A
builds	models.Builds[]	➖	N/A
env	string[]	✔️	N/A
inspectorUrl	string	✔️	N/A
isInConcurrentBuildsQueue	boolean	✔️	N/A
isInSystemBuildsQueue	boolean	✔️	N/A
projectSettings	models.CreateDeploymentProjectSettings	✔️	N/A
readyStateReason	string	➖	N/A
integrations	models.Integrations	➖	N/A
images	models.Images	➖	N/A
alias	string[]	➖	N/A
aliasAssigned	boolean	✔️	N/A
bootedAt	number	✔️	N/A
buildingAt	number	✔️	N/A
buildSkipped	boolean	✔️	N/A
creator	models.Creator	✔️	N/A
initReadyAt	number	➖	N/A
isFirstBranchDeployment	boolean	➖	N/A
lambdas	models.Lambdas[]	➖	N/A
public	boolean	✔️	N/A
ready	number	➖	N/A
status	models.CreateDeploymentStatus	✔️	N/A
team	models.CreateDeploymentTeam	➖	N/A
userAliases	string[]	➖	N/A
previewCommentsEnabled	boolean	➖	N/A
ttyBuildLogs	boolean	➖	N/A
customEnvironment	models.CustomEnvironment	➖	N/A
type	models.CreateDeploymentType	✔️	N/A
name	string	✔️	N/A
createdAt	number	✔️	N/A
deletedAt	number	➖	N/A
id	string	✔️	N/A
version	number	✔️	N/A
autoAssignCustomDomains	boolean	➖	applies to custom domains only, defaults to true
gitSource	models.CreateDeploymentGitSource	➖	N/A
meta	Record<string, string>	✔️	N/A
project	models.CreateDeploymentProject	➖	N/A
readyState	models.ReadyState	✔️	N/A
source	models.CreateDeploymentSource	➖	N/A
target	models.CreateDeploymentTarget	➖	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
regions	string[]	✔️	N/A
errorMessage	string	➖	N/A
aliasWarning	models.AliasWarning	➖	N/A
aliasError	models.AliasError	➖	N/A
aliasFinal	string	➖	N/A
automaticAliases	string[]	➖	N/A
buildErrorAt	number	➖	N/A
checksState	models.ChecksState	➖	N/A
checksConclusion	models.ChecksConclusion	➖	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
errorStep	string	➖	N/A
originCacheRegion	string	➖	N/A
readySubstate	models.ReadySubstate	➖	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
softDeletedByRetention	boolean	➖	N/A
undeletedAt	number	➖	N/A
url	string	✔️	N/A
oidcTokenClaims	models.OidcTokenClaims	➖	N/A
plan	models.CreateDeploymentPlan	✔️	N/A
projectId	string	✔️	N/A
ownerId	string	✔️	N/A
microfrontends	models.CreateDeploymentMicrofrontends	➖	N/A
monorepoManager	string	➖	N/A
config	models.Config	➖	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
functions	Record<string, models.Functions>	➖	N/A
routes	models.Routes[]	✔️	N/A
crons	models.CreateDeploymentCrons[]	➖	N/A
connectBuildsEnabled	boolean	➖	N/A
connectConfigurationId	string	➖	N/A
createdIn	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)
gitRepo	models.GitRepo	➖	N/A
flags	models.Flags	➖	N/A