Update Postgres parameters on a database
PATCH
/databases/{id}/settings
const url = 'https://example.com/databases/example/settings';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"backupCompression":"gzip","parameters":{"additionalProperty":"example"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://example.com/databases/example/settings \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "backupCompression": "gzip", "parameters": { "additionalProperty": "example" } }'Auth: authenticated (scope: deploy)
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Request Body
Section titled “Request Body”Media typeapplication/json
object
backupCompression
Null restores automatic selection based on the memory limit.
string | null
parameters
required
Values are applied as given and never clamped. Omit a key (or send it empty) to hand it back to automatic sizing.
object
key
additional properties
string
Responses
Section titled “Responses”OK
Media typeapplication/json
object
advisories
Warnings about the values that were just applied. Never a rejection.
Array<object>
object
key
required
string
message
required
string
backupCompression
string | null
parameters
required
object
key
additional properties
string
success
required
boolean
key
additional properties
Example generated
{ "advisories": [ { "key": "example", "message": "example" } ], "backupCompression": "example", "parameters": { "additionalProperty": "example" }, "success": true}