Grafana Clean API

openapi: 3.0.3
info:
  title: Grafana HTTP Access Clean API
  description: The Grafana HTTP API provides programmatic access to Grafana's core functionality including dashboards, data sources, alerts, users, organizations, folders, annotations, and teams. Authentication is handled via API keys, basic auth, or OAuth tokens passed in the Authorization header.
  version: 11.0.0
  contact:
    name: Grafana Labs
    url: https://grafana.com
  license:
    name: AGPL-3.0
    url: https://www.gnu.org/licenses/agpl-3.0.html
servers:
- url: https://{instance}.grafana.net/api
  description: Grafana Cloud
  variables:
    instance:
      default: your-instance
- url: http://localhost:3000/api
  description: Local Grafana instance
security:
- BearerAuth: []
- BasicAuth: []
- ApiKeyAuth: []
tags:
- name: Clean
paths:
  /datasources/{dataSourceUID}/cache/clean:
    parameters: []
    post:
      tags:
      - Clean
      summary: Grafana Clean Data Source Cache
      description: This API operation allows you to clear the cache for a specific data source in Grafana by sending a POST request to the endpoint with the data source's unique identifier (UID). When invoked, it removes all cached query results and stored data associated with that particular data source, forcing subsequent queries to fetch fresh data directly from the source. This is useful when you need to ensure users see the most up-to-date information, troubleshoot data inconsistencies, or after making configuration changes to the data source that might affect cached results.
      operationId: cleanDataSourceCache
      parameters:
      - name: dataSourceUID
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: CacheConfigResponse
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CacheConfigResponse'
        '500':
          description: InternalServerError is a general error indicating something went wrong internally.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseBody'
      deprecated: false
      x-api-evangelist-processing:
        SplitPascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
components:
  schemas:
    ErrorResponseBody:
      title: ErrorResponseBody
      required:
      - message
      type: object
      properties:
        error:
          type: string
          description: Error An optional detailed description of the actual error. Only included if running in developer mode.
        message:
          type: string
          description: a human readable version of the error
        status:
          type: string
          description: 'Status An optional status to denote the cause of the error.


            For example, a 412 Precondition Failed error may include additional information of why that error happened.'
    CacheConfigResponse:
      title: CacheConfigResponse
      type: object
      properties:
        created:
          type: string
          contentEncoding: date-time
        dataSourceID:
          type: integer
          description: Fields that can be set by the API caller - read/write
          contentEncoding: int64
        dataSourceUID:
          type: string
        defaultTTLMs:
          type: integer
          description: 'These are returned by the HTTP API, but are managed internally - read-only

            Note: ''created'' and ''updated'' are special properties managed automatically by xorm, but we are setting them manually'
          contentEncoding: int64
        enabled:
          type: boolean
        message:
          type: string
        ttlQueriesMs:
          type: integer
          description: TTL MS, or "time to live", is how long a cached item will stay in the cache before it is removed (in milliseconds)
          contentEncoding: int64
        ttlResourcesMs:
          type: integer
          contentEncoding: int64
        updated:
          type: string
          contentEncoding: date-time
        useDefaultTTL:
          type: boolean
          description: If UseDefaultTTL is enabled, then the TTLQueriesMS and TTLResourcesMS in this object is always sent as the default TTL located in grafana.ini
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Service account token or API key
    BasicAuth:
      type: http
      scheme: basic
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Format: Bearer <api-key>'