hosting

POST /api/v1/hosting/apps/{app_id}/deploys

Deploy a pre-built image. environment accepts a slug or public ID, all (the default), or existing. existing selects this service's placements in active environments with positive replica counts and enabled regions; it preserves their replica counts unless desired_instances overrides them and never creates a placement or restarts a drained placement. No eligible placements returns 422. Existing Git writer placements roll out sequentially in the background. rollout_predecessor queues a deployment until the named operation has completed successfully; failure or cancellation stops its followers.

Request

  • Base URL
    https://composal.com (the document declares no server; this is the origin it was published from)
  • URL
    https://composal.com/api/v1/hosting/apps/{app_id}/deploys
  • Auth
    HTTP bearer

Path parameters

app_idstring required

Request body

imagestring required
servicestring

Service slug or public ID; required unless app_service_id is supplied.

app_service_idstring
environmentstring

Environment slug or public ID, all, or existing.

app_environment_idstring
regionstring
desired_instancesinteger
commandstring
channelstring
source_refstring
commit_shastring
rollout_predecessorstring

Public deployment operation ID from the same app that must succeed before this rollout starts.

Response

Success

object required

Changes

No recorded changes to this operation across all 3 revisions of this API.