Trigger deploy

post

https://api.render.com/v1/services/{serviceId}/deploys

Trigger a deploy for the service with the provided ID.

Path Params

serviceId

string

required

The ID of the service

Body Params

clearCache

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:

commitId

string

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.

imageUrl

string

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

string

enum

Defaults to build_and_deploy

Deployment mode controlling build and deploy behavior.

Defaults to build_and_deploy when not specified.

Validation: deploy_mode cannot be combined with commitId or imageUrl or clearCache.

Allowed:

Responses

202

Queued

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created

400The request could not be understood by the server.

401Authorization information is missing or invalid.

404Unable to find the requested resource.

406Unable to generate preferred media types as specified by Accept request header.

409The current state of the resource conflicts with this request.

410The requested resource is no longer available.

429Rate limit has been surpassed.

500An unexpected server error has occurred.

503Server currently unavailable.