Skip to content

Latest commit

 

History

History
136 lines (130 loc) · 68.8 KB

createdeploymentresponsebody.md

File metadata and controls

136 lines (130 loc) · 68.8 KB
Raw

CreateDeploymentResponseBody

The successfully created deployment

Example Usage

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

let value: CreateDeploymentResponseBody = {
  build: {
    env: [
      "<value>",
    ],
  },
  env: [
    "<value>",
  ],
  inspectorUrl: "https://mindless-dash.biz/",
  isInConcurrentBuildsQueue: false,
  isInSystemBuildsQueue: false,
  projectSettings: {},
  aliasAssigned: false,
  bootedAt: 7018.40,
  buildingAt: 301.93,
  buildSkipped: false,
  creator: {
    uid: "<id>",
  },
  public: false,
  status: "READY",
  type: "LAMBDAS",
  createdAt: 4444.79,
  name: "<value>",
  id: "<id>",
  version: 5023.93,
  meta: {
    "key": "<value>",
  },
  readyState: "BUILDING",
  regions: [
    "<value>",
  ],
  url: "https://grown-brief.biz",
  projectId: "<id>",
  ownerId: "<id>",
  routes: [
    {
      src: "<value>",
    },
  ],
  plan: "enterprise",
  createdIn: "<value>",
};

Fields

Field Type Required Description
aliasAssignedAt operations.AliasAssignedAt ➖ N/A
alwaysRefuseToBuild boolean ➖ N/A
build operations.Build ✔️ N/A
buildArtifactUrls string[] ➖ N/A
builds operations.Builds[] ➖ N/A
env string[] ✔️ N/A
inspectorUrl string ✔️ N/A
isInConcurrentBuildsQueue boolean ✔️ N/A
isInSystemBuildsQueue boolean ✔️ N/A
projectSettings operations.CreateDeploymentProjectSettings ✔️ N/A
readyStateReason string ➖ N/A
integrations operations.Integrations ➖ N/A
alias string[] ➖ N/A
aliasAssigned boolean ✔️ N/A
bootedAt number ✔️ N/A
buildingAt number ✔️ N/A
buildSkipped boolean ✔️ N/A
creator operations.Creator ✔️ N/A
initReadyAt number ➖ N/A
isFirstBranchDeployment boolean ➖ N/A
lambdas operations.Lambdas[] ➖ N/A
public boolean ✔️ N/A
ready number ➖ N/A
status operations.CreateDeploymentStatus ✔️ N/A
team operations.Team ➖ N/A
userAliases string[] ➖ N/A
previewCommentsEnabled boolean ➖ N/A
ttyBuildLogs boolean ➖ N/A
customEnvironment operations.CustomEnvironment ➖ N/A
type operations.CreateDeploymentType ✔️ N/A
createdAt number ✔️ N/A
name string ✔️ 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 operations.CreateDeploymentGitSource ➖ N/A
meta Record<string, string> ✔️ N/A
project operations.Project ➖ N/A
readyState operations.ReadyState ✔️ N/A
source operations.CreateDeploymentSource ➖ N/A
target operations.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 operations.AliasWarning ➖ N/A
aliasError operations.AliasError ➖ N/A
aliasFinal string ➖ N/A
automaticAliases string[] ➖ N/A
buildErrorAt number ➖ N/A
checksState operations.ChecksState ➖ N/A
checksConclusion operations.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
readySubstate operations.ReadySubstate ➖ Since June 2023 Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - PROMOTED: has seen production traffic
softDeletedByRetention boolean ➖ N/A
undeletedAt number ➖ N/A
url string ✔️ N/A
oidcTokenClaims operations.OidcTokenClaims ➖ N/A
projectId string ✔️ N/A
ownerId string ✔️ N/A
microfrontends operations.CreateDeploymentMicrofrontends ➖ N/A
monorepoManager string ➖ N/A
functions Record<string, operations.Functions> ➖ N/A
routes operations.Routes[] ✔️ N/A
crons operations.CreateDeploymentCrons[] ➖ N/A
plan operations.Plan ✔️ 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 operations.GitRepo ➖ N/A
flags operations.Flags ➖ N/A