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

# Get Kubernetes Resources Endpoint



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /api/v1/clusters/{cluster_id}/kubernetes/resources/get
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - name: Clusters
    description: Create, inspect and manage clusters, and the stacks deployed on them.
  - name: Managed Clusters
    description: Provider-managed control planes, driven through one common surface.
  - name: Imported Clusters
    description: Clusters that already existed and were connected to Ankra.
  - name: Cluster Access
    description: Kubeconfigs, service-account tokens and per-cluster access grants.
  - name: Kubernetes
    description: Read and act on the Kubernetes objects inside a cluster.
  - name: DigitalOcean Clusters
    description: Provision and manage DigitalOcean Kubernetes clusters.
  - name: Hetzner Clusters
    description: Provision and manage Hetzner Kubernetes clusters.
  - name: OVH Clusters
    description: Provision and manage OVH Kubernetes clusters.
  - name: Scaleway Clusters
    description: Provision and manage Scaleway Kapsule clusters.
  - name: UpCloud Clusters
    description: Provision and manage UpCloud Kubernetes clusters.
  - name: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - name: Charts
    description: Browse the chart catalogue behind stacks and addons.
  - name: Helm
    description: Helm registries, credentials and the charts they expose.
  - name: Executions
    description: Long-running platform executions and their jobs.
  - name: Operations
    description: Cancel in-flight cluster operations and their jobs.
  - name: Chat
    description: Conversational sessions, plans and confirmable actions.
  - name: AI Agent Runs
    description: Autonomous agent runs and their outcomes.
  - name: AI Tickets
    description: The AI ticket board, its sync connections and settings.
  - name: AI Playbooks
    description: Reusable playbooks the AI lanes execute.
  - name: AI Conditions
    description: Conditions that gate AI autonomy.
  - name: AI Engineering Handoffs
    description: Work the AI lanes escalate to a human engineer.
  - name: AI Environment
    description: The environment and base stacks AI demos deploy into.
  - name: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - name: Azure Credentials
    description: Azure credentials and SSH keys.
  - name: DigitalOcean Credentials
    description: DigitalOcean credentials and SSH keys.
  - name: Hetzner Credentials
    description: Hetzner credentials and SSH keys.
  - name: OVH Credentials
    description: OVH credentials and SSH keys.
  - name: Scaleway Credentials
    description: Scaleway credentials.
  - name: UpCloud Credentials
    description: UpCloud credentials and SSH keys.
  - name: Data Source Credentials
    description: Credentials for metrics and log sources.
  - name: DNS Credentials
    description: Credentials for DNS providers.
  - name: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - name: SOPS
    description: Encrypt and decrypt values with the organisation SOPS config.
  - name: Alerts
    description: Alert integrations and ingest credentials.
  - name: Notifications
    description: Notification routes and their delivery targets.
  - name: Support
    description: Support tickets.
paths:
  /api/v1/clusters/{cluster_id}/kubernetes/resources/get:
    post:
      tags:
        - Kubernetes
      summary: Get Kubernetes Resources Endpoint
      operationId: >-
        get_kubernetes_resources_endpoint_api_v1_clusters__cluster_id__kubernetes_resources_get_post
      parameters:
        - in: path
          name: cluster_id
          required: true
          schema:
            format: uuid4
            title: Cluster Id
            type: string
        - in: header
          name: authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Ankra-Organisation-Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetKubernetesResourcesRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKubernetesResourcesResponse'
          description: Successful Response
        '401':
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: '"permission_denied" (requires kubernetes.read)'
        '404':
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    GetKubernetesResourcesRequest:
      properties:
        resource_requests:
          items:
            $ref: '#/components/schemas/GetKubernetesResourcesRequestItem'
          title: Resource Requests
          type: array
        skip_cache:
          default: false
          title: Skip Cache
          type: boolean
      required:
        - resource_requests
      title: GetKubernetesResourcesRequest
      type: object
    GetKubernetesResourcesResponse:
      properties:
        resource_responses:
          items:
            $ref: '#/components/schemas/GetKubernetesResourcesResponseItem'
          title: Resource Responses
          type: array
      required:
        - resource_responses
      title: GetKubernetesResourcesResponse
      type: object
    ContractDetailError:
      example:
        detail: Cluster not found
      properties:
        detail:
          oneOf:
            - type: string
            - additionalProperties: true
              properties: {}
              type: object
      required:
        - detail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    GetKubernetesResourcesRequestItem:
      properties:
        continue_token:
          anyOf:
            - type: string
            - type: 'null'
          title: Continue Token
        field_selectors:
          anyOf:
            - items:
                $ref: '#/components/schemas/FieldSelector'
              type: array
            - type: 'null'
          title: Field Selectors
        group:
          anyOf:
            - type: string
            - type: 'null'
          title: Group
        kind:
          type: string
          title: Kind
        label_selector:
          anyOf:
            - type: string
            - type: 'null'
          title: Label Selector
        limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Limit
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        namespace:
          anyOf:
            - type: string
            - type: 'null'
          title: Namespace
        resource:
          anyOf:
            - type: string
            - type: 'null'
          title: Resource
        version:
          default: v1
          title: Version
          type: string
      required:
        - kind
      title: GetKubernetesResourcesRequestItem
      type: object
    GetKubernetesResourcesResponseItem:
      properties:
        cache_metadata:
          anyOf:
            - $ref: '#/components/schemas/CacheMetadataResponse'
            - type: 'null'
        continue_token:
          anyOf:
            - type: string
            - type: 'null'
          title: Continue Token
        error_response:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Response
        group:
          anyOf:
            - type: string
            - type: 'null'
          title: Group
        items:
          items: {}
          title: Items
          type: array
        kind:
          type: string
          title: Kind
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        namespace:
          anyOf:
            - type: string
            - type: 'null'
          title: Namespace
        not_found:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Not Found
        status:
          $ref: '#/components/schemas/Status'
        total_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total Count
        version:
          title: Version
          type: string
      required:
        - status
        - items
        - kind
        - version
      title: GetKubernetesResourcesResponseItem
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    FieldSelector:
      properties:
        field:
          title: Field
          type: string
        value:
          title: Value
          type: string
      required:
        - field
        - value
      title: FieldSelector
      type: object
    CacheMetadataResponse:
      properties:
        deleted_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Deleted At
        is_deleted:
          default: false
          title: Is Deleted
          type: boolean
        served_from_cache:
          title: Served From Cache
          type: boolean
        staleness_seconds:
          title: Staleness Seconds
          type: integer
        sync_status:
          title: Sync Status
          type: string
        warning:
          anyOf:
            - type: string
            - type: 'null'
          title: Warning
      required:
        - served_from_cache
        - staleness_seconds
        - sync_status
      title: CacheMetadataResponse
      type: object
    Status:
      enum:
        - success
        - error
      title: Status
      type: string

````