mirror of
https://github.com/grafana/grafana.git
synced 2025-02-16 18:34:52 -06:00
b78a67cec7
* Format md,mdx files with prettier on lint-staged * Manually run prettier on docs/sources
283 lines
4.7 KiB
Markdown
283 lines
4.7 KiB
Markdown
+++
|
|
title = "Playlist HTTP API "
|
|
description = "Playlist Admin HTTP API"
|
|
keywords = ["grafana", "http", "documentation", "api", "playlist"]
|
|
aliases = ["/docs/grafana/latest/http_api/playlist/"]
|
|
+++
|
|
|
|
# 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/:id`
|
|
|
|
**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/:id/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
|
|
[
|
|
```
|
|
|
|
## Get Playlist dashboards
|
|
|
|
`GET /api/playlists/:id/dashboards`
|
|
|
|
**Example Request**:
|
|
|
|
```http
|
|
GET /api/playlists/1/dashboards 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_id",
|
|
"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
|
|
{
|
|
"id": 1,
|
|
"name": "my playlist",
|
|
"interval": "5m"
|
|
}
|
|
```
|
|
|
|
## Update a playlist
|
|
|
|
`PUT /api/playlists/:id`
|
|
|
|
**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": [
|
|
{
|
|
"playlistId": 1,
|
|
"type": "dashboard_by_id",
|
|
"value": "3",
|
|
"order": 1,
|
|
"title":"my third dashboard"
|
|
},
|
|
{
|
|
"playlistId": 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/:id`
|
|
|
|
**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
|
|
{}
|
|
```
|