Update a cluster.

PATCH

/api/v1/orgs/{organisationSlug}/clusters/{environmentSlug}/{clusterSlug}

Request Body

application/jsonRequired

`status`string

Value in: "starting" | "stopping" | "deleting"

`version`string

`cni`string

Value in: "custom" | "cilium" | "calico"

`updateChannel`string

`environmentSlug`string

`enableNetworkEncryption`boolean

`podSecurityStandardsProfile`string

Value in: "privileged" | "baseline" | "restricted"

`enableAutoUpgrade`boolean

`enableHighAvailability`boolean

`deleteProtection`boolean

`ipWhitelist`array<object>

`addons`object

`cloudCredentialsIdentity`string

Format: "uuid"

`maintenanceScheduleIdentity`string

Format: "uuid"

`clusterAutoscalerSettings`object

`upstreamCluster`object

Path Parameters

`organisationSlug`
Required
string

Pattern: "^[a-z0-9-]+$"

`environmentSlug`
Required
string

Pattern: "^[a-z0-9-]+$"

`clusterSlug`
Required
string

Pattern: "^[a-z0-9-]+$"

curl -X PATCH "https://api.avisi.cloud/api/v1/orgs/string/clusters/string/string" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "starting",
    "version": "string",
    "cni": "custom",
    "updateChannel": "string",
    "environmentSlug": "string",
    "enableNetworkEncryption": true,
    "podSecurityStandardsProfile": "privileged",
    "enableAutoUpgrade": true,
    "enableHighAvailability": true,
    "deleteProtection": true,
    "ipWhitelist": [
      {
        "cidr": "string",
        "description": "string"
      }
    ],
    "addons": {
      "property1": {
        "enabled": true,
        "customValues": {
          "property1": "string",
          "property2": "string"
        }
      },
      "property2": {
        "enabled": true,
        "customValues": {
          "property1": "string",
          "property2": "string"
        }
      }
    },
    "cloudCredentialsIdentity": "2265126a-d84a-47b6-a9f9-1aa87a694a6a",
    "maintenanceScheduleIdentity": "e083de3d-c54f-4906-804d-30ef2bc37b6f",
    "clusterAutoscalerSettings": {
      "scale-down-utilization-threshold": 0.1,
      "scale-down-gpu-utilization-threshold": 0.1,
      "scale-down-delay-after-add": "string",
      "scale-down-unneeded-time": "string",
      "scale-down-unready-time": "string",
      "max-node-provision-time": "string",
      "unremovable-node-recheck-timeout": "string"
    },
    "upstreamCluster": {
      "identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5"
    }
  }'

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

{
  "name": "string",
  "identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
  "environmentIdentity": "bb451031-60ba-4fcd-9556-56368eb5c985",
  "maintenanceSchedule": {
    "identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
    "name": "string",
    "clusterCount": 0,
    "windows": [
      {
        "day": "MONDAY",
        "startTime": "string",
        "duration": 0
      }
    ]
  },
  "environmentSlug": {
    "slugValue": "string"
  },
  "customerIdentity": "e7596901-a2e3-4b7e-9dd1-f11d0f6765a7",
  "customerSlug": {
    "slugValue": "string"
  },
  "poolID": 0,
  "poolName": "string",
  "slug": {
    "slugValue": "string"
  },
  "description": "string",
  "cloudProvider": "string",
  "region": "string",
  "version": "string",
  "updateChannel": {
    "name": "string",
    "available": true,
    "kubernetesClusterVersion": "string"
  },
  "autoUpgrade": true,
  "highlyAvailable": true,
  "enableNetworkEncryption": true,
  "podSecurityStandardsProfile": "privileged",
  "cni": "custom",
  "enableMultiAvailabilityZones": true,
  "enableNATGateway": true,
  "serviceSubnet": "string",
  "clusterPodSubnet": "string",
  "status": "new",
  "desiredStatus": "starting",
  "provisionStatus": "UNKNOWN",
  "createdAt": "2019-08-24T14:15:22Z",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "memory": 0,
  "cpu": 0,
  "ipWhitelist": [
    {
      "cidr": "string",
      "description": "string"
    }
  ],
  "ameOIDC": true,
  "deleteProtection": true,
  "addons": {
    "property1": {
      "enabled": true,
      "customValues": {
        "property1": "string",
        "property2": "string"
      }
    },
    "property2": {
      "enabled": true,
      "customValues": {
        "property1": "string",
        "property2": "string"
      }
    }
  },
  "observabilityTenant": {
    "id": 0,
    "identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
    "customer": "string",
    "name": "string",
    "slug": "string",
    "available": true,
    "ipWhiteList": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "modifiedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "cluster": {
      "id": 0,
      "identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
      "name": "string",
      "slug": "string",
      "environmentSlug": "string",
      "version": "string",
      "deletedAt": "2019-08-24T14:15:22Z"
    },
    "environment": {
      "id": 0,
      "name": "string",
      "slug": "string"
    }
  },
  "environmentPrometheusRules": true,
  "cloudAccount": {
    "identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
    "displayName": "string",
    "primaryCloudCredentials": {
      "identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
      "displayName": "string",
      "isPrimary": true
    }
  },
  "cloudCredentials": {
    "identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
    "displayName": "string",
    "isPrimary": true
  },
  "actualState": {
    "status": "string",
    "version": "string",
    "collectedAt": "2019-08-24T14:15:22Z"
  },
  "clusterAutoscalerSettings": {
    "scale-down-utilization-threshold": 0.1,
    "scale-down-gpu-utilization-threshold": 0.1,
    "scale-down-delay-after-add": "string",
    "scale-down-unneeded-time": "string",
    "scale-down-unready-time": "string",
    "max-node-provision-time": "string",
    "unremovable-node-recheck-timeout": "string"
  },
  "upstreamCluster": {
    "identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
    "slug": {
      "slugValue": "string"
    },
    "environmentSlug": {
      "slugValue": "string"
    },
    "version": "string"
  }
}

Update a cluster.

Request Body

statusstring

versionstring

cnistring

updateChannelstring

environmentSlugstring

enableNetworkEncryptionboolean

podSecurityStandardsProfilestring

enableAutoUpgradeboolean

enableHighAvailabilityboolean

deleteProtectionboolean

ipWhitelistarray<object>

Object 1

addonsobject

Attributes

cloudCredentialsIdentitystring

maintenanceScheduleIdentitystring

clusterAutoscalerSettingsobject

Attributes

upstreamClusterobject

Attributes

Path Parameters

organisationSlugRequiredstring

environmentSlugRequiredstring

clusterSlugRequiredstring

Response

TypeScript

`status`string

`version`string

`cni`string

`updateChannel`string

`environmentSlug`string

`enableNetworkEncryption`boolean

`podSecurityStandardsProfile`string

`enableAutoUpgrade`boolean

`enableHighAvailability`boolean

`deleteProtection`boolean

`ipWhitelist`array<object>

`addons`object

`cloudCredentialsIdentity`string

`maintenanceScheduleIdentity`string

`clusterAutoscalerSettings`object

`upstreamCluster`object

`organisationSlug`
Required
string

`environmentSlug`
Required
string

`clusterSlug`
Required
string