Skip to content

Updates project's postgrest config

patch/v1/projects/{ref}/postgrest

OAuth scopes

  • rest:write

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

  • data_api_config_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • db_extra_search_path
    Optional
    string
  • db_schema
    Optional
    string
  • max_rows
    Optional
    integer
  • db_pool
    Optional
    integer
  • db_pool_acquisition_timeout
    Optional
    integer
  • db_pool_max_lifetime
    Optional
    integer
  • db_pool_max_idletime
    Optional
    integer

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
"db_schema": "lorem",
"max_rows": -9007199254740991,
"db_extra_search_path": "lorem",
"db_pool": -9007199254740991,
"db_pool_acquisition_timeout": -9007199254740991,
"db_pool_max_lifetime": 0,
"db_pool_max_idletime": 0
}
{
"type": "object",
"properties": {
"db_schema": {
"type": "string"
},
"max_rows": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"db_extra_search_path": {
"type": "string"
},
"db_pool": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "If `null`, the value is automatically configured based on compute size.",
"nullable": true
},
"db_pool_acquisition_timeout": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "If `null`, the value is automatically configured to 10.",
"nullable": true
},
"db_pool_max_lifetime": {
"type": "integer",
"minimum": 0,
"maximum": 3600,
"description": "If `null`, the value is automatically configured to 1800.",
"nullable": true
},
"db_pool_max_idletime": {
"type": "integer",
"minimum": 0,
"maximum": 60,
"description": "If `null`, the value is automatically configured to 30.",
"nullable": true
}
},
"required": [
"db_schema",
"max_rows",
"db_extra_search_path",
"db_pool",
"db_pool_acquisition_timeout",
"db_pool_max_lifetime",
"db_pool_max_idletime"
]
}