Avisi cloud logo
Clusters

Create cluster inside an environment.

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

Request Body

application/jsonRequired
namestring
Pattern"^[a-zA-Z0-9\\-\\s&]*$"
Length3 <= length <= 255
description?string
Length3 <= length <= 500
cloudAccountIdentitystring
Format"uuid"
regionstring
Length1 <= length <= 255
versionstring
Length3 <= length <= 255
updateChannel?string
Length3 <= length <= 255
enableNATGateway?boolean
Default"false"
enableNetworkEncryption?boolean
Default"false"
enablePodSecurityStandards?booleanDeprecated
Default"false"
podSecurityStandardsProfile?string
Default"baseline"
Value in"privileged" | "baseline" | "restricted"
enableMultiAvailabilityZones?boolean
Default"false"
enableAutoUpgrade?boolean
Default"false"
enableHA?boolean
Default"false"
enableHighAvailability?boolean
Default"false"
cni?string
Default"cilium"
Value in"custom" | "cilium" | "calico"
serviceSubnet?string
clusterPodSubnet?string
nodePoolsarray<object>
ipWhitelist?array<object>
addons?object

Empty Object

maintenanceScheduleIdentity?string
Format"uuid"
clusterAutoscalerSettings?object
upstreamCluster?object

Path Parameters

organisationSlugstring
Pattern"^[a-z0-9-]+$"
environmentSlugstring
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.

name?string
identity?string
Format"uuid"
environmentIdentity?string
Format"uuid"
maintenanceSchedule?object
environmentSlug?object
customerIdentity?string
Format"uuid"
customerSlug?object
poolID?integer
Format"int64"
poolName?string
slug?object
description?string
cloudProvider?string
region?string
version?string
updateChannel?object
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
clusterPodSubnet?string
status?string
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
Format"date-time"
modifiedAt?string
Format"date-time"
deletedAt?string
Format"date-time"
memory?integer
Format"int64"
cpu?integer
Format"int64"
ipWhitelist?array<object>

@minItems 0

ameOIDC?boolean
deleteProtection?boolean
addons?object

Empty Object

observabilityTenant?object
environmentPrometheusRules?boolean
cloudAccount?object
cloudCredentials?object
actualState?object
clusterAutoscalerSettings?object
upstreamCluster?object

Invalid request parameters. Please review the documentation for valid parameter values.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

You do not have the necessary permissions to access this resource.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

The requested resource could not be found. Please check the resource URL or identifier.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

An internal error occurred on the server.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown
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",
        "nodeSize": "string"
      }
    ]
  }'
const body = JSON.stringify({
  "name": "string",
  "cloudAccountIdentity": "763d6cbd-4c53-4613-bba9-cb8f34de18a7",
  "region": "string",
  "version": "string",
  "nodePools": [
    {
      "name": "string",
      "nodeSize": "string"
    }
  ]
})

fetch("https://api.avisi.cloud/api/v1/orgs/string/clusters/string", {
  body
})
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
  "strings"
)

func main() {
  url := "https://api.avisi.cloud/api/v1/orgs/string/clusters/string"
  body := strings.NewReader(`{
    "name": "string",
    "cloudAccountIdentity": "763d6cbd-4c53-4613-bba9-cb8f34de18a7",
    "region": "string",
    "version": "string",
    "nodePools": [
      {
        "name": "string",
        "nodeSize": "string"
      }
    ]
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://api.avisi.cloud/api/v1/orgs/string/clusters/string"
body = {
  "name": "string",
  "cloudAccountIdentity": "763d6cbd-4c53-4613-bba9-cb8f34de18a7",
  "region": "string",
  "version": "string",
  "nodePools": [
    {
      "name": "string",
      "nodeSize": "string"
    }
  ]
}
response = requests.request("POST", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)
{
  "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"
  }
}
{
  "message": "string",
  "details": [
    "string"
  ]
}
{
  "message": "string",
  "details": [
    "string"
  ]
}
{
  "message": "string",
  "details": [
    "string"
  ]
}
{
  "message": "string",
  "details": [
    "string"
  ]
}

List node types of a cloud provider. GET

Previous Page

Create node pool inside a cluster. POST

Next Page