Authorizations
Default authentication mechanism
Path Parameters
The unique identifier of the deployment.
"dpl_5WJWYSyB7BpgTj3EuwF37WMRBXBtPQ2iTMJHJBJyRfd"
Query Parameters
The Team identifier to perform the request on behalf of.
"team_1a2b3c4d5e6f7g8h9i0j1k2l"
The Team slug to perform the request on behalf of.
"my-team-url-slug"
Response
The private deployment representation of a Deployment.
BUILDING
, ERROR
, INITIALIZING
, QUEUED
, READY
, CANCELED
BUILDING
, ERROR
, INITIALIZING
, QUEUED
, READY
, CANCELED
LAMBDAS
2
pro
, enterprise
, hobby
Since April 2025 it necessary for On-Demand Concurrency Minutes calculation
Internal representation of a custom environment with all required properties
out-of-memory
applies to custom domains only, defaults to true
registered
, running
, completed
skipped
, succeeded
, failed
, canceled
Computed field that is only available for deployments with a microfrontend configuration.
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
If set it overrides the projectSettings.nodeVersion
for this deployment.
22.x
, 20.x
, 18.x
, 16.x
, 14.x
, 12.x
, 10.x
, 8.10.x
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
STAGED
, ROLLING
, PROMOTED
api-trigger-git-deploy
, cli
, clone/repo
, git
, import
, import/repo
, redeploy
, v0-web
staging
, production
Since November 2023 this field defines a Secure Compute network that will only be used to deploy passive lambdas to (as in passiveRegions)
Flags defined in the Build Output API, used by this deployment. Primarily used by the Toolbar to know about the used flags.
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