API Reference

Trigger deploy

post
https://api.render.com/v1/services//deploys

Trigger a deploy for the service with the provided ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the service

Body Params
string

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

string
enum
Defaults to 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.

Allowed:
string

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.

string

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.

string
enum
Defaults to build_and_deploy

Deployment mode controlling build and deploy behavior.

Defaults to build_and_deploy when not specified.

Validation: deployMode cannot be combined with buildId. deploy_only cannot be combined with commitId, imageUrl, or clearCache.

Allowed:
Responses

202

Queued

Updated 4 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago