RErender
Deploys

Trigger deploy

Changed on

Trigger a deploy for the service with the provided ID.

post/services/{serviceId}/deploys

Request

  • Base URL
    https://api.render.com/v1
  • Auth
    HTTP bearer

Request body

buildIdstring

The ID of the build to deploy. Cannot be combined with commitId, imageUrl, or deployMode.

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. Cannot be combined with buildId, imageUrl, or deployMode: deploy_only.

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. Cannot be combined with buildId, commitId, or deployMode: deploy_only.

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: deployMode cannot be combined with buildId. deploy_only cannot be combined with commitId, imageUrl, or clearCache, as those are build related fields.

Response

Created

idstring required
buildIdstring

The ID of the build this deploy shipped. Only present for deploys of a build from a Build Source.

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

Changes

  • 6ac5d3d47362Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status