Instaclustr Cluster Maintenance Events V2 API

Operations related to cluster maintenance events

Documentation GitHub OpenAPI

Operations 4

GET /cluster-management/v2/data-sources/cluster/{clusterId}/maintenance-events/v2/in-progress/v2/ List in progress maintenance events V2 #

GET /cluster-management/v2/data-sources/cluster/{clusterId}/maintenance-events/v2/past/v2/ List past maintenance events V2 #

GET /cluster-management/v2/data-sources/cluster/{clusterId}/maintenance-events/v2/upcoming/v2/ List upcoming maintenance events V2 #

PUT /cluster-management/v2/operations/maintenance-events/{maintenanceEventId}/v2/reschedule-maintenance-event/v2/ Reschedule a maintenance event #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/instaclustr:instaclustr-cluster-maintenance-events-v2-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Instaclustr Cluster Maintenance Events V2 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 Cluster Maintenance Events V2 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: Cluster Maintenance Events V2
  description: Operations related to cluster maintenance events
  x-insta-tag-group: Cluster Management V2
paths:
  /cluster-management/v2/data-sources/cluster/{clusterId}/maintenance-events/v2/in-progress/v2/:
    parameters:
    - name: clusterId
      in: path
      description: ID of the cluster
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    get:
      tags:
      - Cluster Maintenance Events V2
      description: Lists in-progress maintenance events
      operationId: listInProgressMaintenanceEventsV2
      responses:
        '200':
          description: Successfully retrieved maintenance events
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterMaintenanceEventsV2'
              example:
              - maintenanceEvents:
                - clusterId: af4fccf3-2ac0-494b-9f40-e95288dd752d
                  description: Upgrade Debian on nodes to 11.3
                  endTime: '2021-12-21T11:03:32Z'
                  id: ff4fccf3-2ac0-494b-9f40-e95288dd752d
                  outcome: string
                  startTime: '2021-12-21T11:03:32Z'
                - clusterId: af4fccf3-2ac0-494b-9f40-e95288dd752e
                  description: Upgrade Debian on nodes to 11.3
                  endTime: '2021-12-22T11:03:32Z'
                  id: ff4fccf3-2ac0-494b-9f40-e95288dd752e
                  outcome: string
                  startTime: '2021-12-22T11:03:32Z'
      summary: List in progress maintenance events V2
      x-summary-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/data-sources/cluster/{clusterId}/maintenance-events/v2/past/v2/:
    parameters:
    - name: clusterId
      in: path
      description: ID of the cluster
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    get:
      tags:
      - Cluster Maintenance Events V2
      description: Lists past maintenance events
      operationId: listPastMaintenanceEventsV2
      responses:
        '200':
          description: Successfully retrieved maintenance events
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterMaintenanceEventsV2'
              example:
              - maintenanceEvents:
                - clusterId: af4fccf3-2ac0-494b-9f40-e95288dd752d
                  description: Upgrade Debian on nodes to 11.3
                  endTime: '2021-12-21T11:03:32Z'
                  id: ff4fccf3-2ac0-494b-9f40-e95288dd752d
                  outcome: string
                  startTime: '2021-12-21T11:03:32Z'
                - clusterId: af4fccf3-2ac0-494b-9f40-e95288dd752e
                  description: Upgrade Debian on nodes to 11.3
                  endTime: '2021-12-22T11:03:32Z'
                  id: ff4fccf3-2ac0-494b-9f40-e95288dd752e
                  outcome: string
                  startTime: '2021-12-22T11:03:32Z'
      summary: List past maintenance events V2
      x-summary-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/data-sources/cluster/{clusterId}/maintenance-events/v2/upcoming/v2/:
    parameters:
    - name: clusterId
      in: path
      description: ID of the cluster
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    get:
      tags:
      - Cluster Maintenance Events V2
      description: Lists upcoming maintenance events
      operationId: listUpcomingMaintenanceEventsV2
      responses:
        '200':
          description: Successfully retrieved maintenance events
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterMaintenanceEventSchedulesV2'
              example:
              - maintenanceEvents:
                - clusterId: af4fccf3-2ac0-494b-9f40-e95288dd752d
                  description: Upgrade Debian on nodes to 11.3
                  id: ff4fccf3-2ac0-494b-9f40-e95288dd752d
                  isFinalized: false
                  scheduledEndTime: '2023-05-10T04:00:07Z'
                  scheduledStartTime: '2023-05-10T03:00:07Z'
                  scheduledStartTimeMax: '2023-05-11T04:00:07Z'
                  scheduledStartTimeMin: '2023-05-19T02:00:07Z'
                - clusterId: af4fccf3-2ac0-494b-9f40-e95288dd752d
                  description: Upgrade Debian on nodes to 11.3
                  id: ff4fccf3-2ac0-494b-9f40-e95288dd752d
                  isFinalized: false
                  scheduledEndTime: '2023-05-10T04:00:07Z'
                  scheduledStartTime: '2023-05-10T03:00:07Z'
                  scheduledStartTimeMax: '2023-05-11T04:00:07Z'
                  scheduledStartTimeMin: '2023-05-19T02:00:07Z'
      summary: List upcoming maintenance events V2
      x-summary-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/operations/maintenance-events/{maintenanceEventId}/v2/reschedule-maintenance-event/v2/:
    parameters:
    - name: maintenanceEventId
      in: path
      description: ID of the maintenance event schedule
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    put:
      tags:
      - Cluster Maintenance Events V2
      summary: Reschedule a maintenance event
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClusterMaintenanceEventScheduleUpdateV2'
        required: true
      responses:
        '200':
          description: Updated maintenance event schedule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterMaintenanceEventScheduleV2'
      x-codegen-request-body-name: body
      operationId: putClusterManagementV2OperationsMaintenanceEventsByMaintenanceEventIdV2RescheduleMaintenanceEventV2
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
components:
  schemas:
    ClusterMaintenanceEventsV2:
      type: object
      properties:
        maintenanceEvents:
          type: array
          items:
            $ref: '#/components/schemas/ClusterMaintenanceEventV2'
      description: List of maintenance events.
      example:
        clusterId: af4fccf3-2ac0-494b-9f40-e95288dd752d
        maintenanceEvents:
        - clusterId: af4fccf3-2ac0-494b-9f40-e95288dd752d
          description: Upgrade Debian on nodes to 11.3
          endTime: '2023-05-10T04:00:07Z'
          id: ff4fccf3-2ac0-494b-9f40-e95288dd752d
          outcome: COMPLETED
          startTime: '2023-05-10T03:00:07Z'
    ClusterMaintenanceEventScheduleV2:
      type: object
      properties:
        scheduledStartTime:
          type: string
          description: When this maintenance event is scheduled to start in UTC time
        scheduledEndTime:
          type: string
          description: When this maintenance event is scheduled to end in UTC time
        description:
          type: string
          description: 'A text description of the activities being performed in this maintenance event

            '
        clusterId:
          type: string
          description: ID of the cluster this maintenance event relates to
        id:
          type: string
          description: Unique ID for this maintenance event
        scheduledStartTimeMin:
          type: string
          description: The earliest limit for the scheduled start time in UTC time, i.e., scheduled start time will be after this value
        isFinalized:
          type: boolean
          description: If this event can still be rescheduled
        scheduledStartTimeMax:
          type: string
          description: The latest limit for the scheduled start time in UTC time, i.e., scheduled start time will be before this value
      description: Information about a specific cluster maintenance event.
      example:
        clusterId: af4fccf3-2ac0-494b-9f40-e95288dd752d
        description: Upgrade Debian on nodes to 11.3
        id: ff4fccf3-2ac0-494b-9f40-e95288dd752d
        isFinalised: false
        scheduledEndTime: '2023-05-10T04:00:07Z'
        scheduledStartTime: '2023-05-10T03:00:07Z'
        scheduledStartTimeMax: '2023-05-11T04:00:07Z'
        scheduledStartTimeMin: '2023-05-19T02:00:07Z'
    ClusterMaintenanceEventScheduleUpdateV2:
      required:
      - scheduledStartTime
      type: object
      properties:
        scheduledStartTime:
          type: string
          description: When this maintenance event is scheduled to start in UTC time
          format: date-time
      description: Update request for a maintenance event schedule.
      example:
        scheduledStartTime: '2023-01-21T04:03:32Z'
    ClusterMaintenanceEventSchedulesV2:
      type: object
      properties:
        maintenanceEvents:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/ClusterMaintenanceEventScheduleV2'
      description: ''
      example:
        clusterId: af4fccf3-2ac0-494b-9f40-e95288dd752d
        maintenanceEvents:
        - clusterId: af4fccf3-2ac0-494b-9f40-e95288dd752d
          description: Upgrade Debian on nodes to 11.3
          id: ff4fccf3-2ac0-494b-9f40-e95288dd752d
          isFinalised: false
          scheduledEndTime: '2023-05-10T04:00:07Z'
          scheduledStartTime: '2023-05-10T03:00:07Z'
          scheduledStartTimeMax: '2023-05-11T04:00:07Z'
          scheduledStartTimeMin: '2023-05-19T02:00:07Z'
    ClusterMaintenanceEventV2:
      type: object
      properties:
        description:
          type: string
          description: 'A text description of the activities being performed in this maintenance event

            '
        startTime:
          type: string
          description: 'The time work on this maintenance event started in UTC time

            '
        clusterId:
          type: string
          description: ID of the cluster this maintenance event relates to
        endTime:
          type: string
          description: 'The time work on this maintenance event ended in UTC time

            '
        id:
          type: string
          description: Unique ID for this maintenance event
        outcome:
          type: string
          description: 'Maintenance outcome

            '
      description: Information about a specific cluster maintenance event.
      example:
        clusterId: af4fccf3-2ac0-494b-9f40-e95288dd752d
        description: Upgrade Debian on nodes to 11.3
        endTime: '2023-05-10T04:00:07Z'
        id: ff4fccf3-2ac0-494b-9f40-e95288dd752d
        outcome: PARTIAL
        startTime: '2023-05-10T03:00:07Z'
  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