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 Deploys API

[Deploys](https://render.com/docs/deploys) are the process of updating your service with new code or configuration.These endpoints allow you to retrieve data on the deploys of your servicesas well as trigger new deploys and rollbacks. Most changes to your servicewill require a new deploy to take effect.To create and manage services, use the `Services` endpoints.

Render Deploys 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 Deploys. 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 5 operations across 4 paths, and defines 7 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.

5 operations 4 paths 7 schemas 2 GET3 POST

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 Deploys API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Deploys 5

[Deploys](https://render.com/docs/deploys) are the process of updating your service with new code or configuration. These endpoints allow you to retrieve data on the deploys of yo…

GET
/services/{serviceId}/deploys
List deploys
list-deploys 10 params → 200401403404406410429500
POST
/services/{serviceId}/deploys
Trigger deploy
create-deploy 1 param body → 201202400401404406409410
GET
/services/{serviceId}/deploys/{deployId}
Retrieve deploy
retrieve-deploy 2 params → 200401403404406410429500
POST
/services/{serviceId}/deploys/{deployId}/cancel
Cancel deploy
cancel-deploy 2 params → 200400401403404429500503
POST
/services/{serviceId}/rollback
Roll back deploy
rollback-deploy 1 param body → 201400401403404429500503

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are deploy (9 properties), error (2 properties), deployWithCursor (2 properties). Each schema is shown below with its type and property counts.

cursor
string
DeployMode
string
Controls deployment behavior when triggering a deploy. - deployonly: Deploy the last successful build without rebuilding (minimizes downtime) - buildanddeploy:…
deployList
array
deployWithCursor
object
2 properties
deployStatus
string
error
object
2 properties
deploy
object
9 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

render-deploys-api-openapi.yml Raw ↑

Other APIs Render publishes across the network.

Render Audit Logs API
Render Blueprints API
Render Custom Domains 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
Render One-Off Jobs API