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

# Get the Grafana connection

> Returns how the tenant's Grafana is connected, including the metrics instance ID (username) for Grafana Cloud metrics and scrape_config, the Prometheus and Grafana Alloy configuration that scrapes the CostGraph agent on each host. A host is read from a connection only when its agent config names the connection's public_id, and is matched on the instance label equal to its metrics_instance setting, or its hostname when that is not set, with or without a trailing .local and :port. When Grafana is not connected, every field except scrape_config is null, so the scrape configuration can be shown before connecting. The token is never returned.



## OpenAPI

````yaml /api-reference/costgraph/openapi.json get /api/v1/integrations/grafana
openapi: 3.0.0
info:
  description: Read and manage your CostGraph organization, spend, alerts, and settings.
  title: CostGraph API
  contact: {}
  version: '1.0'
servers:
  - url: https://api.costgraph.ai
security: []
tags:
  - name: ai
    x-group: AI
  - name: ai-serving
    x-group: AI serving
  - name: anomalies
    x-group: Anomalies
  - name: auth
    x-group: Auth
  - name: billing
    x-group: Billing
  - name: billing-export
    x-group: Billing export
  - name: budgets
    x-group: Budgets
  - name: ci
    x-group: CI
  - name: compute-recommendations
    x-group: Compute recommendations
  - name: config
    x-group: Config
  - name: context-graph
    x-group: Context graph
  - name: cost
    x-group: Cost
  - name: gpus
    x-group: GPUs
  - name: graphai
    x-group: Graph AI
  - name: integrations
    x-group: Integrations
  - name: invitations
    x-group: Invitations
  - name: kubernetes-clusters
    x-group: Kubernetes clusters
  - name: marketplace
    x-group: Marketplace
  - name: network-requests
    x-group: Network requests
  - name: notifications
    x-group: Notifications
  - name: oauth
    x-group: OAuth
  - name: oauth-clients
    x-group: OAuth clients
  - name: opencost
    x-group: OpenCost
  - name: organization
    x-group: Audit log
  - name: organizations
    x-group: Organizations
  - name: placement-alternatives
    x-group: Placement alternatives
  - name: reports
    x-group: Reports
  - name: service-map
    x-group: Service map
  - name: settings
    x-group: Settings
  - name: sso
    x-group: Single sign-on
  - name: tenants
    x-group: Tenants
  - name: ticketing
    x-group: Ticketing
  - name: user
    x-group: Users
  - name: virtual-machines
    x-group: Virtual machines
  - name: virtual-tags
    x-group: Virtual tags
  - name: workflows
    x-group: Workflows
paths:
  /api/v1/integrations/grafana:
    get:
      tags:
        - integrations
      summary: Get the Grafana connection
      description: >-
        Returns how the tenant's Grafana is connected, including the metrics
        instance ID (username) for Grafana Cloud metrics and scrape_config, the
        Prometheus and Grafana Alloy configuration that scrapes the CostGraph
        agent on each host. A host is read from a connection only when its agent
        config names the connection's public_id, and is matched on the instance
        label equal to its metrics_instance setting, or its hostname when that
        is not set, with or without a trailing .local and :port. When Grafana is
        not connected, every field except scrape_config is null, so the scrape
        configuration can be shown before connecting. The token is never
        returned.
      parameters:
        - description: Tenant ID
          name: X-CostGraph-Tenant-ID
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/responses.SuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: >-
                          #/components/schemas/integrations.grafanaSourceResponse
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    responses.SuccessResponse:
      type: object
      required:
        - message
        - status
      properties:
        data: {}
        message:
          type: string
          example: some message
        status:
          type: string
          example: success
    integrations.grafanaSourceResponse:
      type: object
      properties:
        auth_mode:
          type: string
          enum:
            - basic
            - grafana_service_account
          nullable: true
        connection_id:
          type: string
          nullable: true
        connection_modes:
          type: array
          items:
            type: string
            enum:
              - cost
              - metrics
          nullable: true
        datasource_uid:
          type: string
          nullable: true
        extra_matchers:
          type: string
          nullable: true
        label_filters:
          type: object
          additionalProperties:
            type: string
          nullable: true
        public_id:
          type: string
          nullable: true
        scrape_config:
          $ref: '#/components/schemas/grafana.ScrapeSnippets'
        updated_at:
          type: string
          nullable: true
        url:
          type: string
          nullable: true
        username:
          type: string
          nullable: true
    responses.ErrorResponse:
      type: object
      required:
        - message
        - status
      properties:
        message:
          type: string
          example: some message
        status:
          type: string
          example: error
    grafana.ScrapeSnippets:
      type: object
      properties:
        alloy:
          type: string
        prometheus:
          type: string
  securitySchemes:
    BearerAuth:
      description: Enter "Bearer {token}"
      type: apiKey
      name: Authorization
      in: header

````

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