> ## Documentation Index
> Fetch the complete documentation index at: https://ubicloud-00f14c0d-dependabot-github-actions-actions-checkou-0.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get available PostgreSQL provisioning options

> Returns a tree of valid option combinations for creating PostgreSQL databases, along with metadata describing each option value. The tree encodes dependency chains (e.g. which VM families are available per location, which storage sizes are valid per VM size).



## OpenAPI

````yaml /api-reference/openapi.yml get /project/{project_id}/postgres/capabilities
openapi: 3.0.3
info:
  description: API for managing resources on Ubicloud
  title: Clover API
  version: 0.1.0
  contact:
    url: https://www.ubicloud.com/
    email: support@ubicloud.com
  license:
    name: GNU Affero General Public License v3.0 (AGPL-3.0)
    url: https://www.gnu.org/licenses/agpl-3.0.en.html
servers:
  - url: https://api.ubicloud.com
security:
  - BearerAuth: []
tags:
  - description: Firewall Operations
    name: Firewall
  - description: Firewall Rule Operations
    name: Firewall Rule
  - description: Inference API Key Operations
    name: Inference Api Key
  - description: Inference Endpoint Operations
    name: Inference Endpoint
  - description: Load Balancer Operations
    name: Load Balancer
  - description: Login Operations
    name: Login
  - description: Machine Image Operations
    name: Machine Image
  - description: Postgres Database Operations
    name: Postgres Database
  - description: Postgres Firewall Rule Operations
    name: Postgres Firewall Rule
  - description: Postgres Metric Destination
    name: Postgres Metric Destination
  - description: Postgres Log Destination
    name: Postgres Log Destination
  - description: Private Subnet Operations
    name: Private Subnet
  - description: Project Operations
    name: Project
  - description: Virtual Machine Operations
    name: Virtual Machine
  - description: Private Location Operations
    name: Private Location
  - description: Kubernetes Cluster Operations
    name: Kubernetes Cluster
  - description: SSH Public Key Operations
    name: SSH Public Key
  - description: GitHub Operations
    name: GitHub
  - description: Audit Log Operations
    name: Audit Log
paths:
  /project/{project_id}/postgres/capabilities:
    parameters:
      - $ref: '#/components/parameters/project_id'
    get:
      tags:
        - Postgres Database
      summary: Get available PostgreSQL provisioning options
      description: >-
        Returns a tree of valid option combinations for creating PostgreSQL
        databases, along with metadata describing each option value. The tree
        encodes dependency chains (e.g. which VM families are available per
        location, which storage sizes are valid per VM size).
      operationId: getPostgresCapabilities
      responses:
        '200':
          description: PostgreSQL capabilities tree and metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostgresCapabilities'
        default:
          $ref: '#/components/responses/Error'
components:
  parameters:
    project_id:
      description: ID of the project
      in: path
      name: project_id
      required: true
      schema:
        type: string
        example: pjkkmx0f2vke4h36nk9cm8v8q0
        pattern: ^pj[0-9a-hj-km-np-tv-z]{24}$
  schemas:
    PostgresCapabilities:
      description: >-
        Tree of valid option combinations and metadata for each option value.
        The option_tree encodes parent-child dependencies: traverse from flavor
        -> location -> family -> size -> storage_size -> ha_type (with version
        branching from flavor). Only combinations present in the tree are valid
        for provisioning.
      type: object
      properties:
        option_tree:
          description: >-
            Nested object where each level maps option values to their valid
            children.
          type: object
          additionalProperties: true
        metadata:
          description: Display info for option values referenced in the tree
          type: object
          additionalProperties: false
          properties:
            flavor:
              type: object
              additionalProperties:
                type: object
                additionalProperties: false
                properties:
                  display_name:
                    type: string
                required:
                  - display_name
            location:
              type: object
              additionalProperties:
                type: object
                additionalProperties: false
                properties:
                  display_name:
                    type: string
                  ui_name:
                    type: string
                  provider:
                    type: string
                required:
                  - display_name
                  - ui_name
                  - provider
            family:
              type: object
              additionalProperties:
                type: object
                additionalProperties: false
                properties:
                  display_name:
                    type: string
                  category:
                    type: string
                required:
                  - display_name
                  - category
            size:
              type: object
              additionalProperties:
                type: object
                additionalProperties: false
                properties:
                  vcpu:
                    type: integer
                  memory_gib:
                    type: integer
                required:
                  - vcpu
                  - memory_gib
            ha_type:
              type: object
              additionalProperties:
                type: object
                additionalProperties: false
                properties:
                  display_name:
                    type: string
                  standby_count:
                    type: integer
                required:
                  - display_name
                  - standby_count
          required:
            - flavor
            - location
            - family
            - size
            - ha_type
      additionalProperties: false
      required:
        - option_tree
        - metadata
    Error:
      type: object
      properties:
        error:
          type: object
          additionalProperties: false
          properties:
            code:
              type: integer
              example: 401
            message:
              type: string
              example: There was an error logging in
            type:
              type: string
              example: InvalidCredentials
            details:
              type: object
              nullable: true
          required:
            - code
            - message
            - type
      additionalProperties: false
      required:
        - error
  responses:
    Error:
      description: An error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````