---
title: "Retrieve all vCluster by given project"
method: GET
path: "/api/v1/virtual-cluster/{parentProjectId}"
tags: ["Virtual Cluster"]
---

# Retrieve all vCluster by given project

`GET /api/v1/virtual-cluster/{parentProjectId}`

## Path parameters

- `parentProjectId` integer, required

## Query parameters

- `Limit` integer
- `Offset` integer
- `SortBy` string
- `SortDirection` string
- `Search` string
- `SearchId` string
- `Id` integer

## Response `200`

OK

- VClusterList
  - `data` VClusterListDto[], nullable, required
    - `id` integer, required
    - `name` string, required
    - `isVirtualCluster` boolean, required
    - `isLocked` boolean, required
    - `hasKubeConfigFile` boolean, required
    - `isMaintenanceModeEnabled` boolean, required
    - `organizationName` string, required
    - `organizationId` integer, required
    - `kubernetesVersion` string, required
    - `createdAt` string, required
    - `createdBy` string, required
    - `lastModified` string, required
    - `lastModifiedBy` string, required
    - `alertsCount` integer, required
    - `expiredAt` string, required
    - `deleteOnExpiration` boolean, required
    - `wasmEnabled` boolean, required
    - `alertingProfileId` integer, nullable, required
    - `alertingProfileName` string, nullable, required
    - `accessIp` string, required
    - `cloudType` 'AWS' | 'AZURE' | 'GOOGLE' | 'OPENSTACK' | 'PROXMOX' | 'TANZU' | 'OPENSHIFT' | 'VSPHERE' | 'ZADARA' | 'ZEDEDA' | 'EKS' | 'AKS' | 'GKE' | 'GENERICKUBERNETES', required
    - `status` 'Null' | 'Deleting' | 'DisableAi' | 'DisableGatekeeper' | 'DeletingBackupPolicies' | 'DisableBackup' | 'DisableMonitoring' | 'EnableBackup' | 'EnableMonitoring' | 'EnableAi' | 'EnableGatekeeper' | 'Failure' | 'FailedUpgrade' | 'Purging' | 'Ready' | 'Updating' | 'Upgrading' | 'UpdatingCredentials' | 'UninstallVirtualCluster' | 'Repairing' | 'Importing' | 'FailedToImport' | 'Migrating', required
    - `health` 'Null' | 'Healthy' | 'None' | 'Unhealthy' | 'Unknown' | 'Warning', required
    - `workloadResources` VClusterWorkloadResourcesListDto
      - `maxPods` integer, required
      - `maxPvcs` integer, required
      - `maxTotalPvcSize` integer, required
      - `maxIngresses` integer, required
      - `maxLoadBalancers` integer, required
    - `cpuLimits` VClusterResourceLimitsListDto
      - `resourceUnit` string, nullable, required
      - `maxClusterRequests` number, double, required
      - `maxClusterLimits` number, double, required
      - `defaultContainerLimit` number, double, required
      - `defaultContainerRequest` number, double, required
    - `ramLimits` VClusterResourceLimitsListDto
      - `resourceUnit` string, nullable, required
      - `maxClusterRequests` number, double, required
      - `maxClusterLimits` number, double, required
      - `defaultContainerLimit` number, double, required
      - `defaultContainerRequest` number, double, required
    - `ephemeralStorageLimits` VClusterResourceLimitsListDto
      - `resourceUnit` string, nullable, required
      - `maxClusterRequests` number, double, required
      - `maxClusterLimits` number, double, required
      - `defaultContainerLimit` number, double, required
      - `defaultContainerRequest` number, double, required
    - `lockButton` ButtonStatusDto, required
      - `enable` boolean
      - `reasons` string[], nullable
      - `hidden` boolean
    - `unlockButton` ButtonStatusDto, required
      - `enable` boolean
      - `reasons` string[], nullable
      - `hidden` boolean
    - `deleteButton` ButtonStatusDto, required
      - `enable` boolean
      - `reasons` string[], nullable
      - `hidden` boolean
    - `kubeInfoButton` ButtonStatusDto, required
      - `enable` boolean
      - `reasons` string[], nullable
      - `hidden` boolean
    - `setExpirationDateButton` ButtonStatusDto, required
      - `enable` boolean
      - `reasons` string[], nullable
      - `hidden` boolean
    - `resetStatusButton` ButtonStatusDto, required
      - `enable` boolean
      - `reasons` string[], nullable
      - `hidden` boolean
  - `totalCount` integer, required
  - `project` ProjectDetailsForVmsDto, required
    - `status` 'Null' | 'Deleting' | 'DisableAi' | 'DisableGatekeeper' | 'DeletingBackupPolicies' | 'DisableBackup' | 'DisableMonitoring' | 'EnableBackup' | 'EnableMonitoring' | 'EnableAi' | 'EnableGatekeeper' | 'Failure' | 'FailedUpgrade' | 'Purging' | 'Ready' | 'Updating' | 'Upgrading' | 'UpdatingCredentials' | 'UninstallVirtualCluster' | 'Repairing' | 'Importing' | 'FailedToImport' | 'Migrating', required
    - `name` string, required
    - `id` integer, required
    - `cloudType` 'AWS' | 'AZURE' | 'GOOGLE' | 'OPENSTACK' | 'PROXMOX' | 'TANZU' | 'OPENSHIFT' | 'VSPHERE' | 'ZADARA' | 'ZEDEDA' | 'EKS' | 'AKS' | 'GKE' | 'GENERICKUBERNETES', required
    - `cloudName` string, required
    - `cloudId` integer, nullable, required
    - `organizationName` string, required
    - `organizationId` integer, required
    - `isLocked` boolean, required
    - `isProjectMaintenanceModeEnabled` boolean, required
    - `hasSelectedFlavors` boolean, nullable, required
    - `isMaintenanceModeEnabled` boolean, required
    - `isDrsEnabled` boolean, required
    - `projectCloudRevision` integer, nullable, required
    - `cloudCredentialRevision` integer, nullable, required
    - `allowFullSpotKubernetes` boolean, required
    - `allowSpotWorkers` boolean, required
    - `allowSpotVMs` boolean, required
    - `maxSpotPrice` number, double, nullable, required
    - `totalHourlyCost` number, double, required
    - `availabilityZones` string[], nullable, required
    - `hypervisors` string[], nullable, required
    - `expiredAt` string, nullable, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `500` — Internal Server Error

---

[API](https://skmtc.dev/taikun/apis/taikun-webapi.md) · [All operations](https://skmtc.dev/taikun/apis/taikun-webapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/taikun/taikun-webapi/revisions/09395964d191/schema)