Skip to main content
GET
/
organizations
/
{organizationID}
/
projects
/
{projectID}
/
branches
/
{branchID}
/
postgres-config
Get PostgreSQL configuration details
curl --request GET \
  --url https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/postgres-config \
  --header 'Authorization: Bearer <token>'
{
  "parameters": [
    {
      "name": "<string>",
      "type": "string",
      "description": "<string>",
      "section": "<string>",
      "defaultValue": "<string>",
      "defaultValueSource": "postgres",
      "currentValue": "<string>",
      "documentationLink": "<string>",
      "recommendation": "<string>",
      "acceptableRange": {
        "minValue": "<string>",
        "maxValue": "<string>",
        "enumValues": [
          "<string>"
        ]
      },
      "restartRequired": true
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://xata.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
organizationID
string
required

Unique identifier of the organization containing the project

Pattern: [a-zA-Z0-9_-~:]+
​
projectID
string
required

Unique identifier of the project containing the branch

​
branchID
string
required

Unique identifier of the branch to retrieve PostgreSQL configuration for

Response

PostgreSQL configuration details retrieved successfully

Detailed information about PostgreSQL configuration parameters for a branch

​
parameters
object[]
required

Array of PostgreSQL configuration parameters with detailed information