Request a cluster upgrade.

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.

Request Body

application/jsonRequired

clusterIdentitystring

Format"uuid"

scheduleRequestDate?string

Format"date-time"

ignoreMaintenanceSchedule?boolean

versionstring

Length1 <= length

Path Parameters

organisationSlugobject

Response Body

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

TypeScript Definitions

Use the response body type in TypeScript.

identity?string

Format"uuid"

clusterIdentity?string

Format"uuid"

createdAt?string

Format"date-time"

modifiedAt?string

Format"date-time"

windowStart?string

Format"date-time"

windowEnd?string

Format"date-time"

reason?string

fromClusterVersion?string

toClusterVersion?string

status?string

clusterSlug?string

environmentSlug?string

organisationSlug?string

scheduleRequestDate?string

Format"date-time"

ignoreMaintenanceSchedule?boolean

Invalid request parameters. Please review the documentation for valid parameter values.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

You do not have the necessary permissions to access this resource.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

The requested resource could not be found. Please check the resource URL or identifier.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

An internal error occurred on the server.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

curl -X POST "https://api.avisi.cloud/api/v1/orgs/[object Object]/scheduled-cluster-upgrades" \
  -H "Content-Type: application/json" \
  -d '{
    "clusterIdentity": "5e08fe67-1274-475d-bd0c-a65b0330507f",
    "version": "string"
  }'

const body = JSON.stringify({
  "clusterIdentity": "5e08fe67-1274-475d-bd0c-a65b0330507f",
  "version": "string"
})

fetch("https://api.avisi.cloud/api/v1/orgs/[object Object]/scheduled-cluster-upgrades", {
  body
})

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
  "strings"
)

func main() {
  url := "https://api.avisi.cloud/api/v1/orgs/[object Object]/scheduled-cluster-upgrades"
  body := strings.NewReader(`{
    "clusterIdentity": "5e08fe67-1274-475d-bd0c-a65b0330507f",
    "version": "string"
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://api.avisi.cloud/api/v1/orgs/[object Object]/scheduled-cluster-upgrades"
body = {
  "clusterIdentity": "5e08fe67-1274-475d-bd0c-a65b0330507f",
  "version": "string"
}
response = requests.request("POST", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)

{
  "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
}

{
  "message": "string",
  "details": [
    "string"
  ]
}

{
  "message": "string",
  "details": [
    "string"
  ]
}

{
  "message": "string",
  "details": [
    "string"
  ]
}

{
  "message": "string",
  "details": [
    "string"
  ]
}