Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
N
nexpie-grafana-theme
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Registry
Registry
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Kornkitt Poolsup
nexpie-grafana-theme
Commits
bd0bf374
Commit
bd0bf374
authored
Apr 22, 2015
by
Torkel Ödegaard
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Began work on http api docs, #1822
parent
a11b1804
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
131 additions
and
1 deletions
+131
-1
docs/sources/reference/http_api.md
+131
-1
No files found.
docs/sources/reference/http_api.md
View file @
bd0bf374
...
...
@@ -6,5 +6,135 @@ page_keywords: grafana, admin, http, api, documentation
# HTTP API Reference
This documentation page has yet to be written.
The Grafana backend exposes an HTTP API, the same API is used by the frontend to do everything from saving
dashboards, creating users and updating data sources.
## Authorization
Currently you can authenticate via an
`API Token`
or via a
`Session cookie`
(acquired using regular login or oauth).
### Create API Token
Open the sidemenu and click the organization dropdown and select the
`API Keys`
option.
!
[
](/img/v2/orgdropdown_api_keys.png)
You use the token in all requests in the
`Authorization`
header, like this:
**Example**
:
GET http://your.grafana.com/api/dashboards/db/mydash HTTP/1.1
Accept: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
The
`Authorization`
header value should be
`Bearer <your api key>`
.
## Dashboards
### Create or Update dashboard
`POST /api/dashboards/db`
Creates a new dashboard or updates an existing dashboard.
**Example Request for new dashboard**
:
POST /api/dashboards/db HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
"dashboard": {
"id": null,
"title": "Production Overview",
"tags": [ "templated" ],
"timezone": "browser",
"rows": [
{
}
]
"schemaVersion": 6,
"version": 0
},
"overwrite": false
}
JSON Body schema:
-
**dashboard**
– The complete dashboard model, id = null to create a new dashboard
-
**overwrite**
– Set to true if you want to overwrite existing dashboard with new version or with same dashboard title.
**Example Response**
:
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Date: Wed, 22 Apr 2015 11:12:06 GMT
Content-Length: 78
{
"slug": "production-overview",
"status": "success",
"version": 1
}
Status Codes:
-
**200**
– Created
-
**400**
– Errors (invalid json, missing or invalid fields, etc)
-
**401**
– Unauthorized
-
**412**
– Precondition failed
The
**412**
status code is used when a newer dashboard already exists (newer, its version is greater than the verison that was sent). The
same status code is also used if another dashboar exists with the same title. The response body will look like this:
HTTP/1.1 412 Precondition Failed
Content-Type: application/json; charset=UTF-8
Content-Length: 97
{
"message": "The dashboard has been changed by someone else",
"status": "version-mismatch"
}
In in case of title already exists the
`status`
property will be
`name-exists`
.
### Get dashboard
`GET /api/dashboards/db/:slug`
Will return the dashboard given the dashboard slug. Slug is the url friendly version of the dashboard title.
**Example Request**
:
GET /api/dashboards/db/production-overview HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
{
"meta": {
"isStarred": false,
"slug": "production-overview"
},
"dashboard": {
"id": null,
"title": "Production Overview",
"tags": [ "templated" ],
"timezone": "browser",
"rows": [
{
}
]
"schemaVersion": 6,
"version": 0
},
}
## Data sources
## Organizations
## Users
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment