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 Environment Groups API

Collections of environment variables and secret files that can be shared between multiple services

Render Environment Groups 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 Environment Groups. 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 13 operations across 5 paths, and defines 17 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.

13 operations 5 paths 17 schemas 4 DELETE4 GET1 PATCH2 POST2 PUT

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

Paths & Operations 13

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

Environment Groups 13

Collections of environment variables and secret files that can be shared between multiple services

GET
/env-groups
List environment groups
list-env-groups 9 params → 200400401404429500503
POST
/env-groups
Create environment group
create-env-group body → 201400401404429500503
GET
/env-groups/{envGroupId}
Retrieve environment group
retrieve-env-group 1 param → 200400401404429500503
PATCH
/env-groups/{envGroupId}
Update environment group
update-env-group 1 param body → 200400401404429500503
DELETE
/env-groups/{envGroupId}
Delete environment group
delete-env-group 1 param → 204400401404429500503
POST
/env-groups/{envGroupId}/services/{serviceId}
Link service
link-service-to-env-group 2 params → 200400401404429500503
DELETE
/env-groups/{envGroupId}/services/{serviceId}
Unlink service
unlink-service-from-env-group 2 params → 204400401404429500503
GET
/env-groups/{envGroupId}/env-vars/{envVarKey}
Retrieve environment variable
retrieve-env-group-env-var 2 params → 200400401404429500503
PUT
/env-groups/{envGroupId}/env-vars/{envVarKey}
Add or update environment variable
update-env-group-env-var 2 params body → 200400401404429500503
DELETE
/env-groups/{envGroupId}/env-vars/{envVarKey}
Remove environment variable
delete-env-group-env-var 2 params → 204400401404429500503
GET
/env-groups/{envGroupId}/secret-files/{secretFileName}
Retrieve secret file
retrieve-env-group-secret-file 2 params → 200400401404429500503
PUT
/env-groups/{envGroupId}/secret-files/{secretFileName}
Add or update secret file
update-env-group-secret-file 2 params body → 200400401404429500503
DELETE
/env-groups/{envGroupId}/secret-files/{secretFileName}
Remove secret file
delete-env-group-secret-file 2 params → 204400401404429500503

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are envGroupMeta (7 properties), envGroupPOSTInput (6 properties), envGroupLink (3 properties), error (2 properties). Each schema is shown below with its type and property counts.

envVarInputArray
array
secretFileInput
object
2 properties 2 required
envGroupMeta
object
7 properties 6 required
serviceTypeShort
string
envGroup
envVarKeyGenerateValue
object
2 properties 2 required
envGroupPATCHInput
object
1 property 1 required
secretFile
object
2 properties 2 required
envGroupLink
object
3 properties 3 required
envVarInput
object
error
object
2 properties
envVarGenerateValue
object
1 property 1 required
envVarValue
object
1 property 1 required
addUpdateEnvVarInput
object
envVarKeyValue
object
2 properties 2 required
envVar
object
2 properties 2 required
envGroupPOSTInput
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

render-environment-groups-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 Events API
Render Key Value API
Render Logs API
Render Maintenance API
Render Metrics API
Render Notification Settings API
Render One-Off Jobs API