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 Key Value API

[Key Value](https://render.com/docs/key-value) allows you to interact with your Render Key Value instances.

Render Key Value 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 Key Value. 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 8 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.

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

Paths & Operations 8

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

Key Value 8

[Key Value](https://render.com/docs/key-value) allows you to interact with your Render Key Value instances.

GET
/key-value
List Key Value instances
list-key-value 10 params → 200400401404409429500503
POST
/key-value
Create Key Value instance
create-key-value body → 201400401404429500503
GET
/key-value/{keyValueId}
Retrieve Key Value instance
retrieve-key-value 1 param → 200400401404429500503
PATCH
/key-value/{keyValueId}
Update Key Value instance
update-key-value 1 param body → 200400401404409429500503
DELETE
/key-value/{keyValueId}
Delete Key Value instance
delete-key-value 1 param → 204400401404429500503
GET
/key-value/{keyValueId}/connection-info
Retrieve Key Value connection info
retrieve-key-value-connection-info 1 param → 200400401404429500503
POST
/key-value/{keyValueId}/suspend
Suspend Key Value instance
suspend-key-value 1 param → 202400401403404406410429
POST
/key-value/{keyValueId}/resume
Resume Key Value instance
resume-key-value 1 param → 202400401403404406410429

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are redisDetail (13 properties), keyValue (13 properties), keyValueDetail (13 properties), keyValuePOSTInput (7 properties). Each schema is shown below with its type and property counts.

databaseStatus
string
keyValueWithCursor
object
2 properties 2 required
maxmemoryPolicy
string
The eviction policy for the Key Value instance
owner
object
6 properties 4 required
cursor
string
redisDetail
object
A Redis instance
13 properties 11 required
cidrBlockAndDescription
object
2 properties 2 required
keyValue
object
A Key Value instance
13 properties 12 required
keyValueOptions
object
Options for a Key Value instance
1 property
region
string
Defaults to "oregon"
keyValuePlan
string
error
object
2 properties
keyValueConnectionInfo
object
A Key Value instance
3 properties 3 required
keyValuePOSTInput
object
Input type for creating a Key Value instance
7 properties 3 required
keyValuePATCHInput
object
Input type for updating a Key Value instance
4 properties
keyValueDetail
object
A Key Value instance
13 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

render-key-value-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 Logs API
Render Maintenance API
Render Metrics API
Render Notification Settings API
Render One-Off Jobs API