RErender
Postgres

Update Postgres instance

Changed on

Update a Postgres instance by ID.

patch/postgres/{postgresId}

Request

  • Base URL
    https://api.render.com/v1
  • Auth
    HTTP bearer

Path parameters

postgresIdstring required

Request body

namestring
planPlan (unresolved $ref)
diskSizeGBinteger

The number of gigabytes of disk space to allocate for the database

enableDiskAutoscalingboolean
connectionPoolstring

What connection pool to use (if any) out of 'pgbouncer' and 'none'

enableHighAvailabilityboolean
datadogAPIKeystring

The Datadog API key for the Datadog agent to monitor the database. Pass empty string to remove. Restarts Postgres on change.

datadogSitestring

Datadog region to use for monitoring the new database. Defaults to 'US1'.

Response

Updated

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
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'

Changes

  • 6ac5d3d47362Revision changes
    • breaking

      the / response's property type changed from no type to string for status

    • warning

      removed the request property

    • warning

      removed the request property //

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      added the new 0.1c-256mb enum value to the response property for the response status

    • warning

      added the new 0.5c-1g enum value to the response property for the response status

    • warning

      added the new 128c-1024g enum value to the response property for the response status

    • warning

      added the new 128c-512g enum value to the response property for the response status

    • warning

      added the new 16c-128g enum value to the response property for the response status

    • warning

      added the new 16c-64g enum value to the response property for the response status

    • warning

      added the new 1c-2g enum value to the response property for the response status

    • warning

      added the new 1c-4g enum value to the response property for the response status

    • warning

      added the new 2c-16g enum value to the response property for the response status

    • warning

      added the new 2c-4g enum value to the response property for the response status

    • warning

      added the new 2c-8g enum value to the response property for the response status

    • warning

      added the new 32c-128g enum value to the response property for the response status

    • warning

      added the new 32c-256g enum value to the response property for the response status

    • warning

      added the new 48c-192g enum value to the response property for the response status

    • warning

      added the new 48c-384g enum value to the response property for the response status

    • warning

      added the new 4c-16g enum value to the response property for the response status

    • warning

      added the new 4c-32g enum value to the response property for the response status

    • warning

      added the new 64c-256g enum value to the response property for the response status

    • warning

      added the new 64c-512g enum value to the response property for the response status

    • warning

      added the new 8c-32g enum value to the response property for the response status

    • warning

      added the new 8c-64g enum value to the response property for the response status

    • warning

      added the new 96c-384g enum value to the response property for the response status

    • warning

      added the new 96c-768g enum value to the response property for the response status

    • info

      added the new 0.1c-256mb enum value to the request property

    • info

      added the new 0.5c-1g enum value to the request property

    • info

      added the new 128c-1024g enum value to the request property

    • info

      added the new 128c-512g enum value to the request property

    • info

      added the new 16c-128g enum value to the request property

    • info

      added the new 16c-64g enum value to the request property

    • info

      added the new 1c-2g enum value to the request property

    • info

      added the new 1c-4g enum value to the request property

    • info

      added the new 2c-16g enum value to the request property

    • info

      added the new 2c-4g enum value to the request property

    • info

      added the new 2c-8g enum value to the request property

    • info

      added the new 32c-128g enum value to the request property

    • info

      added the new 32c-256g enum value to the request property

    • info

      added the new 48c-192g enum value to the request property

    • info

      added the new 48c-384g enum value to the request property

    • info

      added the new 4c-16g enum value to the request property

    • info

      added the new 4c-32g enum value to the request property

    • info

      added the new 64c-256g enum value to the request property

    • info

      added the new 64c-512g enum value to the request property

    • info

      added the new 8c-32g enum value to the request property

    • info

      added the new 8c-64g enum value to the request property

    • info

      added the new 96c-384g enum value to the request property

    • info

      added the new 96c-768g enum value to the request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the / response's property pattern ^mrn-[0-9a-z]{20}$ was added for the status