latestOpenAPI 3.0.12026-08-10234260964.0 KB

6cc88fde6435

Deployment

Get an environment's deployment information

Retrieve the read-only configuration of an environment's deployment. The returned information is everything required to recreate a project's current deployment.

More specifically, the objects returned by this endpoint contain the configuration derived from the repository's YAML configuration file: .upsun/config.yaml.

Additionally, any values deriving from environment variables, the domains attached to a project, project access settings, etc. are included here.

This endpoint currently returns a list containing a single deployment configuration with an id of current. This may be subject to change in the future.

get/projects/{projectId}/environments/{environmentId}/deployments

Path parameters

projectIdstring required
environmentIdstring required

Response

idstring required

The identifier of Deployment

created_atstring date-time nullable

The creation date of the deployment

updated_atstring date-time nullable

The update date of the deployment

fingerprintstring

The fingerprint of the deployment

cluster_namestring required

The name of the cluster

deployment_targetstring required

The deployment target

enable_smtpboolean required

Whether to configure SMTP for this environment

restrict_robotsboolean required

Whether to restrict robots for this environment

servicesobject required

The services

routesobject required

The routes

webappsobject required

The Web applications

workersobject required

The workers

container_profilesobject required

The profiles of the containers