[release-12.3.0] Restructure As code and developer resources (#113969)

Co-authored-by: Roberto Jiménez Sánchez <roberto.jimenez@grafana.com> Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com>
2025-11-16 19:06:56 +00:00
parent 0898ec6045
commit 047da1442e
96 changed files with 8186 additions and 230 deletions
@@ -0,0 +1,261 @@
+---
+aliases:
+  - ../../../http_api/playlist/ # /docs/grafana/next/http_api/playlist/
+  - ../../../developers/http_api/playlist/ # /docs/grafana/next/developers/http_api/playlist/
+canonical: https://grafana.com/docs/grafana/latest/developer-resources/api-reference/http-api/playlist/
+description: Playlist Admin HTTP API
+keywords:
+  - grafana
+  - http
+  - documentation
+  - api
+  - playlist
+labels:
+  products:
+    - enterprise
+    - oss
+    - cloud
+title: 'Playlist HTTP API '
+---
+
+# Playlist API
+
+## Search Playlist
+
+`GET /api/playlists`
+
+Get all existing playlist for the current organization using pagination
+
+**Example Request**:
+
+```http
+GET /api/playlists HTTP/1.1
+Accept: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```
+
+Querystring Parameters:
+
+These parameters are used as querystring parameters.
+
+- **query** - Limit response to playlist having a name like this value.
+- **limit** - Limit response to _X_ number of playlist.
+
+**Example Response**:
+
+```http
+HTTP/1.1 200
+Content-Type: application/json
+[
+```
+
+## Get one playlist
+
+`GET /api/playlists/:uid`
+
+**Example Request**:
+
+```http
+GET /api/playlists/1 HTTP/1.1
+Accept: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```
+
+**Example Response**:
+
+```http
+HTTP/1.1 200
+Content-Type: application/json
+{
+```
+
+## Get Playlist items
+
+`GET /api/playlists/:uid/items`
+
+**Example Request**:
+
+```http
+GET /api/playlists/1/items HTTP/1.1
+Accept: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```
+
+**Example Response**:
+
+```http
+HTTP/1.1 200
+Content-Type: application/json
+[
+```
+
+## Create a playlist
+
+`POST /api/playlists/`
+
+**Example Request**:
+
+```http
+PUT /api/playlists/1 HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+  {
+    "name": "my playlist",
+    "interval": "5m",
+    "items": [
+      {
+        "type": "dashboard_by_uid",
+        "value": "3",
+        "order": 1,
+        "title":"my third dashboard"
+      },
+      {
+        "type": "dashboard_by_tag",
+        "value": "myTag",
+        "order": 2,
+        "title":"my other dashboard"
+      }
+    ]
+  }
+```
+
+**Example Response**:
+
+```http
+HTTP/1.1 200
+Content-Type: application/json
+  {
+    "uid": "1",
+    "name": "my playlist",
+    "interval": "5m"
+  }
+```
+
+## Update a playlist
+
+`PUT /api/playlists/:uid`
+
+**Example Request**:
+
+```http
+PUT /api/playlists/1 HTTP/1.1
+Accept: application/json
+Content-Type: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+  {
+    "name": "my playlist",
+    "interval": "5m",
+    "items": [
+      {
+        "playlistUid": "1",
+        "type": "dashboard_by_uid",
+        "value": "3",
+        "order": 1,
+        "title":"my third dashboard"
+      },
+      {
+        "playlistUid": "1",
+        "type": "dashboard_by_tag",
+        "value": "myTag",
+        "order": 2,
+        "title":"my other dashboard"
+      }
+    ]
+  }
+```
+
+**Example Response**:
+
+```http
+HTTP/1.1 200
+Content-Type: application/json
+{
+```
+
+## Delete a playlist
+
+`DELETE /api/playlists/:uid`
+
+**Example Request**:
+
+```http
+DELETE /api/playlists/1 HTTP/1.1
+Accept: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```
+
+**Example Response**:
+
+```http
+HTTP/1.1 200
+Content-Type: application/json
+{}
+```
+      {
+        "playlistUid": "1",
+        "type": "dashboard_by_uid",
+        "value": "3",
+        "order": 1,
+        "title":"my third dashboard"
+      },
+      {
+        "playlistUid": "1",
+        "type": "dashboard_by_tag",
+        "value": "myTag",
+        "order": 2,
+        "title":"my other dashboard"
+      }
+    ]
+  }
+```
+
+**Example Response**:
+
+```http
+HTTP/1.1 200
+Content-Type: application/json
+{
+  "uid" : "1",
+  "name": "my playlist",
+  "interval": "5m",
+  "items": [
+    {
+      "id": 1,
+      "playlistUid": "1",
+      "type": "dashboard_by_uid",
+      "value": "3",
+      "order": 1,
+      "title":"my third dashboard"
+    },
+    {
+      "id": 2,
+      "playlistUid": "1",
+      "type": "dashboard_by_tag",
+      "value": "myTag",
+      "order": 2,
+      "title":"my other dashboard"
+    }
+  ]
+}
+```
+
+## Delete a playlist
+
+`DELETE /api/playlists/:uid`
+
+**Example Request**:
+
+```http
+DELETE /api/playlists/1 HTTP/1.1
+Accept: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```
+
+**Example Response**:
+
+```http
+HTTP/1.1 200
+Content-Type: application/json
+{}
+```