Grafana Options API

openapi: 3.0.3
info:
  title: Grafana HTTP Access Options 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: Options
paths:
  /search/sorting:
    parameters: []
    get:
      tags:
      - Options
      summary: Grafana List Sort Options
      description: This API operation retrieves the available sorting options that can be used when searching or listing resources in Grafana. When called using a GET request to the /search/sorting endpoint, it returns the various sorting criteria and methods supported by the Grafana search functionality, allowing clients to understand how they can order search results such as by name, date, relevance, or other applicable metadata fields. This endpoint is typically used by frontend applications or integrations that need to present sorting options to users or programmatically sort Grafana resources in a consistent manner.
      operationId: listSortOptions
      parameters: []
      responses:
        '200':
          description: (empty)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/listSortOptionsResponse'
        '401':
          description: UnauthorizedError is returned when the request is not authenticated.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseBody'
      deprecated: false
      x-api-evangelist-processing:
        SplitPascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
  /snapshot/shared-options:
    parameters: []
    get:
      tags:
      - Options
      summary: Grafana Get Sharing Options
      description: This API operation retrieves the available sharing options for snapshots in Grafana. When invoked via a GET request to the /snapshot/shared-options endpoint, it returns configuration details about how snapshots can be shared, including available sharing methods, permissions, and any constraints or settings that govern snapshot sharing behavior within the Grafana instance. This information is useful for determining what sharing capabilities are enabled and how users can distribute dashboard snapshots to others.
      operationId: getSharingOptions
      parameters: []
      responses:
        '200':
          description: (empty)
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getSharingOptionsResponse'
        '401':
          description: UnauthorizedError is returned when the request is not authenticated.
          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.'
    getSharingOptionsResponse:
      title: getSharingOptionsResponse
      type: object
      properties:
        externalEnabled:
          type: boolean
        externalSnapshotName:
          type: string
        externalSnapshotURL:
          type: string
    listSortOptionsResponse:
      title: listSortOptionsResponse
      type: object
      properties:
        description:
          type: string
        displayName:
          type: string
        meta:
          type: string
        name:
          type: string
  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>'