Postgres
Retrieve Postgres instance
Retrieve a Postgres instance by ID.
get/postgres/{postgresId}
Path parameters
postgresIdstring required
Response
Successful response
idstring required
createdAtstring date-time required
updatedAtstring date-time required
expiresAtstring date-time
The time at which the database will be expire. Applies to free tier databases only.
dashboardUrlstring required
The URL to view the Postgres instance in the Render Dashboard
databaseNamestring required
databaseUserstring required
environmentIdstring
highAvailabilityEnabledboolean required
maintenanceMaintenance — unresolved $ref
namestring required
planPlan required— unresolved $ref
diskSizeGBinteger
parameterOverridesPostgresParameterOverrides
primaryPostgresIDstring
region'frankfurt' | 'oregon' | 'ohio' | 'singapore' | 'virginia' required
Defaults to "oregon"
role'primary' | 'replica' required
status'creating' | 'available' | 'unavailable' | 'config_restart' | 'suspended' | 'maintenance_scheduled' | 'maintenance_in_progress' | 'recovery_failed' | 'recovery_in_progress' | 'unknown' | 'updating_instance' required
version'11' | '12' | '13' | '14' | '15' | '16' | '17' | '18' required
The PostgreSQL version
suspended'suspended' | 'not_suspended' required
suspendersSuspenderType[] required
diskAutoscalingEnabledboolean required
connectionPoolstring required
What connection pool to use (if any) out of 'pgbouncer' and 'none'