---
title: "Initiate Roll"
method: POST
path: "/ocean/gcp/k8s/cluster/{oceanId}/roll"
tags: ["Ocean GKE"]
---

# Initiate Roll

`POST /ocean/gcp/k8s/cluster/{oceanId}/roll`

Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceNames. Performing this request will start the roll immediately, and the roll will take place according to defined batches. <br /> <br /> Note that the first response for a successful request will notify about the start of a roll. In order to check the status of a roll, you can use the GET Cluster Roll API using the roll identifier.

## Parameters

- `#/paths/~1azure~1costs/get/parameters/0` — unresolved $ref
- `#/paths/~1ocean~1gcp~1k8s~1cluster~1%7BoceanId%7D~1roll/get/parameters/1` — unresolved $ref

## Request body

- union
  - object
    - `roll` object
      - `batchSizePercentage` integer — Value is a percentage 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', PDB is honored during the instance replacement.
      - `batchMinHealthyPercentage` integer — Indicates the threshold percentage of minimum healthy instances in a single batch. If the number is below the threshold, the cluster roll will fail. The parameter value has a range of 1-100 (default = 50%).
  - object
  - object

## Response `200`

Cluster Roll Response

- object
  - `rollId` string
  - `oceanId` string
  - `scope` 'Cluster' | 'Vngs' | 'Vng' | 'Instances' | 'Instance'
  - `status` 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'STOPPED'
  - `batchNumber` integer
  - `numOfBatches` integer
  - `comment` string
  - `respectPdb` boolean
  - `progress` object
    - `unit` string
    - `value` integer
    - `detailedStatus` object
      - `oldInstances` object[]
        - `instanceName` string
        - `status` string
  - `instanceNames` string[]
  - `launchSpecIds` string[]
  - `batchMinHealthyPercentage` integer
  - `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)