mirror of
				https://github.com/grafana/grafana.git
				synced 2025-02-25 18:55:37 -06:00 
			
		
		
		
	Docs: Add example for updating dashboard panel alert rule (#25260)
This commit is contained in:
		
				
					committed by
					
						
						GitHub
					
				
			
			
				
	
			
			
			
						parent
						
							78febbbeef
						
					
				
				
					commit
					8f72d621bf
				
			@@ -60,6 +60,163 @@ JSON Body schema:
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
**Example Response**:
 | 
			
		||||
 | 
			
		||||
```http
 | 
			
		||||
HTTP/1.1 200 OK
 | 
			
		||||
Content-Type: application/json; charset=UTF-8
 | 
			
		||||
Content-Length: 78
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Status Codes:
 | 
			
		||||
 | 
			
		||||
- **200** – Created
 | 
			
		||||
- **400** – Errors (invalid json, missing or invalid fields, etc)
 | 
			
		||||
- **401** – Unauthorized
 | 
			
		||||
- **403** – Access denied
 | 
			
		||||
- **412** – Precondition failed
 | 
			
		||||
 | 
			
		||||
The **412** status code is used for explaining that you cannot create the dashboard and why.
 | 
			
		||||
There can be different reasons for this:
 | 
			
		||||
 | 
			
		||||
- The dashboard has been changed by someone else, `status=version-mismatch`
 | 
			
		||||
- A dashboard with the same name in the folder already exists, `status=name-exists`
 | 
			
		||||
- A dashboard with the same uid already exists, `status=name-exists`
 | 
			
		||||
- The dashboard belongs to plugin `<plugin title>`, `status=plugin-dashboard`
 | 
			
		||||
 | 
			
		||||
 The response body will have the following properties:
 | 
			
		||||
 | 
			
		||||
```http
 | 
			
		||||
HTTP/1.1 412 Precondition Failed
 | 
			
		||||
Content-Type: application/json; charset=UTF-8
 | 
			
		||||
Content-Length: 97
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
In case of title already exists the `status` property will be `name-exists`.
 | 
			
		||||
 | 
			
		||||
## Get dashboard by uid
 | 
			
		||||
 | 
			
		||||
`GET /api/dashboards/uid/:uid`
 | 
			
		||||
 | 
			
		||||
Will return the dashboard given the dashboard unique identifier (uid).
 | 
			
		||||
 | 
			
		||||
**Example Request**:
 | 
			
		||||
 | 
			
		||||
```http
 | 
			
		||||
GET /api/dashboards/uid/cIBgcSjkk HTTP/1.1
 | 
			
		||||
Accept: application/json
 | 
			
		||||
Content-Type: application/json
 | 
			
		||||
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
**Example Response**:
 | 
			
		||||
 | 
			
		||||
```http
 | 
			
		||||
HTTP/1.1 200
 | 
			
		||||
Content-Type: application/json
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Status Codes:
 | 
			
		||||
 | 
			
		||||
- **200** – Found
 | 
			
		||||
- **401** – Unauthorized
 | 
			
		||||
- **403** – Access denied
 | 
			
		||||
- **404** – Not found
 | 
			
		||||
 | 
			
		||||
## Delete dashboard by uid
 | 
			
		||||
 | 
			
		||||
`DELETE /api/dashboards/uid/:uid`
 | 
			
		||||
 | 
			
		||||
Will delete the dashboard given the specified unique identifier (uid).
 | 
			
		||||
 | 
			
		||||
**Example Request**:
 | 
			
		||||
 | 
			
		||||
```http
 | 
			
		||||
DELETE /api/dashboards/uid/cIBgcSjkk HTTP/1.1
 | 
			
		||||
Accept: application/json
 | 
			
		||||
Content-Type: application/json
 | 
			
		||||
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
**Example Response**:
 | 
			
		||||
 | 
			
		||||
```http
 | 
			
		||||
HTTP/1.1 200
 | 
			
		||||
Content-Type: application/json
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Status Codes:
 | 
			
		||||
 | 
			
		||||
- **200** – Deleted
 | 
			
		||||
- **401** – Unauthorized
 | 
			
		||||
- **403** – Access denied
 | 
			
		||||
- **404** – Not found
 | 
			
		||||
 | 
			
		||||
## Gets the home dashboard
 | 
			
		||||
 | 
			
		||||
`GET /api/dashboards/home`
 | 
			
		||||
 | 
			
		||||
Will return the home dashboard.
 | 
			
		||||
 | 
			
		||||
**Example Request**:
 | 
			
		||||
 | 
			
		||||
```http
 | 
			
		||||
GET /api/dashboards/home HTTP/1.1
 | 
			
		||||
Accept: application/json
 | 
			
		||||
Content-Type: application/json
 | 
			
		||||
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
**Example Response**:
 | 
			
		||||
 | 
			
		||||
```http
 | 
			
		||||
HTTP/1.1 200
 | 
			
		||||
Content-Type: application/json
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Tags for Dashboard
 | 
			
		||||
 | 
			
		||||
`GET /api/dashboards/tags`
 | 
			
		||||
 | 
			
		||||
Get all tags of dashboards
 | 
			
		||||
 | 
			
		||||
**Example Request**:
 | 
			
		||||
 | 
			
		||||
```http
 | 
			
		||||
GET /api/dashboards/tags HTTP/1.1
 | 
			
		||||
Accept: application/json
 | 
			
		||||
Content-Type: application/json
 | 
			
		||||
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
**Example Response**:
 | 
			
		||||
 | 
			
		||||
```http
 | 
			
		||||
HTTP/1.1 200
 | 
			
		||||
Content-Type: application/json
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Dashboard Search
 | 
			
		||||
See [Folder/Dashboard Search API]({{< relref "folder_dashboard_search.md" >}}).
 | 
			
		||||
 | 
			
		||||
## Deprecated resources
 | 
			
		||||
Please note that these resource have been deprecated and will be removed in a future release.
 | 
			
		||||
 | 
			
		||||
### Get dashboard by slug
 | 
			
		||||
**Deprecated starting from Grafana v5.0. Please update to use the new *Get dashboard by uid* resource instead**
 | 
			
		||||
 | 
			
		||||
`GET /api/dashboards/db/:slug`
 | 
			
		||||
 | 
			
		||||
Will return the dashboard given the dashboard slug. Slug is the URL friendly version of the dashboard title.
 | 
			
		||||
If there exists multiple dashboards with the same slug, one of them will be returned in the response.
 | 
			
		||||
 | 
			
		||||
**Example Request**:
 | 
			
		||||
 | 
			
		||||
```http
 | 
			
		||||
GET /api/dashboards/db/production-overview HTTP/1.1
 | 
			
		||||
Accept: application/json
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user