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 Projects & Environments API

Collections of services and other resources organized by environment (staging, production, etc.)

Render Projects & Environments 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 Projects & Environments. 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 12 operations across 5 paths, and defines 16 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.

12 operations 5 paths 16 schemas 3 DELETE4 GET2 PATCH3 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 Projects & Environments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 12

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

Projects & Environments 12

Collections of services and other resources organized by environment (staging, production, etc.)

GET
/projects
List projects
list-projects 8 params → 200400401404429500503
POST
/projects
Create project
create-project body → 201400401404429500503
GET
/projects/{projectId}
Retrieve Project
retrieve-project 1 param → 200400401404429500503
PATCH
/projects/{projectId}
Update project
update-project 1 param body → 200400401404429500503
DELETE
/projects/{projectId}
Delete project
delete-project 1 param → 204400401404429500503
POST
/environments
Create environment
create-environment body → 201400401404429500503
GET
/environments
List environments
list-environments 10 params → 200400401404429500503
GET
/environments/{environmentId}
Retrieve environment
retrieve-environment 1 param → 200400401404429500503
PATCH
/environments/{environmentId}
Update environment
update-environment 1 param body → 200400401404429500503
DELETE
/environments/{environmentId}
Delete environment
delete-environment 1 param → 204400401404429500503
POST
/environments/{environmentId}/resources
Add resources to environment
add-resources-to-environment 1 param body → 200400401404429500503
DELETE
/environments/{environmentId}/resources
Remove resources from environment
remove-resources-from-environment 2 params → 204400401404429500503

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are environment (10 properties), project (6 properties), owner (6 properties), environmentPOSTInput (5 properties). Each schema is shown below with its type and property counts.

projectPOSTInput
object
3 properties 3 required
project
object
A project is a collection of environments
6 properties 6 required
owner
object
6 properties 4 required
cursor
string
cidrBlockAndDescription
object
2 properties 2 required
projectPATCHInput
object
Input type for updating a project
1 property
environmentWithCursor
object
An environment with a cursor
2 properties 2 required
protectedStatus
string
Indicates whether an environment is unprotected or protected. Only admin users can perform destructive actions in protected environments.
environmentPATCHInput
object
4 properties
environmentPOSTInput
object
5 properties 2 required
networkIsolationEnabled
boolean
Indicates whether network connections across environments are allowed.
error
object
2 properties
projectPOSTEnvironmentInput
object
4 properties 1 required
environmentResourcesPOSTInput
object
1 property 1 required
projectWithCursor
object
2 properties 2 required
environment
object
10 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

render-projects-environments-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