> ## Documentation Index
> Fetch the complete documentation index at: https://docs.celum.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get vcluster status

> Wizard-native vCluster (Step 8) — loft-sh/vcluster Shared Nodes mode.

**Authorisation:** `vcluster:GetStatus` on `krn:celum:supervisor:{name}:vcluster:*`.

**Assistant tool:** `get_component_status`



## OpenAPI

````yaml /openapi.json get /api/supervisors/{name}/vcluster/status
openapi: 3.0.3
info:
  description: >-
    The HTTP surface of the Celum backend, generated from its own router and

    authorisation map — so this list cannot drift from the server that serves
    it.


    **Every operation states the IAM action and resource it is authorised

    against.** That pairing is the part worth reading: a policy naming the right

    action against the wrong resource matches nothing, and fails silently.


    Request and response bodies come from the Go types the handlers send and

    decode. Where those types do not determine the shape (an interface, a

    map[string]any, an unknown custom encoding), the operation says so in

    `x-celum-schema-gap` instead of carrying a guessed schema.
  title: Celum API
  version: 1.0.0
servers:
  - description: Your Celum deployment
    url: https://{host}
    variables:
      host:
        default: celum.example.com
        description: The host your Celum backend is served from
security:
  - sessionCookie: []
  - bearerToken: []
tags:
  - description: AI assistant & MCP
    name: ai-assistant
  - description: Clusters & CAPI lifecycle
    name: capi
  - description: Certificates & external secrets
    name: certs
  - description: GitOps & apps
    name: gitops
  - description: IAM, audit & auth
    name: iam
  - description: Image library
    name: images
  - description: Infrastructure & supervisors
    name: infrastructure
  - description: Networking
    name: networking
  - description: Observability & platform health
    name: observability
  - description: Platform onboarding & settings
    name: platform-settings
  - description: Projects
    name: projects
  - description: Registries & mirroring
    name: registries
  - description: Security & flows
    name: security
  - description: Storage
    name: storage
  - description: Templates & addons
    name: templates
  - description: Virtualization platform (KubeVirt/CDI)
    name: virt
  - description: Virtual machines
    name: vms
  - description: Workloads & topology
    name: workloads
paths:
  /api/supervisors/{name}/vcluster/status:
    get:
      tags:
        - capi
      summary: Get vcluster status
      description: >-
        Wizard-native vCluster (Step 8) — loft-sh/vcluster Shared Nodes mode.


        **Authorisation:** `vcluster:GetStatus` on
        `krn:celum:supervisor:{name}:vcluster:*`.


        **Assistant tool:** `get_component_status`
      operationId: get_supervisors_byName_vcluster_status
      parameters:
        - description: >-
            The supervisor's name, as registered under Administration →
            Supervisors.
          in: path
          name: name
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.vClusterStatusResponse'
          description: Success.
        '401':
          description: Not authenticated — no valid session cookie or API token.
        '403':
          description: >-
            Authenticated, but no policy allows this action on this resource.
            The body carries the action and resource that were evaluated.
components:
  schemas:
    api.vClusterStatusResponse:
      properties:
        instances:
          items:
            $ref: '#/components/schemas/api.vClusterInstance'
          nullable: true
          type: array
      required:
        - instances
      type: object
      x-go-type: backend/internal/api.vClusterStatusResponse
    api.vClusterInstance:
      properties:
        chartVersion:
          type: string
        enableIngress:
          type: boolean
        enableOidc:
          type: boolean
        enableServiceMonitor:
          type: boolean
        exportKubeConfig:
          type: boolean
        helmRelease:
          $ref: '#/components/schemas/api.helmReleaseStatus'
        highAvailability:
          type: boolean
        ingressHost:
          type: string
        integrateCertManager:
          type: boolean
        integrateKubeVirt:
          type: boolean
        integrateMetricsServer:
          type: boolean
        k8sVersion:
          type: string
        kubeconfigAvailable:
          type: boolean
        name:
          type: string
        namespace:
          type: string
        oidcSecretConfigured:
          type: boolean
        resourceProfile:
          type: string
        serviceType:
          type: string
        storageClassName:
          type: string
        storageSize:
          type: string
      required:
        - enableIngress
        - enableOidc
        - enableServiceMonitor
        - exportKubeConfig
        - helmRelease
        - highAvailability
        - integrateCertManager
        - integrateKubeVirt
        - integrateMetricsServer
        - kubeconfigAvailable
        - name
        - namespace
        - oidcSecretConfigured
      type: object
      x-go-type: backend/internal/api.vClusterInstance
    api.helmReleaseStatus:
      properties:
        conditions:
          items:
            $ref: '#/components/schemas/api.helmReleaseCondition'
          type: array
        error:
          type: string
        exists:
          type: boolean
        installFailures:
          format: int64
          type: integer
        lastAttemptedRevision:
          type: string
        message:
          type: string
        ready:
          type: boolean
        reason:
          type: string
        revision:
          type: string
        upgradeFailures:
          format: int64
          type: integer
      required:
        - exists
        - ready
      type: object
      x-go-type: backend/internal/api.helmReleaseStatus
    api.helmReleaseCondition:
      properties:
        message:
          type: string
        reason:
          type: string
        status:
          type: string
        type:
          type: string
      required:
        - message
        - reason
        - status
        - type
      type: object
      x-go-type: backend/internal/api.helmReleaseCondition
  securitySchemes:
    sessionCookie:
      description: >-
        The session cookie issued by the OIDC sign-in flow. This is what a
        browser uses.
      in: cookie
      name: k8s-gate-session
      type: apiKey
    bearerToken:
      description: >-
        An API token, minted from your own identity page. A token carries the
        IAM groups you held **when it was minted**, and cannot bypass deletion
        approval — except for guest clusters inside a project that same token
        created.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.