API Reference

Update service

patch
https://api.render.com/v1/services/

Update the service with the provided ID.

400 with code: build_source_region_mismatch if buildSourceId names a git-backed
Build Source in a different region than the service.

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

Update service allows you to update the configuration details of service, such as start commands and branches.

Changes will not be deployed automatically. Instead you must call the deploy API to have changes pushed out to your service, irrespective of the autoDeploy option set on the service.

Path Params
string
required

The ID of the service

Body Params
string

The ID of the Build Source to link this service to. Cannot be combined with build-configuration changes or other serviceDetails fields, except startCommand. Linking to a Build Source with a native runtime requires a start command, either in this request or already set on the service. Linking to a Build Source with a Docker or image runtime rejects a start command. A git-backed Build Source must be in the same region as the service; otherwise the request is rejected with 400 and code: build_source_region_mismatch.

string
enum
Defaults to yes
deprecated

Deprecated: use autoDeployTrigger instead. You can't set both autoDeploy and autoDeployTrigger in the same request.

  • yes is equivalent to autoDeployTrigger: commit.
  • no is equivalent to autoDeployTrigger: off.
Allowed:
string
enum

Controls autodeploy behavior.

  • commit: Deploy each time a commit is pushed to the service's linked branch.
  • checksPass: Deploy each time a commit is pushed to the linked branch, but only after the commit's CI checks pass.
  • off: Disable autodeploys.
Allowed:
string
string
image
object
string
buildFilter
object
string
serviceDetails
Responses

Updated 5 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 5 months ago