GET
/
api
/
svc
/
v1
/
clusters
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/clusters \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "fqn": "<string>",
      "name": "<string>",
      "manifest": {
        "type": "cluster",
        "name": "<string>",
        "cluster_type": "aws-eks",
        "environment_names": [
          "<string>"
        ],
        "base_domains": [
          "<string>"
        ],
        "monitoring": {
          "loki_url": "<string>",
          "prometheus_url": "<string>",
          "kubecost_url": "<string>"
        },
        "default_registry_fqn": "<string>",
        "workbench_config": {
          "notebook_config": {
            "base_domain": "<string>"
          },
          "ssh_server_config": {
            "base_domain": "<string>",
            "port": 123
          },
          "default_storage_class": "<string>"
        },
        "cluster_integration_fqn": "<string>",
        "workflow_storage_integration_fqn": "<string>",
        "supported_nodepools": [
          {
            "name": "<string>",
            "description": "<string>",
            "capacityType": "on-demand",
            "deviceTypeToMaxCountMap": {},
            "taints": [
              {
                "key": "<string>",
                "value": "<string>",
                "effect": "<string>"
              }
            ],
            "instanceResources": {
              "cpu": 123,
              "memoryMB": 123,
              "ephemeralStorageMB": 123,
              "devices": [
                {
                  "type": "nvidia_gpu",
                  "gpuType": "P4",
                  "count": 123,
                  "configuration": [
                    {
                      "type": "nvidia_gpu",
                      "count": 123,
                      "deviceIdentifier": "<string>",
                      "migProfile": "<string>",
                      "perInstanceGpuMemory": 123,
                      "slicesPerFullGpu": 123,
                      "nvidiaDevicePluginConfig": "<string>"
                    }
                  ]
                }
              ],
              "gpuCount": 123,
              "gpuType": "<string>"
            }
          }
        ],
        "node_label_keys": {
          "nodepool_selector_label": "<string>"
        },
        "collaborators": [
          {
            "subject": "<string>",
            "role_id": "<string>"
          }
        ]
      },
      "tenantName": "<string>",
      "createdBySubject": {
        "subjectId": "<string>",
        "subjectType": "user",
        "subjectSlug": "<string>",
        "subjectDisplayName": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:100

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

​
offset
integer
default:0

Number of items to skip

Required range: x >= 0
Example:

0

Response

200
application/json
Retrieve latest Clusters. If pagination parameters are provided, the response includes paginated data.
​
data
object[]
required

Array of cluster

​
pagination
object
required

Pagination information