---
title: "Initiate Auto upgrade"
method: POST
path: "/ocean/azure/np/cluster/{oceanClusterId}/autoUpgrade"
tags: ["Ocean AKS"]
---

# Initiate Auto upgrade

`POST /ocean/azure/np/cluster/{oceanClusterId}/autoUpgrade`

Update the Ocean AKS cluster's VNGs with the latest version of the control plane's version after upgrading by specifying the scope.  Performing this request will update the VNGs with a new version if available and run a cluster roll if set.  If the response is successful, the old and new versions will be included in the response along with the updated VNGs.  If a cluster roll is set in the request, the first response for a successful request will indicate the start of a roll.  In order to check the status of the roll, you can use the GET Roll API.

## Parameters

- `#/paths/~1azure~1costs/get/parameters/0` — unresolved $ref
- `#/paths/~1ocean~1aws~1k8s~1cluster~1%7BoceanClusterId%7D/get/parameters/1` — unresolved $ref
- `#/paths/~1ocean~1azure~1np~1cluster~1aks~1import/post/parameters/1` — unresolved $ref
- `#/paths/~1ocean~1azure~1np~1cluster~1aks~1import/post/parameters/2` — unresolved $ref

## Request body

- object
  - `upgradeConfig` object, required — The Configuration for scheduling automatic upgrades of your cluster to ensure it stays updated with the latest version.
    - `applyRoll` boolean — When set to True, a cluster roll will be initiated if a new version is available to upgrade in the dedicated virtual node groups.
    - `scopeVersion` 'patch' — The scope of the upgrade version.
    - `rollParameters` object — The parameters of the cluster roll that will be initiated.
      - `batchSizePercentage` integer — The percentage of the cluster that will be rolled at each batch.
      - `comment` string — A comment to be added to the cluster roll.
      - `respectPdb` boolean — During the roll, if the parameter is set to true we honor PDB during the instance replacement.
      - `respectRestrictScaleDown` boolean — During the roll, if the parameter is set to true we honor Restrict Scale Down label during the nodes replacement.
      - `batchMinHealthyPercentage` integer — The minimum percentage of the scaled nodes that should be healthy at each batch.
    - `upgradeSystemNodePools` boolean — When set to True, the system node pools will be updated with the new Kubernetes version as part of the upgrade.
    - `systemNodePools` string[] — List of node pool names to be updated with the new Kubernetes version as part of the upgrade.

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/spot/apis/spot-by-flexera-api.md) · [All operations](https://skmtc.net/spot/apis/spot-by-flexera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/spot/spot-by-flexera-api/revisions/72813baf8d47/schema)