Grafana Items API

openapi: 3.0.3
info:
  title: Grafana HTTP Access Items 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: Items
paths:
  /playlists/{uid}/items:
    parameters: []
    get:
      tags:
      - Items
      summary: Grafana Get Playlist Items
      description: This API operation retrieves all items associated with a specific playlist in Grafana by providing the playlist's unique identifier (uid) in the URL path. When called with a GET request, it returns a list of dashboard references that are configured to be displayed in sequence as part of the specified playlist, including details such as the dashboard titles, IDs, and their order within the playlist rotation.
      operationId: getPlaylistItems
      parameters:
      - name: uid
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: (empty)
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlaylistItemDTO'
                description: ''
                contentMediaType: application/json
        '401':
          description: UnauthorizedError is returned when the request is not authenticated.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseBody'
        '403':
          description: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseBody'
        '404':
          description: NotFoundError is returned when the requested resource was not found.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseBody'
        '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.'
    PlaylistItemDTO:
      title: PlaylistItemDTO
      type: object
      properties:
        title:
          type: string
          description: Title is an unused property -- it will be removed in the future
        type:
          type: string
          description: Type of the item.
        value:
          type: string
          description: 'Value depends on type and describes the playlist item.


            dashboard_by_id: The value is an internal numerical identifier set by Grafana. This

            is not portable as the numerical identifier is non-deterministic between different instances.

            Will be replaced by dashboard_by_uid in the future. (deprecated)

            dashboard_by_tag: The value is a tag which is set on any number of dashboards. All

            dashboards behind the tag will be added to the playlist.

            dashboard_by_uid: The value is the dashboard UID'
  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>'