Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Render Services API

[Services](https://render.com/docs/service-types) allow you to manage your web services, private services, background workers, cron jobs, and static sites.

Render Services API is one of 26 APIs that Render publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, and 3 JSON Schemas.

This API exposes 25 operations across 15 paths, and defines 76 schemas. It is described by OpenAPI 3.0.2, at version 1.0.0.

Requests are made against a single base URL, https://api.render.com/v1.

25 operations 15 paths 76 schemas 4 DELETE8 GET1 PATCH7 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.0.0
Base URL
https://api.render.com/v1
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Render Services API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 25

Across 15 paths, the API surfaces 25 operations — 4 DELETE, 8 GET, 1 PATCH, 7 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Services 25

[Services](https://render.com/docs/service-types) allow you to manage your web services, private services, background workers, cron jobs, and static sites.

GET
/services
List services
list-services 14 params → 200401406429500503
POST
/services
Create service
create-service body → 201400401402406409429500
GET
/services/{serviceId}
Retrieve service
retrieve-service 1 param → 200401403404406410429500
PATCH
/services/{serviceId}
Update service
update-service 1 param body → 200400401402403404406409
DELETE
/services/{serviceId}
Delete service
delete-service 1 param → 204401403404406410429500
POST
/services/{serviceId}/cache/purge
Purge Web Service Cache
purge-cache 1 param body → 202400401404406409410429
GET
/services/{serviceId}/env-vars
List environment variables
get-env-vars-for-service 3 params → 200401403404406410429500
PUT
/services/{serviceId}/env-vars
Update environment variables
update-env-vars-for-service 1 param body → 200400401403404406410429
GET
/services/{serviceId}/env-vars/{envVarKey}
Retrieve environment variable
retrieve-env-var 2 params → 200401403404406410429500
PUT
/services/{serviceId}/env-vars/{envVarKey}
Add or update environment variable
update-env-var 2 params body → 200400401403404406410429
DELETE
/services/{serviceId}/env-vars/{envVarKey}
Delete environment variable
delete-env-var 2 params → 204401403404406410429500
GET
/services/{serviceId}/secret-files
List secret files
list-secret-files-for-service 3 params → 200401403404406410429500
PUT
/services/{serviceId}/secret-files
Update secret files
update-secret-files-for-service 1 param body → 200400401403404406410429
GET
/services/{serviceId}/secret-files/{secretFileName}
Retrieve secret file
retrieve-secret-file 2 params → 200401403404406410429500
PUT
/services/{serviceId}/secret-files/{secretFileName}
Add or update secret file
add-or-update-secret-file 2 params body → 201400401403404406410429
DELETE
/services/{serviceId}/secret-files/{secretFileName}
Delete secret file
delete-secret-file 2 params → 204401403404406410429500
GET
/services/{serviceId}/events
List events
list-events 6 params → 200400401404429500503
POST
/services/{serviceId}/suspend
Suspend service
suspend-service 1 param → 202400401403404406410429
POST
/services/{serviceId}/resume
Resume service
resume-service 1 param → 202400401403404406410429
POST
/services/{serviceId}/restart
Restart service
restart-service 1 param → 200400401403404406410429
POST
/services/{serviceId}/scale
Scale instance count
scale-service 1 param body → 202400401403404406410429
PUT
/services/{serviceId}/autoscaling
Update autoscaling config
autoscale-service 1 param body → 200400401403404406410429
DELETE
/services/{serviceId}/autoscaling
Delete autoscaling config
delete-autoscaling-config 1 param → 204401403404406410429500
POST
/services/{serviceId}/preview
Create service preview (image-backed)
preview-service 1 param body → 200400401403404429500503
GET
/services/{serviceId}/instances
List instances
list-instances 1 param → 200401404429500503

Schemas 76

The contract defines 76 schemas that model the data the API accepts and returns. The most detailed are webServiceDetails (21 properties), service (20 properties), webServiceDetailsPOST (16 properties), privateServiceDetails (16 properties). Each schema is shown below with its type and property counts.

cronJobDetailsPATCH
object
4 properties
serviceEventWithCursor
object
A service event with a cursor
1 property 2 required
cache
object
1 property 1 required
webServiceDetails
object
21 properties 10 required
cidrBlockAndDescription
object
2 properties 2 required
serviceEnv
string
This field has been deprecated, runtime should be used in its place.
serviceDisk
object
3 properties 2 required
envVarInput
object
renderSubdomainPolicy
string
Controls whether render.com subdomains are available for the service
webServiceDetailsPOST
object
16 properties 1 required
envVarGenerateValue
object
1 property 1 required
suspenderType
string
previewInput
object
3 properties 1 required
maintenanceMode
object
2 properties 2 required
registryCredentialSummary
object
2 properties 2 required
previews
object
1 property
privateServiceDetails
object
16 properties 9 required
serviceWithCursor
object
2 properties 2 required
envSpecificDetailsPOST
serviceRuntime
string
Runtime
envVarKeyGenerateValue
object
2 properties 2 required
servicePOST
object
13 properties 3 required
registryCredential
object
5 properties 5 required
privateServiceDetailsPOST
object
12 properties 1 required
staticSiteDetailsPATCH
object
6 properties
error
object
2 properties
maxShutdownDelaySeconds
integer
The maximum amount of time (in seconds) that Render waits for your application process to exit gracefully after sending it a SIGTERM signal.
envVarValue
object
1 property 1 required
addUpdateEnvVarInput
object
paidPlan
string
Defaults to starter when creating a new database.
resource
object
2 properties 2 required
backgroundWorkerDetailsPOST
object
12 properties 1 required
secretFileWithCursor
object
2 properties 2 required
envVar
object
2 properties 2 required
serviceList
array
nativeEnvironmentDetailsPATCH
object
2 properties
nativeEnvironmentDetails
object
3 properties 2 required
secretFileInput
object
2 properties 2 required
servicePATCH
object
8 properties
headerInput
object
3 properties 3 required
envSpecificDetails
dockerDetailsPOST
object
4 properties
serverPort
object
2 properties 2 required
staticSiteDetailsPOST
object
8 properties
backgroundWorkerDetails
object
14 properties 7 required
secretFile
object
2 properties 2 required
autoDeploy
string
cronJobDetails
object
8 properties 7 required
dockerDetails
object
5 properties 3 required
notifySetting
string
serviceType
string
plan
string
The instance type to use. Note that base services on any paid instance type can't create preview instances with the free instance type.
envVarInputArray
array
dockerDetailsPATCH
object
4 properties
registryCredentialRegistry
string
The registry to use this credential with
cronJobDetailsPOST
object
6 properties 2 required
cursor
string
webServiceDetailsPATCH
object
12 properties
envVarWithCursor
object
2 properties 2 required
privateServiceDetailsPATCH
object
7 properties
serviceInstance
object
2 properties 2 required
backgroundWorkerDetailsPATCH
object
7 properties
region
string
Defaults to "oregon"
buildPlan
string
nativeEnvironmentDetailsPOST
object
Fields for native environment (runtime) services
2 properties 2 required
routeType
string
envSpecificDetailsPATCH
serviceAndDeploy
object
2 properties
service
object
20 properties 14 required
envVarKeyValue
object
2 properties 2 required
routePost
object
4 properties 3 required
image
object
3 properties 2 required
buildFilter
object
2 properties 2 required
pullRequestPreviewsEnabled
string
This field has been deprecated. previews.generation should be used in its place.
staticSiteDetails
object
9 properties 4 required
sshAddress
string
The SSH address for the service. Only present for services that have SSH enabled.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

render-services-api-openapi.yml Raw ↑

Other APIs Render publishes across the network.

Render Audit Logs API
Render Blueprints API
Render Custom Domains API
Render Deploys API
Render Disks API
Render Environment Groups API
Render Events API
Render Key Value API
Render Logs API
Render Maintenance API
Render Metrics API
Render Notification Settings API