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

Build and release deploys for a service, plus rollback.

Render Deploys 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 Deploys. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 5 operations across 4 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.

5 operations 4 paths 0 schemas 2 GET3 POST

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

Build and release deploys for a service, plus rollback.

GET
/services/{serviceId}/deploys
List deploys
listDeploys 1 param → 200
POST
/services/{serviceId}/deploys
Trigger a deploy
createDeploy 1 param body → 201429
GET
/services/{serviceId}/deploys/{deployId}
Retrieve a deploy
retrieveDeploy 2 params → 200
POST
/services/{serviceId}/deploys/{deployId}/cancel
Cancel a deploy
cancelDeploy 2 params → 200
POST
/services/{serviceId}/rollback
Roll back a service
rollbackService 1 param body → 201

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Render publishes across the network.

Render Blueprints API
Render Custom Domains 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
Render Projects API