Instaclustr Node Reload API

openapi: 3.2.0
info:
  title: Instaclustr Node Reload API
  version: Deprecated
  x-logo:
    altText: Instaclustr Logo
    backgroundColor: '#FFFFFF'
    url: https://console2.instaclustr.com/assets/logos/instaclustr_logo_for_redocly.svg
  description: 'Operations tagged Node Reload across 2 of this provider''s published API definitions: instaclustr-deprecated-openapi.json, instaclustr-deprecated-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: Node Reload
  description: Operation related to reloading nodes.
  x-insta-tag-group: Provisioning V1
paths:
  /provisioning/v1/{bundle}/cluster/{clusterId}/reload:
    get:
      tags:
      - Node Reload
      summary: Get cluster reload operations
      description: Retrieve the latest reload operation done on each node in the specified cluster.
      operationId: getLatestReloadOperationForCluster
      parameters:
      - name: bundle
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          enum:
          - POSTGRESQL
      - name: clusterId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully return a list of node reload operations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationMapResponse'
        '400':
          description: The requested bundle is not attached to this cluster.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Cluster not found
      deprecated: false
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /provisioning/v1/{bundle}/node/{nodeId}/reload:
    get:
      tags:
      - Node Reload
      summary: Get node reload operations
      description: Retrieve the latest reload operation of the specified node.
      operationId: getLatestNodeReloadOperation
      parameters:
      - name: bundle
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          enum:
          - POSTGRESQL
      - name: nodeId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Successfully return the latest node reload operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationListResponse'
        '400':
          description: The requested bundle is not attached to this cluster.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Node not found
      deprecated: false
    post:
      tags:
      - Node Reload
      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.
      operationId: generateNodeReloadOperation
      parameters:
      - name: bundle
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          enum:
          - POSTGRESQL
      - name: nodeId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
      responses:
        '202':
          description: Successfully trigger the node reload operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationResponse'
        '400':
          description: The requested bundle is not attached to this cluster.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Node not found
        '409':
          description: A reload operation is already running.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: false
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
components:
  schemas:
    OperationResponse:
      type: object
      properties:
        timeCreated:
          type: string
          format: date-time
        timeModified:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - GENESIS
          - RUNNING
          - COMPLETED
          - CANCELLED
          - FAILED
          - CANCELLING
          - BLOCKING
          - PAUSING
          - PAUSED
        message:
          type: string
    OperationMapResponse:
      type: object
      properties:
        operations:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/OperationResponse'
    OperationListResponse:
      type: object
      properties:
        operations:
          type: array
          items:
            $ref: '#/components/schemas/OperationResponse'
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
  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-deprecated-openapi.json
- instaclustr-deprecated-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