---
title: "Initiate Roll"
method: POST
path: "/ocean/aws/k8s/cluster/{oceanClusterId}/roll"
tags: ["Ocean AWS"]
---

# Initiate Roll

`POST /ocean/aws/k8s/cluster/{oceanClusterId}/roll`

Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceIds. Performing this request will start the roll immediately and run it in defined batches.
Note that the first response for a successful request will indicate the start of a roll. In order to check the status of a 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

## Request body

- union
  - object
    - `roll` object
      - `batchSizePercentage` integer — Value as a percent to set the size of a batch in a roll. Valid values are 0-100.
      - `comment` string — Add a comment description for the roll. The comment is limited to 256 chars.
      - `respectPdb` boolean — During the roll, if the parameter is set to true we honor PDB during the instance replacement.
      - `batchMinHealthyPercentage` integer — Indicates the threshold of minimum healthy instances in single batch. If the amount of healthy instances in single batch is under the threshold, the cluster roll will fail. If exists, the parameter value will be in range of 1-100. In case of null as value, the default value in the backend will be 50%. Value of param should represent the number in percentage (%) of the batch.
      - `reportPartialCompletion` boolean — When set to true, a roll that ends with a mixed result of successfully and unsuccessfully replaced instances is reported as PARTIALLY_COMPLETED. When set to false, a mixed result is reported as FAILED.
  - object
  - object

## Response `200`

Cluster Roll Response

- object
  - `id` string
  - `scope` 'Cluster' | 'Vngs' | 'Vng' | 'Instances' | 'Instance'
  - `status` 'IN_PROGRESS' | 'COMPLETED' | 'PARTIALLY_COMPLETED' | 'FAILED' | 'STOPPED'
  - `currentBatch` integer
  - `numOfBatches` integer
  - `comment` string
  - `progress` object
    - `unit` string
    - `value` integer
    - `detailedStatus` object
      - `oldInstances` object[]
        - `instanceId` string
        - `status` string
  - `oceanId` string
  - `instanceIds` string[]
  - `launchSpecIds` string[]
  - `respectPdb` boolean
  - `batchMinHealthyPercentage` integer
  - `reportPartialCompletion` boolean
  - `createdAt` string
  - `updatedAt` string

## 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)