Update an SKS cluster

PUT /sks-cluster/{id}

Path parameters

  • id string(uuid) Required
application/json

Body Required

  • name string

    Cluster name

    Minimum length is 1, maximum length is 255.

  • Cluster description

    Maximum length is 255.

  • labels object

    Resource labels

    Hide labels attribute Show labels attribute
  • oidc object

    Cluster OpenID configmap

    Hide oidc attributes Show oidc attributes
    • client-id string Required

      OpenID client ID

      Minimum length is 1, maximum length is 255.

    • issuer-url string Required

      OpenID provider URL

      Minimum length is 1, maximum length is 255.

    • JWT claim to use as the user name

      Minimum length is 1, maximum length is 255.

    • Prefix prepended to username claims

      Minimum length is 1, maximum length is 255.

    • JWT claim to use as the user's group

      Minimum length is 1, maximum length is 255.

    • Prefix prepended to group claims

      Minimum length is 1, maximum length is 255.

    • A key value map that describes a required claim in the ID Token

      Hide required-claim attribute Show required-claim attribute
  • Enable auto upgrade of the control plane to the latest patch version available

  • addons array[string]

    Cluster addons

    Values are exoscale-cloud-controller, exoscale-container-storage-interface, or metrics-server.

Responses

  • 200 application/json

    200

    Hide response attributes Show response attributes object
    • id string(uuid)

      Operation ID

    • reason string

      Operation failure reason

      Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.

    • Related resource reference

      Hide reference attributes Show reference attributes
      • id string(uuid)

        Reference ID

      • command string

        Command name

    • message string

      Operation message

    • state string

      Operation status

      Values are failure, pending, success, or timeout.

PUT /sks-cluster/{id}
curl \
 -X PUT https://api-ch-gva-2.exoscale.com/v2/sks-cluster/{id} \
 -H "Content-Type: application/json" \
 -d '{"name":"string","description":"string","labels":{},"oidc":{"client-id":"string","issuer-url":"string","username-claim":"string","username-prefix":"string","groups-claim":"string","groups-prefix":"string","required-claim":{}},"auto-upgrade":true,"addons":["exoscale-cloud-controller"]}'
Request example
{
  "name": "string",
  "description": "string",
  "labels": {},
  "oidc": {
    "client-id": "string",
    "issuer-url": "string",
    "username-claim": "string",
    "username-prefix": "string",
    "groups-claim": "string",
    "groups-prefix": "string",
    "required-claim": {}
  },
  "auto-upgrade": true,
  "addons": [
    "exoscale-cloud-controller"
  ]
}
Response examples (200)
{
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  },
  "message": "string",
  "state": "failure"
}