Authorizations
Default authentication mechanism
Path Parameters
The unique identifier or hostname of the deployment.
"dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ"
Query Parameters
Whether to add in gitRepo information.
"true"
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 deployment including only public information The deployment including both public and private information
- Option 1
- Option 2
The deployment including both public and private information
A boolean that will be true when the aliases from the alias property were assigned successfully
true
Information about the deployment creator
A boolean representing if the deployment is public or not. By default this is false
false
QUEUED, BUILDING, ERROR, INITIALIZING, READY, CANCELED A string holding the unique ID of the deployment
"dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ"
A number containing the date when the deployment was created in milliseconds
1540257589405
The state of the deployment depending on the process of deploying, or if it is ready or in an error state
QUEUED, BUILDING, ERROR, INITIALIZING, READY, CANCELED "READY"
The name of the project associated with the deployment at the time that the deployment was created
"my-project"
LAMBDAS The regions the deployment exists in
["sfo1"]A string with the unique URL of the deployment
"my-instant-deployment-3ij3cxz9qr.now.sh"
The platform version that was used to create the deployment.
2 2
pro, enterprise, hobby - Option 1
- Option 2
- Option 3
A list of all the aliases (default aliases, staging aliases and production aliases) that were assigned upon deployment creation
[]Since April 2025 it necessary for On-Demand Concurrency Minutes calculation
The team that owns the deployment if any
An array of domains that were provided by the user when creating the Deployment.
["sub1.example.com", "sub2.example.com"]Whether or not preview comments are enabled for the deployment
false
If the deployment was created using a Custom Environment, then this property contains information regarding the environment used.
- Option 1
- Option 2
out-of-memory An object that will contain a code and a message when the aliasing fails, otherwise the value will be null
null
applies to custom domains only, defaults to true
registered, running, completed succeeded, failed, skipped, canceled A number containing the date when the deployment was deleted at milliseconds
1540257589405
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
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
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 The public project information associated with the deployment.
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 flag to indicate if the deployment was deleted by retention policy
"true"
Where was the deployment created from
api-trigger-git-deploy, cli, clone/repo, git, import, import/repo, redeploy, v0-web "cli"
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.
staging, production null
A number containing the date when the deployment was undeleted at milliseconds
1540257589405
Since November 2023 this field defines a Secure Compute network that will only be used to deploy passive lambdas to (as in passiveRegions)
- Option 1
- Option 2
- Option 3
Flags defined in the Build Output API, used by this deployment. Primarily used by the Toolbar to know about the used flags.
- Option 1
- Option 2
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