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

[Postgres](https://render.com/docs/postgresql) endpoints enable you to interact with your Render Postgres databases.You can manage databases, exports, recoveries, and failovers.

Render Postgres 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 Postgres. 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 17 operations across 11 paths, and defines 21 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.

17 operations 11 paths 21 schemas 2 DELETE6 GET1 PATCH8 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 Postgres API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 17

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

Postgres 17

[Postgres](https://render.com/docs/postgresql) endpoints enable you to interact with your Render Postgres databases. You can manage databases, exports, recoveries, and failovers.

GET
/postgres
List Postgres instances
list-postgres 12 params → 200400401404409429500503
POST
/postgres
Create Postgres instance
create-postgres body → 201400401404429500503
GET
/postgres/{postgresId}
Retrieve Postgres instance
retrieve-postgres 1 param → 200400401404429500503
PATCH
/postgres/{postgresId}
Update Postgres instance
update-postgres 1 param body → 200400401404409429500503
DELETE
/postgres/{postgresId}
Delete Postgres instance
delete-postgres 1 param → 204400401404429500503
GET
/postgres/{postgresId}/connection-info
Retrieve Postgres connection info
retrieve-postgres-connection-info 1 param → 200400401404429500503
GET
/postgres/{postgresId}/recovery
Retrieve point-in-time recovery status
retrieve-postgres-recovery-info 1 param → 200400401404429500503
POST
/postgres/{postgresId}/recovery
Trigger point-in-time recovery
recover-postgres 1 param body → 200400401403404406410429
POST
/postgres/{postgresId}/suspend
Suspend Postgres instance
suspend-postgres 1 param → 202400401403404406410429
POST
/postgres/{postgresId}/resume
Resume Postgres instance
resume-postgres 1 param → 202400401403404406410429
POST
/postgres/{postgresId}/restart
Restart Postgres instance
restart-postgres 1 param → 202400401403404406410429
POST
/postgres/{postgresId}/failover
Failover Postgres instance
failover-postgres 1 param → 202400401403404406410429
GET
/postgres/{postgresId}/export
List Postgres exports
list-postgres-export 1 param → 200400401404429500503
POST
/postgres/{postgresId}/export
Create Postgres export
create-postgres-export 1 param → 202400401403404406410429
GET
/postgres/{postgresId}/credentials
List PostgreSQL Users
list-postgres-users 1 param → 200400401404429500503
POST
/postgres/{postgresId}/credentials
Create PostgreSQL User
create-postgres-user 1 param body → 202400401403404406410429
DELETE
/postgres/{postgresId}/credentials/{username}
Delete PostgreSQL User
delete-postgres-user 2 params → 200400401404429500503

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are postgresDetail (25 properties), postgres (23 properties), postgresPOSTInput (16 properties), redisDetail (13 properties). Each schema is shown below with its type and property counts.

databaseStatus
string
postgresConnectionInfo
object
4 properties 4 required
readReplicas
array
postgresDetail
object
25 properties 20 required
databaseRole
string
readReplicasInput
array
owner
object
6 properties 4 required
cursor
string
postgresPATCHInput
object
10 properties
readReplicaInput
object
2 properties 1 required
cidrBlockAndDescription
object
2 properties 2 required
postgres
object
23 properties 19 required
redisDetail
object
A Redis instance
13 properties 11 required
postgresWithCursor
object
2 properties 2 required
postgresParameterOverrides
object
region
string
Defaults to "oregon"
error
object
2 properties
postgresVersion
string
The PostgreSQL version
suspenderType
string
readReplica
object
3 properties 2 required
postgresPOSTInput
object
Input for creating a database
16 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

render-postgres-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