Avisi cloud logo
OpenapiGenerated

Create cluster inside an environment.

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

Path Parameters

organisationSlug*string
Match^[a-z0-9-_]+$
environmentSlug*string
Match^[a-z0-9-_]+$

Request Body

application/json
  1. body
name*string
Match^[a-zA-Z0-9\-\s&]*$
Length3 <= length <= 25
description?string
Length3 <= length <= 500
cloudAccountIdentity*string
Formatuuid
region*string
Length1 <= length <= 255
version*string
Length3 <= length <= 255
updateChannel?string
Length3 <= length <= 255
enableNATGateway?boolean
Defaultfalse
enableNetworkEncryption?boolean
Defaultfalse
enablePodSecurityStandards?booleanDeprecated
Defaultfalse
podSecurityStandardsProfile?string
Default"baseline"
Value in"privileged""baseline""restricted"
enableMultiAvailabilityZones?boolean
Defaultfalse
enableAutoUpgrade?boolean
Defaultfalse
enableHA?boolean
Defaultfalse
enableHighAvailability?boolean
Defaultfalse
cni?string
Default"cilium"
Value in"custom""cilium""calico"
serviceSubnet?string
clusterPodSubnet?string
nodePools*array<>
ipWhitelist?array<>
addons?
maintenanceScheduleIdentity?string
Formatuuid
clusterAutoscalerSettings?
upstreamCluster?

Response Body

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

application/json
  1. response
name?string
identity?string
Formatuuid
environmentIdentity?string
Formatuuid
maintenanceSchedule?
environmentSlug?
customerIdentity?string
Formatuuid
customerSlug?
poolID?|
Formatint64
poolName?string|null
slug?
description?string|null
cloudProvider?string
region?string
version?string
updateChannel?
autoUpgrade?boolean
highlyAvailable?boolean
enableNetworkEncryption?boolean
podSecurityStandardsProfile?string
Value in"privileged""baseline""restricted"
cni?string
Value in"custom""cilium""calico"
enableMultiAvailabilityZones?boolean
enableNATGateway?boolean
serviceSubnet?string|null
clusterPodSubnet?string|null
status?|
Value in"new""provisioning""provisioned""starting""started""stopping""stopped""deleting""deleted""unknown"
desiredStatus?string
Value in"starting""stopping""deleting"
provisionStatus?string
Value in"UNKNOWN""ACCEPTED""OIDC_PROVISIONED""CLUSTER_PROVISIONED""INITIAL_NODE_POOLS_PROVISIONED""INITIAL_ADDONS_PROVISIONED""DONE"
createdAt?string
Formatdate-time
modifiedAt?string
Formatdate-time
deletedAt?|
Formatdate-time
memory?integer
Formatint64
cpu?integer
Formatint64
ipWhitelist?array<>
ameOIDC?boolean
deleteProtection?boolean
addons?
observabilityTenant?
environmentPrometheusRules?boolean
cloudAccount?
cloudCredentials?
actualState?
clusterAutoscalerSettings?
upstreamCluster?
downstreamClusters?array<>
curl -X POST 'https://api.avisi.cloud/api/v1/orgs/string/clusters/string' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "cloudAccountIdentity": "763d6cbd-4c53-4613-bba9-cb8f34de18a7",  "region": "string",  "version": "string",  "nodePools": [    {      "name": "string"    }  ]}'
{  "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",    "monitoringPushUrl": "string",    "loggingPushUrl": "string",    "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,    "scale-down-gpu-utilization-threshold": 0,    "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"  },  "downstreamClusters": [    {      "identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",      "slug": {        "slugValue": "string"      },      "environmentSlug": {        "slugValue": "string"      },      "version": "string"    }  ]}