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

[Blueprints](https://render.com/docs/infrastructure-as-code) allow you to define your resources in a `render.yaml` file and automatically sync changes to your Render services.The API gives control over how your Blueprints are used to create and manage resources.

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

6 operations 4 paths 4 schemas 1 DELETE3 GET1 PATCH1 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 Blueprints API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 6

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

Blueprints 6

[Blueprints](https://render.com/docs/infrastructure-as-code) allow you to define your resources in a render.yaml file and automatically sync changes to your Render services. The A…

GET
/blueprints
List Blueprints
list-blueprints 3 params → 200401403404406410429500
POST
/blueprints/validate
Validate Blueprint
validate-blueprint body → 200400401403429500
GET
/blueprints/{blueprintId}
Retrieve Blueprint
retrieve-blueprint 1 param → 200401403404406410429500
PATCH
/blueprints/{blueprintId}
Update Blueprint
update-blueprint 1 param body → 200401403404406410429500
DELETE
/blueprints/{blueprintId}
Disconnect Blueprint
disconnect-blueprint 1 param → 204401403404406410429500
GET
/blueprints/{blueprintId}/syncs
List Blueprint syncs
list-blueprint-syncs 3 params → 200401403404406410429500

Schemas 4

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

cursor
string
blueprintWithCursor
object
A Blueprint with a cursor
2 properties 2 required
syncWithCursor
object
A Blueprint sync with a cursor
2 properties 2 required
error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

render-blueprints-api-openapi.yml Raw ↑

Other APIs Render publishes across the network.

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