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

Managed Render Postgres instances.

Render Postgres API is one of 17 APIs that Render publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Postgres. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 13 operations across 10 paths. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.render.com/v1.

13 operations 10 paths 0 schemas 1 DELETE5 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.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.

  • bearerAuth — Render API key created in the Render Dashboard, sent as an Authorization Bearer token.

Paths & Operations 13

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

Postgres 13

Managed Render Postgres instances.

GET
/postgres
List Postgres instances
listPostgres → 200
POST
/postgres
Create a Postgres instance
createPostgres body → 201
GET
/postgres/{postgresId}
Retrieve a Postgres instance
retrievePostgres 1 param → 200
PATCH
/postgres/{postgresId}
Update a Postgres instance
updatePostgres 1 param body → 200
DELETE
/postgres/{postgresId}
Delete a Postgres instance
deletePostgres 1 param → 204
GET
/postgres/{postgresId}/connection-info
Retrieve Postgres connection info
retrievePostgresConnectionInfo 1 param → 200
POST
/postgres/{postgresId}/suspend
Suspend a Postgres instance
suspendPostgres 1 param → 202
POST
/postgres/{postgresId}/resume
Resume a Postgres instance
resumePostgres 1 param → 202
POST
/postgres/{postgresId}/export
Trigger a Postgres export
createPostgresExport 1 param → 201
GET
/postgres/{postgresId}/exports
List Postgres exports
listPostgresExports 1 param → 200
GET
/postgres/{postgresId}/recovery-info
Retrieve point-in-time recovery info
retrievePostgresRecoveryInfo 1 param → 200
POST
/postgres/{postgresId}/recovery
Trigger a point-in-time recovery
triggerPostgresRecovery 1 param body → 201
POST
/postgres/{postgresId}/failover
Trigger a Postgres failover
triggerPostgresFailover 1 param → 202

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

render-com-postgres-api-openapi.yml Raw ↑

Other APIs Render publishes across the network.

Render Blueprints API
Render Custom Domains API
Render Deploys API
Render Disks API
Render Environment Groups API
Render Environment Variables API
Render Environments API
Render Jobs API
Render Key Value API
Render Logs API
Render Metrics API
Render Projects API