Clusters
Update a cluster.
Request Body
application/json
Requiredstatus
stringValue in:
"starting" | "stopping" | "deleting"
version
stringcni
stringValue in:
"custom" | "cilium" | "calico"
updateChannel
stringenvironmentSlug
stringenableNetworkEncryption
booleanpodSecurityStandardsProfile
stringValue in:
"privileged" | "baseline" | "restricted"
enableAutoUpgrade
booleanenableHighAvailability
booleandeleteProtection
booleanipWhitelist
array<object>addons
objectcloudCredentialsIdentity
stringFormat:
"uuid"
maintenanceScheduleIdentity
stringFormat:
"uuid"
clusterAutoscalerSettings
objectupstreamCluster
objectPath Parameters
organisationSlug
RequiredstringPattern:
"^[a-z0-9-]+$"
environmentSlug
RequiredstringPattern:
"^[a-z0-9-]+$"
clusterSlug
RequiredstringPattern:
"^[a-z0-9-]+$"
Response Body
Request was successfully processed. The response body contains the requested data.
TypeScript Definitions
Use the response body type in TypeScript.
name
stringidentity
stringFormat:
"uuid"
environmentIdentity
stringFormat:
"uuid"
maintenanceSchedule
objectenvironmentSlug
objectcustomerIdentity
stringFormat:
"uuid"
customerSlug
objectpoolID
integerFormat:
"int64"
poolName
stringslug
objectdescription
stringcloudProvider
stringregion
stringversion
stringupdateChannel
objectautoUpgrade
booleanhighlyAvailable
booleanenableNetworkEncryption
booleanpodSecurityStandardsProfile
stringValue in:
"privileged" | "baseline" | "restricted"
cni
stringValue in:
"custom" | "cilium" | "calico"
enableMultiAvailabilityZones
booleanenableNATGateway
booleanserviceSubnet
stringclusterPodSubnet
stringstatus
stringValue in:
"new" | "provisioning" | "provisioned" | "starting" | "started" | "stopping" | "stopped" | "deleting" | "deleted" | "unknown"
desiredStatus
stringValue in:
"starting" | "stopping" | "deleting"
provisionStatus
stringValue in:
"UNKNOWN" | "ACCEPTED" | "OIDC_PROVISIONED" | "CLUSTER_PROVISIONED" | "INITIAL_NODE_POOLS_PROVISIONED" | "INITIAL_ADDONS_PROVISIONED" | "DONE"
createdAt
stringFormat:
"date-time"
modifiedAt
stringFormat:
"date-time"
deletedAt
stringFormat:
"date-time"
memory
integerFormat:
"int64"
cpu
integerFormat:
"int64"
ipWhitelist
array<object>@minItems 0
ameOIDC
booleandeleteProtection
booleanaddons
objectobservabilityTenant
objectenvironmentPrometheusRules
booleancloudAccount
objectcloudCredentials
objectactualState
objectclusterAutoscalerSettings
objectupstreamCluster
objectcurl -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"
}
}'
{
"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"
}
}