Instaclustr Logo
Powered by Redocly

Maintenance Events API

Operations related to managing maintenance events on Instaclustr clusters.

List maintenance events

Lists all upcoming maintenance events for the given cluster

SecurityBasic Authentication
Request
query Parameters
clusterId
required
string
Example: clusterId=0c7067d6-c70a-11ea-87d0-0242ac130003
Responses
200

Successfully retrieved maintenance events

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource not found

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

get/v1/maintenance-events/events
Request samples 
Response samples 
application/json
{
  • "maintenanceEvents": [
    ]
}
List maintenance events
Lists all in progress maintenance events for the given cluster


SecurityBasic Authentication 
Request 
query Parameters
clusterId
required
string
 
 Example:  clusterId=0c7067d6-c70a-11ea-87d0-0242ac130003
Responses 
200
Successfully retrieved in progress maintenance events


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


get/v1/maintenance-events/events/inprogress
Request samples 
Response samples 
application/json
{
  • "maintenanceEvents": [
    ]
}
List maintenance events
Lists of past maintenance events for the given cluster


SecurityBasic Authentication 
Request 
query Parameters
clusterId
required
string
 
 Example:  clusterId=0c7067d6-c70a-11ea-87d0-0242ac130003
Responses 
200
Successfully retrieved past maintenance events


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


get/v1/maintenance-events/events/past
Request samples 
Response samples 
application/json
{
  • "maintenanceEvents": [
    ]
}
Reschedule a maintenance event schedule
Reschedules a maintenance event schedule to the given start time.


SecurityBasic Authentication 
Request 
path Parameters
scheduleId
required
string
 
 Example:  2c7067d6-c70a-11ea-87d0-0242ac130003
Request Body schema: application/json
required
scheduledStartTime
string
The time this maintenance event should be rescheduled to start at (in UTC time)


 
object
 
Responses 
200
Successfully updated maintenance event


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


put/v1/maintenance-events/events/{scheduleId}
Request samples 
application/json
{
  • "scheduledStartTime": "2021-12-21T11:00:00Z",
  • "validationMessages": {
    }
}
Response samples 
application/json
{
  • "id": "ff4fccf3-2ac0-494b-9f40-e95288dd752d",
  • "clusterId": "af4fccf3-2ac0-494b-9f40-e95288dd752d",
  • "description": "Upgrade Debian on nodes to 11.3",
  • "scheduledStartTime": "2021-12-21T11:00:00Z",
  • "scheduledEndTime": "2021-12-21T13:00:00Z",
  • "scheduledStartTimeMin": "2021-12-21T11:00:00Z",
  • "scheduledStartTimeMax": "2021-12-21T11:00:00Z",
  • "isFinalized": false
}
List exclusion windows
Lists all exclusion windows (times when maintenance events cannot be performed) for the given cluster


SecurityBasic Authentication 
Request 
query Parameters
clusterId
required
string
 
 Example:  clusterId=0c7067d6-c70a-11ea-87d0-0242ac130003
Responses 
200
Successfully retrieved exclusion windows


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


get/v1/maintenance-events/exclusion-windows
Request samples 
Response samples 
application/json
{
  • "exclusionWindows": [
    ]
}
Create exclusion window
Creates a new exclusion window (time when maintenance events cannot be performed) for the given cluster


SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
clusterId
string
Cluster Id for the cluster that this exclusion window relates to


 
dayOfWeek
string
The day of the week that this exclusion window starts on


 
startHour
integer <int32> 
The hour of the day that this exclusion window starts on


 
durationInHours
integer <int32> 
The duration (in hours) of this exclusion window


 
object
 
Responses 
200
Successfully created exclusion window


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


post/v1/maintenance-events/exclusion-windows
Request samples 
application/json
{
  • "clusterId": "cf4fccf3-2ac0-494b-9f40-e95288dd752d",
  • "dayOfWeek": "TUESDAY",
  • "startHour": 14,
  • "durationInHours": 6,
  • "validationMessages": {
    }
}
Response samples 
application/json
{
  • "id": "af4fccf3-2ac0-494b-9f40-e95288dd752d"
}
Delete exclusion window
Removes an exclusion window


SecurityBasic Authentication 
Request 
path Parameters
windowId
required
string
 
 Example:  3c7067d6-c70a-11ea-87d0-0242ac130003
Responses 
204
Successfully deleted exclusion window


400
Bad Request


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


delete/v1/maintenance-events/exclusion-windows/{windowId}
Request samples 
Response samples 
application/json
{
  • "status": 0,
  • "message": "string",
  • "errorDetails": { },
  • "code": 0,
  • "link": "string"
}
➔ Next to Node Reload