Skip to content

Gets project's supavisor config

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

OAuth scopes

  • database:read

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

  • database_pooling_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

[
{
"identifier": "lorem",
"database_type": "PRIMARY",
"is_using_scram_auth": true,
"db_user": "lorem",
"db_host": "lorem",
"db_port": -9007199254740991,
"db_name": "lorem",
"connection_string": "lorem",
"connectionString": "lorem",
"default_pool_size": -9007199254740991,
"max_client_conn": -9007199254740991,
"pool_mode": "transaction"
}
]
{
"type": "array",
"items": {
"type": "object",
"properties": {
"identifier": {
"type": "string"
},
"database_type": {
"type": "string",
"enum": [
"PRIMARY",
"READ_REPLICA"
]
},
"is_using_scram_auth": {
"type": "boolean"
},
"db_user": {
"type": "string"
},
"db_host": {
"type": "string"
},
"db_port": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"db_name": {
"type": "string"
},
"connection_string": {
"type": "string"
},
"connectionString": {
"type": "string",
"description": "Use connection_string instead"
},
"default_pool_size": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"nullable": true
},
"max_client_conn": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"nullable": true
},
"pool_mode": {
"type": "string",
"enum": [
"transaction",
"session"
]
}
},
"required": [
"identifier",
"database_type",
"is_using_scram_auth",
"db_user",
"db_host",
"db_port",
"db_name",
"connection_string",
"connectionString",
"default_pool_size",
"max_client_conn",
"pool_mode"
]
}
}