Avisi cloud logo
Clusters

List clusters inside an environment for an organisation.

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

Path Parameters

organisationSlug
Required
string

environmentSlug
Required
string

Query Parameters

show-computeboolean

Optional. Default false. If true, returns accumulated compute information of environment in response.

Default: false

includeDetailsboolean

Optional. Default false. If true, returns actual cluster status in response.

Default: true

pageable
Required
object

Optional. When omitted: pageSize=50, pageNumber=0, sortDirection=ASC

curl -X GET "http://localhost:8090/api/v1/orgs/string/clusters/string?show-compute=false&includeDetails=true&pageable=%7B%0A++%22page%22%3A+0%2C%0A++%22size%22%3A+1%2C%0A++%22sort%22%3A+%5B%0A++++%22string%22%0A++%5D%0A%7D"

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

{
  "totalElements": 0,
  "totalPages": 0,
  "content": [
    {
      "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": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "number": 0,
  "size": 0,
  "first": true,
  "last": true,
  "sort": [
    {
      "direction": "string",
      "nullHandling": "string",
      "ascending": true,
      "property": "string",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "sort": [
      {
        "direction": "string",
        "nullHandling": "string",
        "ascending": true,
        "property": "string",
        "ignoreCase": true
      }
    ],
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "unpaged": true
  },
  "empty": true
}