> ## 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 Cluster Metrics Source Endpoint

> Returns the cluster's registered metrics source: provider, endpoint, state, flavor, health, the credential name it resolves to (back-filled from the cluster's only prometheus_credential when the source never named one), and that credential's name, state and username.

Mirrors the web UI endpoint but uses bearer-token auth for CLI access. The credential's password and token are never returned.
Returns 404 when the cluster has no metrics source; 400 with the detail "Unknown metrics provider, please check the metrics source configuration." when the stored source resolves to no provider (today: a definition without an endpoint); and 502 with a detail naming the credential when the named credential or its secret cannot be resolved.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /api/v1/org/clusters/imported/{cluster_id}/metrics-source
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/org/clusters/imported/{cluster_id}/metrics-source:
    get:
      tags:
        - Imported Clusters
      summary: Get Cluster Metrics Source Endpoint
      description: >-
        Returns the cluster's registered metrics source: provider, endpoint,
        state, flavor, health, the credential name it resolves to (back-filled
        from the cluster's only prometheus_credential when the source never
        named one), and that credential's name, state and username.


        Mirrors the web UI endpoint but uses bearer-token auth for CLI access.
        The credential's password and token are never returned.

        Returns 404 when the cluster has no metrics source; 400 with the detail
        "Unknown metrics provider, please check the metrics source
        configuration." when the stored source resolves to no provider (today: a
        definition without an endpoint); and 502 with a detail naming the
        credential when the named credential or its secret cannot be resolved.
      operationId: >-
        get_cluster_metrics_source_endpoint_api_v1_org_clusters_imported__cluster_id__metrics_source_get
      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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetClusterMetricsSourceResult'
          description: Successful Response
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '502':
          description: Bad Gateway
components:
  schemas:
    GetClusterMetricsSourceResult:
      properties:
        credential:
          anyOf:
            - $ref: '#/components/schemas/PrometheusCredentialResource'
            - type: 'null'
        credential_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Credential Name
        endpoint:
          title: Endpoint
          type: string
        flavor:
          anyOf:
            - type: string
            - type: 'null'
          title: Flavor
        health:
          anyOf:
            - $ref: '#/components/schemas/MetricsSourceHealth'
            - type: 'null'
        provider:
          title: Provider
          type: string
        state:
          title: State
          type: string
      required:
        - endpoint
        - provider
        - state
      title: GetClusterMetricsSourceResult
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    PrometheusCredentialResource:
      description: >-
        The non-secret identity of a metrics-source credential as the read lanes
        return it. The password and token never serialise.
      properties:
        name:
          title: Name
          type: string
        state:
          title: State
          type: string
        username:
          anyOf:
            - type: string
            - type: 'null'
          title: Username
      required:
        - name
        - state
      title: PrometheusCredentialResource
      type: object
    MetricsSourceHealth:
      properties:
        checked_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Checked At
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
        sample_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Sample Count
        state:
          title: State
          type: string
      required:
        - state
      title: MetricsSourceHealth
      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

````