---
title: "Get PostgreSQL configuration details"
method: GET
path: "/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/postgres-config"
tags: ["Branches"]
---

# Get PostgreSQL configuration details

`GET /organizations/{organizationID}/projects/{projectID}/branches/{branchID}/postgres-config`

## Request

- Base URL: `https://api.xata.tech`
- URL: `https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/postgres-config`
- Auth: OAuth 2
  - Implicit: `https://auth.xata.io/realms/xata/protocol/openid-connect/auth`
  - Scopes: `branch:read`

Retrieves detailed information about the current PostgreSQL configuration parameters for a branch, including parameter types, descriptions, acceptable ranges, default values, and current values.

## Path parameters

- `organizationID` string, required
- `projectID` string, required
- `branchID` string, required

## Response `200`

PostgreSQL configuration details retrieved successfully

- PostgresConfigDetails: Detailed information about PostgreSQL configuration parameters for a branch
  - `parameters` PostgresConfigParameter[], required: Array of PostgreSQL configuration parameters with detailed information
    - `name` string, required: The name of the PostgreSQL parameter
    - `type` 'string' | 'int' | 'float' | 'bytes' | 'enum' | 'duration' | 'boolean', required: The data type of the parameter
    - `description` string, required: Human-readable description of what the parameter controls
    - `section` string, required: The section/category this parameter belongs to
    - `acceptableRange` object: Information about the acceptable range of values for this parameter
      - `minValue` string: Minimum allowed value (if applicable)
      - `maxValue` string: Maximum allowed value (if applicable)
      - `enumValues` string[]: List of allowed enum values (if applicable)
    - `defaultValue` string, required: The default value for this parameter
    - `defaultValueSource` 'postgres' | 'instance_type', required: The source of the default value
    - `currentValue` string, required: The current value of this parameter in the branch
    - `documentationLink` string, required: Link to PostgreSQL documentation for this parameter
    - `recommendation` string, required: Optional recommendation for this parameter (currently empty)
    - `restartRequired` boolean: Whether a database restart is required for this parameter change to take effect

## Other responses

- `400`: Generic error response for most error conditions
- `401`: Error response when authentication or authorization fails
- `404`: Generic error response for most error conditions
- `5XX`: Unexpected Error
- `default`: Unexpected Error

---

[API](https://skmtc.dev/xataio/apis/xata-api.md) - [All operations](https://skmtc.dev/xataio/apis/xata-api/llms.txt) - [OpenAPI document](https://skmtc.dev/xataio/apis/xata-api/revisions/4bc5ad58a6c6?raw)