Grafana Dependencies API

openapi: 3.2.0
info:
  title: Grafana Dependencies API
  description: 'Grafana is an open-source analytics and visualization platform that helps you monitor and analyze data from various sources. It lets you create customizable dashboards with charts, graphs, and alerts to visualize metrics and logs in real-time. Commonly used for monitoring infrastructure, applications, and business metrics, Grafana connects to dozens of data sources like Prometheus, Elasticsearch, and cloud platforms, making it easier to understand system performance, troubleshoot issues, and track key indicators all in one place. '
  contact:
    name: Grafana Labs
    url: https://grafana.com
    email: hello@grafana.com
  version: 0.0.1
servers:
- url: http://{defaultHost}
  variables:
    defaultHost:
      default: www.example.com/api
- url: https://{defaultHost}
  variables:
    defaultHost:
      default: www.example.com/api
security:
- basic: []
- api_key: []
tags:
- name: Dependencies
paths:
  /cloudmigration/resources/dependencies:
    parameters: []
    get:
      tags:
      - Dependencies
      summary: Grafana Get Resource Dependencies
      description: This API operation retrieves the dependencies for resources involved in a cloud migration process within Grafana. When called, it analyzes and returns information about the relationships and dependencies between various Grafana resources (such as dashboards, data sources, folders, and other configuration elements) that need to be considered during a cloud migration. This is particularly useful for understanding which resources must be migrated together to maintain functionality and avoid broken references, helping administrators plan and execute a complete and successful migration from a self-hosted Grafana instance to Grafana Cloud or between different Grafana environments.
      operationId: getResourceDependencies
      parameters: []
      responses:
        '200':
          description: (empty)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceDependenciesResponseDTO'
      deprecated: false
      x-api-evangelist-processing:
        SplitPascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
components:
  schemas:
    Dependency:
      title: Dependency
      enum:
      - DASHBOARD
      - DATASOURCE
      - FOLDER
      - LIBRARY_ELEMENT
      - ALERT_RULE
      - ALERT_RULE_GROUP
      - CONTACT_POINT
      - NOTIFICATION_POLICY
      - NOTIFICATION_TEMPLATE
      - MUTE_TIMING
      - PLUGIN
      type: string
    ResourceDependencyDTO:
      title: ResourceDependencyDTO
      type: object
      properties:
        dependencies:
          type: array
          items:
            $ref: '#/components/schemas/Dependency'
          description: ''
        resourceType:
          $ref: '#/components/schemas/ResourceType'
    ResourceDependenciesResponseDTO:
      title: ResourceDependenciesResponseDTO
      type: object
      properties:
        resourceDependencies:
          type: array
          items:
            $ref: '#/components/schemas/ResourceDependencyDTO'
          description: ''
    ResourceType:
      title: ResourceType
      enum:
      - DASHBOARD
      - DATASOURCE
      - FOLDER
      - LIBRARY_ELEMENT
      - ALERT_RULE
      - ALERT_RULE_GROUP
      - CONTACT_POINT
      - NOTIFICATION_POLICY
      - NOTIFICATION_TEMPLATE
      - MUTE_TIMING
      - PLUGIN
      type: string
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header
    basic:
      type: http
      scheme: basic