Skip to content

Gets project's Postgres config

get/v1/projects/{ref}/config/database/postgres

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
"effective_cache_size": "lorem",
"logical_decoding_work_mem": "lorem",
"pg_stat_statements.max": 100,
"pg_net.batch_size": 0,
"autovacuum_max_workers": 1,
"autovacuum_work_mem": "lorem",
"cron.log_statement": true,
"log_autovacuum_min_duration": "444444444444444444444444444444444444444444444444444",
"log_checkpoints": true,
"log_connections": true,
"log_disconnections": true,
"log_duration": true,
"log_lock_waits": true,
"log_recovery_conflict_waits": true,
"log_replication_commands": true,
"log_startup_progress_interval": "444444444444444444444444444444444444444444444444444",
"log_temp_files": "lorem",
"maintenance_work_mem": "lorem",
"track_activity_query_size": "lorem",
"max_connections": 1,
"max_locks_per_transaction": 10,
"max_logical_replication_workers": 0,
"max_parallel_maintenance_workers": 0,
"max_parallel_workers": 0,
"max_parallel_workers_per_gather": 0,
"max_replication_slots": -9007199254740991,
"max_slot_wal_keep_size": "lorem",
"max_standby_archive_delay": "lorem",
"max_standby_streaming_delay": "lorem",
"max_sync_workers_per_subscription": 0,
"max_wal_size": "lorem",
"max_wal_senders": -9007199254740991,
"max_worker_processes": 0,
"session_replication_role": "origin",
"shared_buffers": "lorem",
"statement_timeout": "444444444444444444444444444444444444444444444444444",
"track_commit_timestamp": true,
"wal_keep_size": "lorem",
"wal_sender_timeout": "444444444444444444444444444444444444444444444444444",
"work_mem": "lorem",
"checkpoint_timeout": "444444444444444444444444444444444444444444444444444",
"hot_standby_feedback": true
}
{
"type": "object",
"properties": {
"effective_cache_size": {
"type": "string"
},
"logical_decoding_work_mem": {
"type": "string"
},
"pg_stat_statements.max": {
"type": "integer",
"minimum": 100,
"maximum": 45000
},
"pg_net.batch_size": {
"type": "integer",
"minimum": 0,
"maximum": 32767
},
"autovacuum_max_workers": {
"type": "integer",
"minimum": 1,
"maximum": 262143
},
"autovacuum_work_mem": {
"type": "string"
},
"cron.log_statement": {
"type": "boolean"
},
"log_autovacuum_min_duration": {
"type": "string",
"description": "Default unit: ms",
"pattern": "^(-?[0-9]+(?:\\.[0-9]+)?)(us|ms|s|min|h|d)?$"
},
"log_checkpoints": {
"type": "boolean"
},
"log_connections": {
"type": "boolean"
},
"log_disconnections": {
"type": "boolean"
},
"log_duration": {
"type": "boolean"
},
"log_lock_waits": {
"type": "boolean"
},
"log_recovery_conflict_waits": {
"type": "boolean"
},
"log_replication_commands": {
"type": "boolean"
},
"log_startup_progress_interval": {
"type": "string",
"description": "Default unit: ms",
"pattern": "^(-?[0-9]+(?:\\.[0-9]+)?)(us|ms|s|min|h|d)?$"
},
"log_temp_files": {
"type": "string"
},
"maintenance_work_mem": {
"type": "string"
},
"track_activity_query_size": {
"type": "string"
},
"max_connections": {
"type": "integer",
"minimum": 1,
"maximum": 262143
},
"max_locks_per_transaction": {
"type": "integer",
"minimum": 10,
"maximum": 2147483640
},
"max_logical_replication_workers": {
"type": "integer",
"minimum": 0,
"maximum": 262143
},
"max_parallel_maintenance_workers": {
"type": "integer",
"minimum": 0,
"maximum": 1024
},
"max_parallel_workers": {
"type": "integer",
"minimum": 0,
"maximum": 1024
},
"max_parallel_workers_per_gather": {
"type": "integer",
"minimum": 0,
"maximum": 1024
},
"max_replication_slots": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"max_slot_wal_keep_size": {
"type": "string"
},
"max_standby_archive_delay": {
"type": "string"
},
"max_standby_streaming_delay": {
"type": "string"
},
"max_sync_workers_per_subscription": {
"type": "integer",
"minimum": 0,
"maximum": 262143
},
"max_wal_size": {
"type": "string"
},
"max_wal_senders": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"max_worker_processes": {
"type": "integer",
"minimum": 0,
"maximum": 262143
},
"session_replication_role": {
"type": "string",
"enum": [
"origin",
"replica",
"local"
]
},
"shared_buffers": {
"type": "string"
},
"statement_timeout": {
"type": "string",
"description": "Default unit: ms",
"pattern": "^(-?[0-9]+(?:\\.[0-9]+)?)(us|ms|s|min|h|d)?$"
},
"track_commit_timestamp": {
"type": "boolean"
},
"wal_keep_size": {
"type": "string"
},
"wal_sender_timeout": {
"type": "string",
"description": "Default unit: ms",
"pattern": "^(-?[0-9]+(?:\\.[0-9]+)?)(us|ms|s|min|h|d)?$"
},
"work_mem": {
"type": "string"
},
"checkpoint_timeout": {
"type": "string",
"description": "Default unit: s",
"pattern": "^(-?[0-9]+(?:\\.[0-9]+)?)(us|ms|s|min|h|d)?$"
},
"hot_standby_feedback": {
"type": "boolean"
}
}
}