Skip to main content
The Deployment API makes project versions available in runtime environments. A release identifies content, an environment supplies configuration, and a deployment connects the two.

​
Releases

A release records a version of project content. Its asset manifest describes the associated build assets and build progress. Source and branches are managed through the Projects API. A support application’s test and production environments can use the same release with different credentials and domains. Editing its source branch later does not by itself select another release for production.

​
Environments and deployments

An environment groups settings such as variables and domains. A deployment records the selected project, release, and environment; these identifiers are fixed after creation. Serving another release requires a new deployment. Creating a release, completing its build, and serving the application are separate stages. A deployment record identifies the intended version and destination. Runtime health and the application’s endpoint show whether it is available. Changing an environment variable changes configuration, not project source. For example, a support application can use a test service account in development and a production account in production while both environments serve the same release.

​
Servers and routing

A server runtime serves application routes and hosted agent services over time. Its deployment selects the project release and environment configuration used by that capacity. Project server operations manage servers for project environments. Account server operations manage account-owned servers and environment links, subject to ownership and project permissions. Internal interfaces are marked in the reference. Proxy metadata supports routing and access checks. Routing and authorization metadata have different freshness requirements; each endpoint defines its caching contract.

​
Investigating a deployment

The release ID identifies the content involved in an incident; the environment identifies its configuration. Both help explain why the same source behaves differently between test and production. The Observability API supplies logs, metrics, and traces. A successful deployment does not establish that a particular agent or task run completed; those results belong to the Execution API.

​
Get started

Deploy a project walks through creating a release, assigning it to an environment, and verifying the application.

​
API references