Get PostgreSQL configuration details

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
    }
  ]
}

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

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

Show child attributes

parameters.name

string

required

The name of the PostgreSQL parameter

parameters.type

enum<string>

required

The data type of the parameter

Available options:

string,

int,

float,

bytes,

enum,

duration,

boolean

parameters.description

string

required

Human-readable description of what the parameter controls

parameters.section

string

required

The section/category this parameter belongs to

parameters.defaultValue

string

required

The default value for this parameter

parameters.defaultValueSource

enum<string>

required

The source of the default value

Available options:

postgres,

instance_type

parameters.currentValue

string

required

The current value of this parameter in the branch

parameters.documentationLink

string

required

Link to PostgreSQL documentation for this parameter

parameters.recommendation

string

required

Optional recommendation for this parameter (currently empty)

parameters.acceptableRange

object

Information about the acceptable range of values for this parameter

Show child attributes

parameters.acceptableRange.minValue

string

Minimum allowed value (if applicable)

parameters.acceptableRange.maxValue

string

Maximum allowed value (if applicable)

parameters.acceptableRange.enumValues

string[]

List of allowed enum values (if applicable)

parameters.restartRequired

boolean

Whether a database restart is required for this parameter change to take effect

Orb billing webhookEndpoint used by Orb to deliver billing-related webhook events. This endpoint is authenticated via Orb's HMAC signature headers, not via the normal API authentication.

⌘I

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
    }
  ]
}

API Reference

Authorizations

Path Parameters

Response