openapi: 3.2.0
info:
  title: Ubicloud Postgres Firewall Rule 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
  description: 'Operations tagged Postgres Firewall Rule across 2 of this provider''s published API definitions: ubicloud-openapi.yml, ubicloud-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.ubicloud.com
security:
- BearerAuth: []
tags:
- description: Postgres Firewall Rule Operations
  name: Postgres Firewall Rule
paths:
  /project/{project_id}/location/{location}/postgres/{postgres_database_reference}/firewall-rule:
    parameters:
    - $ref: '#/components/parameters/location'
    - $ref: '#/components/parameters/postgres_database_reference'
    - $ref: '#/components/parameters/project_id'
    get:
      operationId: listLocationPostgresFirewallRules
      summary: List PostgreSQL firewall rules
      responses:
        '200':
          $ref: '#/components/responses/PostgresFirewallRules'
        default:
          $ref: '#/components/responses/Error'
      tags:
      - Postgres Firewall Rule
    post:
      operationId: createLocationPostgresFirewallRule
      summary: Create a new PostgreSQL firewall rule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                cidr:
                  description: CIDR of the firewall rule
                  type: string
                description:
                  description: Description of the firewall rule
                  type:
                  - string
                  - 'null'
              additionalProperties: false
              required:
              - cidr
      responses:
        '200':
          $ref: '#/components/responses/PostgresFirewallRule'
        default:
          $ref: '#/components/responses/Error'
      tags:
      - Postgres Firewall Rule
    servers:
    - url: https://api.ubicloud.com
  /project/{project_id}/location/{location}/postgres/{postgres_database_reference}/firewall-rule/{firewall_rule_id}:
    parameters:
    - $ref: '#/components/parameters/project_id'
    - $ref: '#/components/parameters/location'
    - $ref: '#/components/parameters/postgres_database_reference'
    - $ref: '#/components/parameters/firewall_rule_id'
    patch:
      operationId: patchLocationPostgresFirewallRule
      summary: Update a PostgreSQL firewall rule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                cidr:
                  description: CIDR of the firewall rule
                  type:
                  - string
                  - 'null'
                description:
                  description: Description of the firewall rule
                  type:
                  - string
                  - 'null'
              additionalProperties: false
      responses:
        '200':
          $ref: '#/components/responses/PostgresFirewallRule'
        default:
          $ref: '#/components/responses/Error'
      tags:
      - Postgres Firewall Rule
    servers:
    - url: https://api.ubicloud.com
components:
  parameters:
    postgres_database_reference:
      description: Postgres database ID or name
      examples:
        id:
          value: pgn30gjk1d1e2jj34v9x0dq4rp
        name:
          value: postgres-database-name
      in: path
      name: postgres_database_reference
      required: true
      schema:
        $ref: '#/components/schemas/Reference'
    location:
      description: The Ubicloud location/region
      in: path
      name: location
      required: true
      schema:
        type: string
        example: eu-central-h1
    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}$
    firewall_rule_id:
      description: ID of the firewall rule
      in: path
      name: firewall_rule_id
      required: true
      schema:
        type: string
        example: fraz0q3vbrpa7pkg7zbmah9csn
        pattern: ^fr[0-9a-hj-km-np-tv-z]{24}$
  schemas:
    PostgresFirewallRule:
      type: object
      properties:
        cidr:
          description: CIDR of the firewall rule
          type: string
        description:
          description: Port information for the firewall rule
          type: string
        id:
          description: ID of the firewall rule
          type: string
          example: frmjgkgbktw62k53005jpx8tt7
          pattern: ^fr[0-9a-hj-km-np-tv-z]{24}$
        port:
          description: Port for the Postgres firewall rule
          type: integer
      additionalProperties: false
      required:
      - cidr
      - id
    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
              - 'null'
          required:
          - code
          - message
          - type
      additionalProperties: false
      required:
      - error
    Reference:
      description: Resource ID or name
      type: string
      pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
  responses:
    Error:
      description: An error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    PostgresFirewallRule:
      description: A Postgres Firewall Rule
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PostgresFirewallRule'
    PostgresFirewallRules:
      description: A list of Postgres Firewall Rules
      content:
        application/json:
          schema:
            type: object
            properties:
              count:
                type: integer
              items:
                type: array
                items:
                  $ref: '#/components/schemas/PostgresFirewallRule'
            additionalProperties: false
            required:
            - count
            - items
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http
x-refined-from:
- ubicloud-openapi.yml
- ubicloud-openapi.yml