Avisi cloud logo
Scheduled upgrades

Find a scheduled cluster upgrade by identity.

GET
/api/v1/orgs/{organisationSlug}/scheduled-cluster-upgrades/{scheduledClusterUpgradeIdentity}

Path Parameters

organisationSlugRequiredobject
scheduledClusterUpgradeIdentityRequiredstring
Format: "uuid"

Response Body

Request was successfully processed. The response body contains the requested data.

TypeScript Definitions

Use the response body type in TypeScript.

identitystring
Format: "uuid"
clusterIdentitystring
Format: "uuid"
createdAtstring
Format: "date-time"
modifiedAtstring
Format: "date-time"
windowStartstring
Format: "date-time"
windowEndstring
Format: "date-time"
reasonstring
fromClusterVersionstring
toClusterVersionstring
statusstring
Value in: "REQUESTED" | "SCHEDULED" | "SCHEDULED_NOTIFIED" | "IN_PROGRESS" | "SUCCEEDED" | "SUPERSEDED" | "FAILED" | "MISSED"
clusterSlugstring
environmentSlugstring
organisationSlugstring
scheduleRequestDatestring
Format: "date-time"
ignoreMaintenanceScheduleboolean
curl -X GET "https://api.avisi.cloud/api/v1/orgs/[object Object]/scheduled-cluster-upgrades/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
  "clusterIdentity": "5e08fe67-1274-475d-bd0c-a65b0330507f",
  "createdAt": "2019-08-24T14:15:22Z",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "windowStart": "2019-08-24T14:15:22Z",
  "windowEnd": "2019-08-24T14:15:22Z",
  "reason": "string",
  "fromClusterVersion": "string",
  "toClusterVersion": "string",
  "status": "REQUESTED",
  "clusterSlug": "string",
  "environmentSlug": "string",
  "organisationSlug": "string",
  "scheduleRequestDate": "2019-08-24T14:15:22Z",
  "ignoreMaintenanceSchedule": true
}

List scheduled cluster upgrades. Returns all scheduled cluster upgrades for an organisation when no filters are set. GET

Previous Page

Request a cluster upgrade. POST

This endpoint is used to schedule or reschedule a cluster upgrade. Using the request body, you can: • Specify a desired start date and time for the upgrade using the scheduleRequestDate property. • Indicate whether the scheduler should bypass configured maintenance windows using the ignoreMaintenanceSchedule property. If ignoreMaintenanceSchedule is set to false, the scheduler will respect the configured maintenance windows and use the provided scheduleRequestDate as the starting point (“from date”) to determine the next available maintenance window.