Cluster Maintenance Events V2

Operations related to cluster maintenance events

Lists in-progress maintenance events

Lists in-progress maintenance events

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the cluster

Responses
200

Successfully retrieved maintenance events

get/cluster-management/v2/data-sources/cluster/{clusterId}/maintenance-events/v2/in-progress/v2/
Request samples
Response samples
application/json
[
  • {
    }
]

Lists past maintenance events

Lists past maintenance events

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the cluster

Responses
200

Successfully retrieved maintenance events

get/cluster-management/v2/data-sources/cluster/{clusterId}/maintenance-events/v2/past/v2/
Request samples
Response samples
application/json
[
  • {
    }
]

Lists upcoming maintenance events

Lists upcoming maintenance events

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the cluster

Responses
200

Successfully retrieved maintenance events

get/cluster-management/v2/data-sources/cluster/{clusterId}/maintenance-events/v2/upcoming/v2/
Request samples
Response samples
application/json
[
  • {
    }
]

Reschedule a maintenance event

SecurityBasic Authentication
Request
path Parameters
maintenanceEventId
required
string <uuid>

ID of the maintenance event schedule

Request Body schema: application/json
required
scheduledStartTime
required
string <date-time>

When this maintenance event is scheduled to start in UTC time

Responses
200

Updated maintenance event schedule

put/cluster-management/v2/operations/maintenance-events/{maintenanceEventId}/v2/reschedule-maintenance-event/v2/
Request samples
application/json
{
  • "scheduledStartTime": "2023-01-21T04:03:32Z"
}
Response samples
application/json
{
  • "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"
}