/
RE
render
/
Render Public API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 2w ago · Updated 2w ago
View markdown
render
Render Public API
get
Retrieve service
v1
latest
OpenAPI 3.0.2
2026-07-26
207
170
320.9 KB
Audit Logs
2
Blueprints
6
Custom Domains
5
Dedicated IPs
5
Deploys
5
Disks
7
Environment Groups
13
Events
1
Key Value
8
Logs
10
Maintenance
4
Metrics
23
Notification Settings
5
One-Off Jobs
4
Postgres
21
Projects & Environments
12
Redis (Deprecated)
8
Registry Credentials
5
Services
25
get
List services
post
Create service
get
Retrieve service
delete
Delete service
patch
Update service
post
Purge Web Service Cache
get
List events
post
Suspend service
post
Resume service
post
Restart service
get
List instances
post
Scale instance count
put
Update autoscaling config
delete
Delete autoscaling config
post
Create service preview (image-backed)
get
List environment variables
put
Update environment variables
get
Retrieve environment variable
put
Add or update environment variable
delete
Delete environment variable
get
List secret files
put
Update secret files
get
Retrieve secret file
put
Add or update secret file
delete
Delete secret file
Services - Cron Jobs
2
Services - Headers
4
Services - Routes
5
Users
1
Webhooks
6
Workflow Tasks (Beta)
7
Workflows (Beta)
8
Workspaces
5
Services
Retrieve service
Retrieve the service with the provided ID.
get
/services/{serviceId}
Response
OK
Service
required
id
string
required
autoDeploy
'yes'
|
'no'
required
branch
string
buildFilter
BuildFilter
createdAt
string
date-time
required
dashboardUrl
string
required
The URL to view the service in the Render Dashboard
environmentId
string
imagePath
string
name
string
required
notifyOnFail
'default'
|
'notify'
|
'ignore'
required
ownerId
string
required
registryCredential
RegistryCredentialSummary
repo
string
rootDir
string
required
slug
string
required
suspended
'suspended'
|
'not_suspended'
required
suspenders
SuspenderType[]
required
type
'static_site'
|
'web_service'
|
'private_service'
|
'background_worker'
|
'cron_job'
required
updatedAt
string
date-time
required
serviceDetails
union
required