Organization API: Organization deployments: Releases

Part of Organization deployments.

GET /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/releases

The deployment's releases, newest first, production and preview alike. A template has none.

POST /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/releases

Release: a deployment built from git builds git_ref (its branch when left out); an image deployment runs image_ref (its own when left out). A branch for an image deployment, or an image for one built from git, is refused with source_mismatch.

A release of another branch than the production branch is a preview, as a push of it is (environment says otherwise): it gets its own addresses and leaves production as it is, and is refused as a push's preview would be (previews_refused, 402 when the plan has none, 409 when previews are off).

application/json (required)

GET /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/releases/{release_uuid}

One release with each of its instances (instance_list). A release of another deployment answers 404.

POST /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/releases/{release_uuid}/cancel

Cancel a release still queued, building or deploying: its build stops and its instances are removed, and the release that serves goes on serving. One that has finished answers 409.

GET /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/releases/{release_uuid}/log

The end of the release's build log, secrets redacted as it was written. A release of an image has none.

POST /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/releases/{release_uuid}/promote

A new production release of a ready preview's build (its image, its static output or both), with nothing built again. The preview keeps serving at its own addresses. 409 not_preview for a production release: roll back to it instead.

POST /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/releases/{release_uuid}/rollback

A new release of this earlier ready release's build, with nothing built again: its files for a static site, its image for a web service, both for a hybrid site. A static site's release serves at once; for the others, the earlier release's instances that still have their servers are started again instead of placed. 409 output_not_stored for a release with static output made more than app.apps.static.RETENTION_DAYS ago, whose files may be gone (deploy its commit again instead), 409 not_rollbackable for a release that was never ready or holds nothing to serve, 409 already_current for the release that serves now.