Avisi cloud logo
Clusters

Create cluster inside an environment.

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

Request Body

application/jsonRequired
nameRequiredstring
Minimum length: 3Maximum length: 255Pattern: "^[a-zA-Z0-9\\-\\s&]*$"
descriptionstring
Minimum length: 3Maximum length: 500
cloudAccountIdentityRequiredstring
Format: "uuid"
regionRequiredstring
Minimum length: 1Maximum length: 255
versionRequiredstring
Minimum length: 3Maximum length: 255
updateChannelstring
Minimum length: 3Maximum length: 255
enableNATGatewayboolean
Default: "false"
enableNetworkEncryptionboolean
Default: "false"
enablePodSecurityStandardsDeprecatedboolean
Default: "false"
podSecurityStandardsProfilestring
Default: "baseline"Value in: "privileged" | "baseline" | "restricted"
enableMultiAvailabilityZonesboolean
Default: "false"
enableAutoUpgradeboolean
Default: "false"
enableHAboolean
Default: "false"
enableHighAvailabilityboolean
Default: "false"
cnistring
Default: "cilium"Value in: "custom" | "cilium" | "calico"
serviceSubnetstring
clusterPodSubnetstring
nodePoolsRequiredarray<object>
ipWhitelistarray<object>
addonsobject
maintenanceScheduleIdentitystring
Format: "uuid"
clusterAutoscalerSettingsobject
upstreamClusterobject

Path Parameters

organisationSlugRequiredstring
Pattern: "^[a-z0-9-]+$"
environmentSlugRequiredstring
Pattern: "^[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.

namestring
identitystring
Format: "uuid"
environmentIdentitystring
Format: "uuid"
maintenanceScheduleobject
environmentSlugobject
customerIdentitystring
Format: "uuid"
customerSlugobject
poolIDinteger
Format: "int64"
poolNamestring
slugobject
descriptionstring
cloudProviderstring
regionstring
versionstring
updateChannelobject
autoUpgradeboolean
highlyAvailableboolean
enableNetworkEncryptionboolean
podSecurityStandardsProfilestring
Value in: "privileged" | "baseline" | "restricted"
cnistring
Value in: "custom" | "cilium" | "calico"
enableMultiAvailabilityZonesboolean
enableNATGatewayboolean
serviceSubnetstring
clusterPodSubnetstring
statusstring
Value in: "new" | "provisioning" | "provisioned" | "starting" | "started" | "stopping" | "stopped" | "deleting" | "deleted" | "unknown"
desiredStatusstring
Value in: "starting" | "stopping" | "deleting"
provisionStatusstring
Value in: "UNKNOWN" | "ACCEPTED" | "OIDC_PROVISIONED" | "CLUSTER_PROVISIONED" | "INITIAL_NODE_POOLS_PROVISIONED" | "INITIAL_ADDONS_PROVISIONED" | "DONE"
createdAtstring
Format: "date-time"
modifiedAtstring
Format: "date-time"
deletedAtstring
Format: "date-time"
memoryinteger
Format: "int64"
cpuinteger
Format: "int64"
ipWhitelistarray<object>

@minItems 0

ameOIDCboolean
deleteProtectionboolean
addonsobject
observabilityTenantobject
environmentPrometheusRulesboolean
cloudAccountobject
cloudCredentialsobject
actualStateobject
clusterAutoscalerSettingsobject
upstreamClusterobject
curl -X POST "https://api.avisi.cloud/api/v1/orgs/string/clusters/string" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "cloudAccountIdentity": "763d6cbd-4c53-4613-bba9-cb8f34de18a7",
    "region": "string",
    "version": "string",
    "updateChannel": "string",
    "enableNATGateway": "false",
    "enableNetworkEncryption": "false",
    "enablePodSecurityStandards": "false",
    "podSecurityStandardsProfile": "privileged",
    "enableMultiAvailabilityZones": "false",
    "enableAutoUpgrade": "false",
    "enableHA": "false",
    "enableHighAvailability": "false",
    "cni": "custom",
    "serviceSubnet": "string",
    "clusterPodSubnet": "string",
    "nodePools": [
      {
        "name": "string",
        "nodeSize": "string",
        "autoScaling": "false",
        "enableNodeAutoReplacement": true,
        "enableNodeReboots": "false",
        "upgradeStrategy": "REPLACE",
        "minSize": "0",
        "maxSize": "0",
        "availabilityZone": "string",
        "annotations": {
          "property1": "string",
          "property2": "string"
        },
        "labels": {
          "property1": "string",
          "property2": "string"
        },
        "taints": [
          {
            "key": "string",
            "value": "string",
            "effect": "string"
          }
        ]
      }
    ],
    "ipWhitelist": [
      {
        "cidr": "string",
        "description": "string"
      }
    ],
    "addons": {
      "property1": {
        "enabled": true,
        "customValues": {
          "property1": "string",
          "property2": "string"
        }
      },
      "property2": {
        "enabled": true,
        "customValues": {
          "property1": "string",
          "property2": "string"
        }
      }
    },
    "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"
  }
}

List node types of a cloud provider. GET

Previous Page

Create node pool inside a cluster. POST

Next Page