Instaclustr PostgreSQL Operations API

openapi: 3.2.0
info:
  title: Instaclustr PostgreSQL Operations API
  version: Current
  x-logo:
    altText: Instaclustr Logo
    backgroundColor: '#FFFFFF'
    url: https://console2.instaclustr.com/assets/logos/instaclustr_logo_for_redocly.svg
  description: 'Operations tagged PostgreSQL Operations across 2 of this provider''s published API definitions: instaclustr-current-openapi.json, instaclustr-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.instaclustr.com
  description: Instaclustr API
security:
- Basic Authentication: []
tags:
- name: PostgreSQL Operations
  description: Operations related to PostgreSQL.
  x-insta-tag-group: Cluster Management V2
paths:
  /cluster-management/v2/operations/applications/postgresql/clusters/v2/{clusterId}/reload:
    parameters:
    - name: clusterId
      in: path
      description: ID of the PostgreSQL cluster.
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    get:
      tags:
      - PostgreSQL Operations
      summary: Get cluster reload operations
      description: Retrieve the latest reload operation done on each node in the specified cluster.
      responses:
        '202':
          description: Successfully return a list of node reload operations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostgresqlReloadOperationsV2'
        '404':
          description: PostgreSQL cluster not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
      operationId: getClusterManagementV2OperationsApplicationsPostgresqlClustersV2ByClusterIdReload
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/operations/applications/postgresql/clusters/v2/{clusterId}/update-default-user-password:
    parameters:
    - name: clusterId
      in: path
      description: ID of the PostgreSQL cluster.
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    put:
      tags:
      - PostgreSQL Operations
      summary: Update the default PostgreSQL user password
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostgresqlUserSummary'
        required: true
      responses:
        '202':
          description: Default PostgreSQL user password updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostgresqlUserSummary'
        '404':
          description: PostgreSQL cluster not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
        '504':
          description: Gateway Timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
      x-codegen-request-body-name: body
      operationId: putClusterManagementV2OperationsApplicationsPostgresqlClustersV2ByClusterIdUpdateDefaultUserPassword
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/operations/applications/postgresql/clusters/{clusterId}/certificate/v3/:
    parameters:
    - name: clusterId
      in: path
      description: ID of the cluster
      required: true
      style: simple
      explode: false
      schema:
        type: string
    get:
      tags:
      - PostgreSQL Operations
      summary: Download PostgreSQL cluster X.509 Certificate Authority certificates
      description: PostgreSQL cluster certificates are returned as a .zip file. The file contains an X.509 cluster Certificate Authority certificate in JKS file, an X.509 cluster Certificate Authority certificate in PEM-encoded (ASCII) format, and an X.509 cluster Certificate Authority certificate in DER-encoded (binary) format.
      responses:
        '200':
          description: Successfully create the PostgreSQL cluster's certificate
          content:
            application/zip:
              schema:
                type: string
                format: binary
      operationId: getClusterManagementV2OperationsApplicationsPostgresqlClustersByClusterIdCertificateV3
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/operations/applications/postgresql/clusters/{clusterId}/extensions/create/{extensionName}/v1:
    parameters:
    - name: clusterId
      in: path
      description: ID of the cluster
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    - name: extensionName
      in: path
      description: Name of the extensions
      required: true
      style: simple
      explode: false
      schema:
        type: string
        enum:
        - PG_STAT_TUPLE
        - PG_BUFFER_CACHE
        - PG_VECTOR
        - PG_STAT_STATEMENTS
        - EARTH_DISTANCE
        - CUBE
    post:
      tags:
      - PostgreSQL Operations
      summary: Trigger an extension instantiate operation
      description: Instantiate Extension for list of databases
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostgresqlDatabaseListV1'
        required: true
      responses:
        '202':
          description: Successfully trigger the operation.
          content: {}
        '404':
          description: PostgreSQL cluster or extension not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
      x-codegen-request-body-name: body
      operationId: postClusterManagementV2OperationsApplicationsPostgresqlClustersByClusterIdExtensionsCreateByExtensionNameV1
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/operations/applications/postgresql/clusters/{clusterId}/extensions/drop/{extensionName}/v1:
    parameters:
    - name: clusterId
      in: path
      description: ID of the cluster
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    - name: extensionName
      in: path
      description: Name of the extensions
      required: true
      style: simple
      explode: false
      schema:
        type: string
        enum:
        - PG_STAT_TUPLE
        - PG_BUFFER_CACHE
        - PG_VECTOR
        - PG_STAT_STATEMENTS
        - EARTH_DISTANCE
        - CUBE
    post:
      tags:
      - PostgreSQL Operations
      summary: Trigger an extension drop operation
      description: Drop Extension for list of databases
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostgresqlDatabaseListV1'
        required: true
      responses:
        '202':
          description: Successfully trigger the operation.
          content: {}
        '404':
          description: PostgreSQL cluster or extension not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
      x-codegen-request-body-name: body
      operationId: postClusterManagementV2OperationsApplicationsPostgresqlClustersByClusterIdExtensionsDropByExtensionNameV1
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/operations/applications/postgresql/clusters/{clusterId}/snapshots/{clusterSnapshotId}/v1:
    parameters:
    - name: clusterId
      in: path
      description: ID of the cluster.
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    - name: clusterSnapshotId
      in: path
      description: ID of the ad-hoc cluster snapshot to delete.
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    delete:
      tags:
      - PostgreSQL Operations
      summary: Delete an ad-hoc PostgreSQL cluster snapshot
      description: Deletes an ad-hoc FSxN snapshot for a PostgreSQL cluster. Only supported for clusters using FSx for NetApp ONTAP storage
      responses:
        '204':
          description: Snapshot delete request processed.
          content: {}
        '400':
          description: The snapshot is not eligible for deletion, or the FSxN Snapshot feature is not enabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
        '403':
          description: Missing required permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
        '404':
          description: PostgreSQL cluster or snapshot not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
        '409':
          description: The snapshot cannot be deleted because one or more clusters were forked from it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
      operationId: deleteClusterManagementV2OperationsApplicationsPostgresqlClustersByClusterIdSnapshotsByClusterSnapshotIdV1
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/operations/applications/postgresql/clusters/{clusterId}/trigger-backup/v3/:
    parameters:
    - name: clusterId
      in: path
      description: ID of the cluster.
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    post:
      tags:
      - PostgreSQL Operations
      summary: Manually trigger cluster backup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostgresqlBackupDetailsV2'
        required: false
      responses:
        '202':
          description: Trigger cluster backup request accepted.
          content: {}
      x-codegen-request-body-name: body
      operationId: postClusterManagementV2OperationsApplicationsPostgresqlClustersByClusterIdTriggerBackupV3
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/operations/applications/postgresql/nodes/v2/{nodeId}/reload:
    parameters:
    - name: nodeId
      in: path
      description: ID of the PostgreSQL node.
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    get:
      tags:
      - PostgreSQL Operations
      summary: Get node reload operation
      description: Retrieve the latest reload operation of the specified node.
      responses:
        '202':
          description: Successfully return the latest node reload operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostgresqlReloadOperationV2'
        '404':
          description: PostgreSQL node not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
      operationId: getClusterManagementV2OperationsApplicationsPostgresqlNodesV2ByNodeIdReload
      x-operation-id-source: derived
    post:
      tags:
      - PostgreSQL Operations
      summary: Trigger a node reload operation
      description: Trigger a node reload operation, this is generally done to allow configuration changes to take effect without initiating a full restart.
      responses:
        '202':
          description: Successfully trigger the node reload operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostgresqlReloadOperationV2'
        '404':
          description: PostgreSQL node not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
      operationId: postClusterManagementV2OperationsApplicationsPostgresqlNodesV2ByNodeIdReload
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/operations/applications/postgresql/restore/v3:
    post:
      tags:
      - PostgreSQL Operations
      summary: Trigger a PostgreSQL Cluster Restore
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostgresqlClusterRestoreV2'
        required: true
      responses:
        '202':
          description: PostgreSQL Cluster Restore requested
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostgresqlClusterRestoreV2'
              example:
                cdcConfigs:
                - cdcId: a8c32b20-c8f0-11e7-abc4-cec278b6b50a
                  customVpcSettings:
                    network: 10.0.0.0/16
                    vpcId: vpc-002512aa
                  restoreMode: CUSTOM_VPC
                clusterId: c0e5e2ff-affe-444c-bdca-707c7b48aaad
                pointInTime: 1420070400000
                restoredClusterId: b8a32a20-d8e0-11a7-def4-sdc278a6a50b
                restoredClusterName: my-restored-cluster
      x-codegen-request-body-name: body
      operationId: postClusterManagementV2OperationsApplicationsPostgresqlRestoreV3
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
components:
  schemas:
    PostgresqlUserSummary:
      required:
      - password
      type: object
      properties:
        password:
          type: string
          description: Password of the default PostgreSQL user.
          example: '!mypassword1'
      description: Summary of the default PostgreSQL user to be applied to a PostgreSQL cluster.
      example:
        password: '!mypassword1'
    StorageResizeResourceTargets:
      required:
      - storageCapacityGib
      - storageIops
      - storageThroughputMibps
      type: object
      properties:
        storageIops:
          type: integer
          description: Target storage IOPS.
          format: int64
        storageCapacityGib:
          type: integer
          description: Target storage capacity, in GiB.
          format: int32
        storageThroughputMibps:
          type: integer
          description: Target storage throughput, in MiB/s. Must be one of the values allowed by the storage provider for the filesystem's generation.
          format: int32
      description: Target filesystem capacity, throughput and IOPS to resize an FSxN forked cluster's storage to. Only valid, and required, when shouldResize is true.
      example:
        storageCapacityGib: 1024
        storageIops: 40000
        storageThroughputMibps: 2048
    PostgresqlReloadOperationV2:
      type: object
      properties:
        operationId:
          type: string
          description: Reload operations Id.
        timeCreated:
          type: string
          description: Reload operation time created.
        message:
          type: string
          description: Reload operation message.
        nodeId:
          type: string
          description: Node Id of the node in which this reload operation was executed.
        timeModified:
          type: string
          description: Reload operation time modified.
        status:
          type: string
          description: Reload operation status.
      description: PostgreSQL reload operation.
      example:
        message: string
        nodeId: string
        operationId: string
        status: GENESIS
        timeCreated: '2019-08-24T14:15:22Z'
        timeModified: '2019-08-24T14:15:22Z'
    PostgresqlDatabaseListV1:
      type: object
      properties:
        dataBaseNames:
          maxItems: 32
          minItems: 1
          type: array
          description: List of database names.
          items:
            type: string
      description: List of db names
    ClusterDataCentreRestoreConfigV2:
      required:
      - cdcId
      - restoreMode
      type: object
      properties:
        customVpcSettings:
          $ref: '#/components/schemas/CustomVpcSettingsRestoreV2'
        restoreMode:
          $ref: '#/components/schemas/CommonClusterRestoreModeEnumV2'
        cdcId:
          type: string
          description: Cluster Data Centre ID
          format: uuid
      description: Definition of a Cluster Data Centre to Cluster Restore
    PostgresqlReloadOperationsV2:
      required:
      - clusterId
      - reloadOperations
      type: object
      properties:
        reloadOperations:
          type: array
          description: List of reload operations
          items:
            $ref: '#/components/schemas/PostgresqlReloadOperationV2'
        clusterId:
          type: string
          description: ID of the PostgreSQL cluster
      description: PostgreSQL reload operations
    PostgresqlClusterRestoreV2:
      required:
      - clusterId
      type: object
      properties:
        forkConfig:
          required:
          - clusterSnapshotId
          - networkConfigs
          type: object
          properties:
            shouldResize:
              type: boolean
              description: If true, resize the forked FSxN filesystem/volume to the values given in resizeTargets after cloning. resizeTargets is required when this is true; the request is rejected if it is missing.
              default: false
            clusterSnapshotId:
              type: string
              description: ID of the cluster snapshot
              format: uuid
            networkConfigs:
              minItems: 1
              type: array
              description: A list of Cluster Data Centre networks for ANF Forking.
              items:
                $ref: '#/components/schemas/PostgresqlForkNetworkConfigV2'
            resizeTargets:
              $ref: '#/components/schemas/StorageResizeResourceTargets'
          description: 'Configuration for ANF or FSxN Forking.


            If used, cdcConfigs and pointInTime values will be ignored'
          example:
            clusterSnapshotId: a8c32b20-c8f0-11e7-abc4-cec278b6b50a
            networkConfigs:
            - network: 10.3.0.0/16
              sourceCdcId: a8c32b20-c8f0-11e7-abc4-cec278b6b50a
            shouldResize: false
        cdcConfigs:
          type: array
          description: 'An optional list of Cluster Data Centres to determine their VPC in the restored cluster.


            Data centres not included will default to being restored to a new VPC.'
          items:
            $ref: '#/components/schemas/ClusterDataCentreRestoreConfigV2'
        pointInTime:
          type: string
          description: 'Timestamp in milliseconds since epoch or ISO formatted date and time (example - 2023-11-05T13:15:30Z). All backed up data will be restored for this point in time.


            Defaults to the current date and time.'
        restoredClusterName:
          maxLength: 48
          minLength: 3
          pattern: '[a-zA-Z0-9][a-zA-Z0-9_-]*'
          type: string
          description: 'The display name of the restored cluster.


            By default, the restored cluster will be created with its current name appended with “restored” and the date & time it was requested to be restored.'
        restoredClusterId:
          type: string
          description: ID of the restored cluster
          format: uuid
          readOnly: true
        clusterId:
          type: string
          description: ID of the cluster
          format: uuid
          x-terraform-force-new: true
      example:
        cdcConfigs:
        - cdcId: a8c32b20-c8f0-11e7-abc4-cec278b6b50a
          customVpcSettings:
            network: 10.0.0.0/16
            vpcId: vpc-002512aa
          restoreMode: CUSTOM_VPC
        clusterId: c0e5e2ff-affe-444c-bdca-707c7b48aaad
        pointInTime: 1420070400000
        restoredClusterName: my-restored-cluster
    CustomVpcSettingsRestoreV2:
      required:
      - network
      - vpcId
      type: object
      properties:
        vpcId:
          type: string
          description: Custom VPC ID to which the restored cluster will be allocated.
        network:
          type: string
          description: CIDR block in which the cluster will be allocated for a custom VPC
      description: Definition of Custom VPC Settings to be applied to Cluster Data Centre
    PostgresqlBackupTypeEnumV2:
      type: string
      description: Type of backup
      enum:
      - snapshot
      - backup
    CommonClusterRestoreModeEnumV2:
      type: string
      description: "Determines the target VPC for restored cluster. Accepted values are:\n<ul> \n<li>NEW_VPC - restores the cluster to a new VPC.</li> \n<li>SAME_VPC - restores the cluster to the same VPC as the original cluster, for customers running in their own account.</li>\n  <ul><li>AWS - restore to a new Cidr within the CDC's network</li> <li>GCP - For customer-managed network, if the source cluster specifies a host project, it will be restored to that project.  If the source cluster specifies a custom subnet, it will be restored to that custom subnet. If nothing is specified, it will restore to a new Cidr within the CDC network.</li> <li>Azure - currently not supported.</li></ul> <li>CUSTOM_VPC - restores the cluster to a custom VPC for customers running in their own account. Customers need to specify the customVpcSettings including network and vpcId.</li>\n  <ul><li>AWS - restores the cluster to the network Cidr and vpc specified by the customer</li> <li>GCP - For customer-managed network, if the vpcId field contains the projects/ pattern, it will be restored to that project.  If the vpcId field contains the subnetworks/ pattern, it will be restored to that custom subnet. If nothing is specified, it will restore to a new Cidr within the CDC network.</li> <li>Azure - restores the cluster to the network Cidr and VNet specified by the customer.</li></ul>\n CUSTOM_VPC and SAME_VPC options are available only for customers running in their own account."
      enum:
      - NEW_VPC
      - SAME_VPC
      - CUSTOM_VPC
      x-terraform-write-only: true
    PostgresqlBackupDetailsV2:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/PostgresqlBackupTypeEnumV2'
      description: Defines which backup type will be created.
    PostgresqlForkNetworkConfigV2:
      required:
      - network
      - sourceCdcId
      type: object
      properties:
        sourceCdcId:
          type: string
          description: ID of the original Cluster Data Centre to be forked
          format: uuid
        network:
          type: string
          description: Cluster Data Centre network for the new forked cluster
      description: Network configuration for ANF Forking
      example:
        network: 10.0.0.0/16
        sourceCdcId: a8c32b20-c8f0-11e7-abc4-cec278b6b50a
    ErrorResponseV2:
      title: Root Type for ErrorResponse
      type: object
      properties:
        name:
          type: string
        message:
          type: string
      description: ''
  securitySchemes:
    Basic_Authentication:
      type: http
      description: Most requests to the API must use Basic Authentication and contain a valid username and appropriate API key for the endpoint.<br><br>API keys can be retrieved any time from the <a href='https://console2.instaclustr.com/' target='_blank'>console</a>. To find the API key relevant to the endpoint, refer to the Authentication & Rate Limit section for the endpoint or the group of the endpoint.
      scheme: basic
    No_Authentication:
      type: http
      description: Certain endpoints are publicly available and does not need any authentication to access.
      scheme: none
