ScheduledUpgrades

API for interacting with automatically scheduled cluster upgrades.

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

Path Parameters:

  • organisationSlug

Query Parameters:

  • clusterIdentities (Optional list of cluster identities.)
  • statuses (Optional list of cluster statuses.)
  • pageable (Optional. When omitted: pageSize=50, pageNumber=0, sortDirection=ASC)
HTTP Responses codes for "List scheduled cluster upgrades. Returns all scheduled cluster upgrades for an organisation when no filters are set."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort array
    List of #/components/schemas/SortObject
  • unpaged boolean
ScheduledClusterUpgradeResponse
  • clusterIdentity uuid
  • createdAt date-time
  • fromClusterVersion string
  • identity uuid
  • modifiedAt date-time
  • status string
    One of SCHEDULED SCHEDULED_NOTIFIED UPDATED SUCCEEDED CANCELLED SUPERSEDED FAILED MISSED
  • toClusterVersion string
  • windowEnd date-time
  • windowStart date-time
SortObject
  • ascending boolean
  • direction string
  • ignoreCase boolean
  • nullHandling string
  • property string
GET /api/v1/orgs/{organisationSlug}/scheduled-cluster-upgrades

Response

  • content array
    List of #/components/schemas/ScheduledClusterUpgradeResponse
  • empty boolean
  • first boolean
  • last boolean
  • number int32
  • numberOfElements int32
  • pageable object
    One of #/components/schemas/PageableObject
  • size int32
  • sort array
    List of #/components/schemas/SortObject
  • totalElements int64
  • totalPages int32
                
{
  "properties": {
    "content": {
      "items": {
        "$ref": "#/components/schemas/ScheduledClusterUpgradeResponse"
      },
      "type": "array"
    },
    "empty": {
      "type": "boolean"
    },
    "first": {
      "type": "boolean"
    },
    "last": {
      "type": "boolean"
    },
    "number": {
      "format": "int32",
      "type": "integer"
    },
    "numberOfElements": {
      "format": "int32",
      "type": "integer"
    },
    "pageable": {
      "$ref": "#/components/schemas/PageableObject"
    },
    "size": {
      "format": "int32",
      "type": "integer"
    },
    "sort": {
      "items": {
        "$ref": "#/components/schemas/SortObject"
      },
      "type": "array"
    },
    "totalElements": {
      "format": "int64",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    }
  },
  "type": "object"
}

Cancel a scheduled cluster upgrade.

Path Parameters:

  • organisationSlug
  • scheduledClusterUpgradeIdentity
HTTP Responses codes for "Cancel a scheduled cluster upgrade."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
DELETE /api/v1/orgs/{organisationSlug}/scheduled-cluster-upgrades/{scheduledClusterUpgradeIdentity}

Response

  • clusterIdentity uuid
  • createdAt date-time
  • fromClusterVersion string
  • identity uuid
  • modifiedAt date-time
  • status string
  • toClusterVersion string
  • windowEnd date-time
  • windowStart date-time
                
{
  "properties": {
    "clusterIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "fromClusterVersion": {
      "type": "string"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "modifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "SCHEDULED",
        "SCHEDULED_NOTIFIED",
        "UPDATED",
        "SUCCEEDED",
        "CANCELLED",
        "SUPERSEDED",
        "FAILED",
        "MISSED"
      ],
      "type": "string"
    },
    "toClusterVersion": {
      "type": "string"
    },
    "windowEnd": {
      "format": "date-time",
      "type": "string"
    },
    "windowStart": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}

Find a scheduled cluster upgrade by identity.

Path Parameters:

  • organisationSlug
  • scheduledClusterUpgradeIdentity
HTTP Responses codes for "Find a scheduled cluster upgrade by identity."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/scheduled-cluster-upgrades/{scheduledClusterUpgradeIdentity}

Response

  • clusterIdentity uuid
  • createdAt date-time
  • fromClusterVersion string
  • identity uuid
  • modifiedAt date-time
  • status string
  • toClusterVersion string
  • windowEnd date-time
  • windowStart date-time
                
{
  "properties": {
    "clusterIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "fromClusterVersion": {
      "type": "string"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "modifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "SCHEDULED",
        "SCHEDULED_NOTIFIED",
        "UPDATED",
        "SUCCEEDED",
        "CANCELLED",
        "SUPERSEDED",
        "FAILED",
        "MISSED"
      ],
      "type": "string"
    },
    "toClusterVersion": {
      "type": "string"
    },
    "windowEnd": {
      "format": "date-time",
      "type": "string"
    },
    "windowStart": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}
← Memberships
Kubernetes Versions →