Update service

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

Update the service with the provided ID.

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.

Responses

Response body

object

string

required

autoDeploy

string

required

Defaults to yes

yes no

branch

string

buildFilter

object

paths

array of strings

required

paths*

ignoredPaths

array of strings

required

ignoredPaths*

createdAt

date-time

required

dashboardUrl

string

required

The URL to view the service in the Render Dashboard

environmentId

string

imagePath

string

name

string

required

notifyOnFail

string

required

default notify ignore

ownerId

string

required

registryCredential

object

string

required

name

string

required

repo

string

rootDir

string

required

slug

string

required

suspended

string

required

suspended not_suspended

suspenders

array of strings

required

suspenders*

type

string

required

static_site web_service private_service background_worker cron_job

updatedAt

date-time

required

serviceDetails

required

Language

Credentials

Bearer


xxxxxxxxxx
15
1
curl --request PATCH \
2
     --url https://api.render.com/v1/services/serviceId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "autoDeploy": "yes",
8
  "serviceDetails": {
9
    "pullRequestPreviewsEnabled": "no",
10
    "previews": {
11
      "generation": "off"
12
    }
13
  }
14
}
15
'


xxxxxxxxxx
46
}
1
{
2
  "id": "string",
3
  "autoDeploy": "yes",
4
  "branch": "string",
5
  "buildFilter": {
6
    "paths": [
7
      "string"
8
    ],
9
    "ignoredPaths": [
10
      "string"
11
    ]
12
  },
13
  "createdAt": "2025-04-01T07:53:55.294Z",
14
  "dashboardUrl": "string",
15
  "environmentId": "string",
16
  "imagePath": "string",
17
  "name": "string",
18
  "notifyOnFail": "default",
19
  "ownerId": "string",
20
  "registryCredential": {
21
    "id": "string",
22
    "name": "string"
23
  },
24
  "repo": "https://github.com/render-examples/flask-hello-world",
25
  "rootDir": "string",

200OK

400The request could not be understood by the server.

401Authorization information is missing or invalid.

402You must enter payment information to perform this request.

403You do not have permissions for the requested resource.

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.