Sign in

v1

latestOpenAPI 3.0.22026-07-26207170320.9 KB
Deploys

Trigger deploy

Trigger a deploy for the service with the provided ID.

post/services/{serviceId}/deploys

Request body

clearCache'clear' | 'do_not_clear'

If clear, Render clears the service's build cache before deploying. This can be useful if you're experiencing issues with your build.

commitIdstring

The SHA of a specific Git commit to deploy for a service. Defaults to the latest commit on the service's connected branch.

Note that deploying a specific commit with this endpoint does not disable autodeploys for the service.

You can toggle autodeploys for your service with the Update service endpoint or in the Render Dashboard.

Not supported for cron jobs.

imageUrlstring

The URL of the image to deploy for an image-backed service.

The host, repository, and image name all must match the currently configured image for the service.

deployMode'deploy_only' | 'build_and_deploy'

Controls deployment behavior when triggering a deploy.

  • deploy_only: Deploy the last successful build without rebuilding (minimizes downtime)
  • build_and_deploy: Build new code and deploy it (default behavior when not specified)

Note: deploy_only cannot be combined with commitId, imageUrl or clearCache parameters, as those are build related fields.

Response

Created

idstring required
status'created' | 'queued' | 'build_in_progress' | 'update_in_progress' | 'live' | 'deactivated' | 'build_failed' | 'update_failed' | 'canceled' | 'pre_deploy_in_progress' | 'pre_deploy_failed'
trigger'api' | 'blueprint_sync' | 'deploy_hook' | 'deployed_by_render' | 'manual' | 'other' | 'new_commit' | 'rollback' | 'service_resumed' | 'service_updated'
startedAtstring date-time
finishedAtstring date-time
createdAtstring date-time
updatedAtstring date-time