> ## 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.

# List vcenters

> **Authorisation:** `vcenter:List` on `krn:celum:vcenter:*`.

**Assistant tool:** `list_vcenters`



## OpenAPI

````yaml /openapi.json get /api/vcenters
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/vcenters:
    get:
      tags:
        - platform-settings
      summary: List vcenters
      description: |-
        **Authorisation:** `vcenter:List` on `krn:celum:vcenter:*`.

        **Assistant tool:** `list_vcenters`
      operationId: get_vcenters
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.vcenterListResponse'
          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.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Internal Server Error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Service Unavailable.
components:
  schemas:
    api.vcenterListResponse:
      properties:
        storeMessage:
          type: string
        storeWritable:
          type: boolean
        vcenters:
          items:
            $ref: '#/components/schemas/api.VCenterView'
          nullable: true
          type: array
      required:
        - storeMessage
        - storeWritable
        - vcenters
      type: object
      x-go-type: backend/internal/api.vcenterListResponse
    api.ErrorBody:
      properties:
        error:
          type: string
      required:
        - error
      type: object
    api.VCenterView:
      properties:
        caPem:
          type: string
        certNotAfter:
          format: date-time
          type: string
        certSubject:
          type: string
        createdAt:
          format: date-time
          type: string
        createdBy:
          type: string
        credentialSetAt:
          format: date-time
          type: string
        credentialStored:
          type: boolean
        description:
          type: string
        name:
          type: string
        propagation:
          items:
            $ref: '#/components/schemas/api.vcenterPropagation'
          type: array
        sdkUrl:
          type: string
        secretRef:
          type: string
        server:
          type: string
        sha1Thumbprint:
          type: string
        updatedAt:
          format: date-time
          type: string
        usedBy:
          items:
            $ref: '#/components/schemas/api.vcenterUser'
          nullable: true
          type: array
        username:
          type: string
        verified:
          type: string
        verifiedAt:
          format: date-time
          type: string
      required:
        - caPem
        - certSubject
        - createdAt
        - createdBy
        - credentialSetAt
        - credentialStored
        - description
        - name
        - sdkUrl
        - secretRef
        - server
        - sha1Thumbprint
        - updatedAt
        - usedBy
        - username
      type: object
      x-go-type: backend/internal/api.VCenterView
    api.vcenterPropagation:
      properties:
        action:
          type: string
        consumer:
          type: string
        name:
          type: string
        supervisor:
          type: string
      required:
        - action
        - consumer
        - name
        - supervisor
      type: object
      x-go-type: backend/internal/api.vcenterPropagation
    api.vcenterUser:
      properties:
        consumer:
          type: string
        name:
          type: string
        supervisor:
          type: string
      required:
        - consumer
        - name
        - supervisor
      type: object
      x-go-type: backend/internal/api.vcenterUser
  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.