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

Web services, static sites, private services, background workers, and cron jobs.

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

Tagged areas include Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 14 operations across 10 paths. It is described by OpenAPI 3.0.3, at version 1.0.

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

14 operations 10 paths 0 schemas 2 DELETE3 GET1 PATCH7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.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.

  • bearerAuth — Render API key created in the Render Dashboard, sent as an Authorization Bearer token.

Paths & Operations 14

Across 10 paths, the API surfaces 14 operations — 2 DELETE, 3 GET, 1 PATCH, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Services 14

Web services, static sites, private services, background workers, and cron jobs.

GET
/services
List services
listServices 2 params → 200401
POST
/services
Create a service
createService body → 201401429
GET
/services/{serviceId}
Retrieve a service
retrieveService 1 param → 200404
PATCH
/services/{serviceId}
Update a service
updateService 1 param body → 200
DELETE
/services/{serviceId}
Delete a service
deleteService 1 param → 204
POST
/services/{serviceId}/restart
Restart a service
restartService 1 param → 202
POST
/services/{serviceId}/suspend
Suspend a service
suspendService 1 param → 202
POST
/services/{serviceId}/resume
Resume a service
resumeService 1 param → 202
POST
/services/{serviceId}/scale
Scale a service
scaleService 1 param body → 202
PUT
/services/{serviceId}/autoscaling
Update autoscaling
updateAutoscaling 1 param body → 200
DELETE
/services/{serviceId}/autoscaling
Disable autoscaling
disableAutoscaling 1 param → 204
POST
/services/{serviceId}/cache/purge
Purge static site cache
purgeCache 1 param → 202
POST
/services/{serviceId}/preview
Create a service preview
createServicePreview 1 param body → 201
GET
/services/{serviceId}/events
List service events
listEvents 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

render-com-services-api-openapi.yml Raw ↑

Other APIs Render publishes across the network.

Render Blueprints API
Render Custom Domains API
Render Deploys API
Render Disks API
Render Environment Groups API
Render Environment Variables API
Render Environments API
Render Jobs API
Render Key Value API
Render Logs API
Render Metrics API
Render Postgres API