x-refined-from:
- instaclustr-current-openapi.json
- instaclustr-openapi.yml
x-tagGroups:
- name: Cluster Management V2
  tags:
  - Cluster Management V2 - Trait
  - Account Cluster List V2
  - AWS Encryption Key V2
  - AWS Endpoint DNS Names V2
  - AWS Endpoint Service Names V2
  - AWS Endpoint Service Principals V2
  - AWS FSx ONTAP File Systems
  - AWS FSx ONTAP Filesystem Credentials V2
  - AWS Prefix List Firewall Rule V1
  - AWS Prefix List Firewall Rules V1
  - AWS Security Group Firewall Rule V2
  - AWS Security Group Firewall Rules V2
  - AWS VPC Peer V2
  - Apache Cassandra Provisioning V2
  - Apache Kafka ACL V2
  - Apache Kafka ACL V3
  - Apache Kafka Connect Mirror V2
  - Apache Kafka Connect Provisioning V2
  - Apache Kafka Provisioning V2
  - Apache Kafka Provisioning V3
  - Apache Kafka Rest Proxy User
  - Apache Kafka Schema Registry User
  - Apache Kafka Tiered Storage
  - Apache Kafka Topic V2
  - Apache Kafka Topic V3
  - Apache Kafka User
  - Apache Zookeeper Provisioning V2
  - Azure Private Link Service Subscriptions
  - Azure Vnet Peer V2
  - BYOC AWS CloudFormation
  - BYOC AWS Provider Account Setup V1
  - Cadence Domain Rate Limits V2
  - Cadence Global Domain Rate Limits V2
  - Cadence Provisioning V2
  - ClickHouse Configurations
  - ClickHouse Integrations
  - ClickHouse Provisioning
  - Cloud Provider Details V2
  - Cluster Exclusion Window V2
  - Cluster Maintenance Events V2
  - Cluster Network Firewall Rule V2
  - Cluster Network Firewall Rules V2
  - Cluster Non Recurring Exclusion Window V2
  - Cluster Settings V2
  - Cluster Suspend Resume V2
  - Custom Tags V2
  - GCP PSC Service Attachments Accept List V2
  - GCP VPC Peer V2
  - Horizontal Scaling Operations
  - Karapace Rest Proxy User
  - Karapace Schema Registry User
  - MCP Gateway Backend V1
  - MCP Gateway Persona Access Control V1
  - MCP Gateway Provisioning V1
  - MCP Gateway Tool V1
  - MCP Gateway Virtual Server V1
  - Management Units Usage
  - OpenSearch Egress Rules V2
  - OpenSearch External S3 Bucket V2
  - OpenSearch Provisioning V2
  - PostgreSQL Configuration V2
  - PostgreSQL Operations
  - PostgreSQL Provisioning V2
  - Private Link Private Service Connect Endpoint Addresses V2
  - Redis Provisioning V2
  - Redis User V2
  - Resize Operations V2
  - Terraform Import V2
  - User Actions V3
  - Valkey Provisioning V2
  - Valkey User V2
- name: Monitoring
  tags:
  - Monitoring - Trait
  - Monitoring API
  - Monitoring API - Cluster
  - Monitoring API - Data Centre
  - Monitoring API - Node
- name: User Management
  tags:
  - User Management and SCIM 2.0 API - Trait
  - Service User Management API
  - User Management and SCIM 2.0 API
- name: Other
  tags:
  - Organization Management API
  - Pricing information - Node sizes