Dashboard HTTP API

Contents

• Dashboard HTTP API

  • Create dashboard

  • Update dashboard

  • Get dashboard

  • Delete dashboard

  • Get dashboard tags

  • Search dashboards

  • Dashboard Rendered PNGs

  • Grafana HTTP API

Hosted Graphite supports an HTTP API which allows you to fetch, create, and update your primary dashboards.

Create dashboard

Create dashboard

POST /api/v2/grafana/dashboards

200: OK HTTP/1.1 200 Content-Type: application/json { "slug": "production-overview", "status": "success", "version": 1 }

400: Bad Request Invalid JSON

409: Conflict Dashboard already exists

Curl example:

curl -X POST https://[e-mail]/api/v2/grafana/dashboards/ \
     -d @dashboard.json

Example dashboard.json file:

{
    "title": "Production Overview",
    "tags": [ "templated" ],
    "timezone": "browser",
    "panels": [
        {
        }
    ],
    "schemaVersion": 6,
    "version": 0
}

This example creates a dashboard with the name “Production Overview” in accordance with the title field above.

---

Update dashboard

Update dashboard

PUT /api/v2/grafana/dashboards

200: OK HTTP/1.1 200 Content-Type: application/json { "slug": "production-overview", "status": "success", "version": 2 }

400: Bad Request Invalid JSON

Curl example:

curl -X PUT https://[e-mail]/api/v2/grafana/dashboards/ \
     -d @dashboard.json

Example dashboard:

{
    "id": 1
    "title": "Production Overview",
    "tags": [ "templated", "prod" ],
    "timezone": "browser",
    "panels": [
        {
        }
    ],
    "schemaVersion": 6,
    "message": "version control message" // this is optional
}

---

Get dashboard

Get dashboard

GET /api/v2/grafana/dashboards/:slug

Returns a dashboard given the dashboard slug, a url friendly version of the dashboard title.

200: OK HTTP/1.1 200 Content-Type: application/json { "meta": { "isStarred": false, "slug": "production-overview" }, "model": { "id": null, "title": "Production Overview", "tags": [ "templated" ], "timezone": "browser", "panels": [ { } ] "schemaVersion": 6, "version": 0 }, }

400: Bad Request No dashboard specified

404: Not Found Dashboard not found

Curl examples:

curl -X GET https://[e-mail]/api/v2/grafana/search\?

Returns all dashboard/folder information

curl -X GET https://[e-mail]/api/v2/grafana/dashboards/production-overview

Returns the JSON model of a dashboard with the title of 'production overview'

---

Delete dashboard

Delete dashboard

DELETE /api/v2/grafana/dashboards/:slug

Deletes a dashboard given the dashboard slug.

200: OK HTTP/1.1 200 Content-Type: application/json {"title": "Production Overview"}

400: Bad Request No dashboard specified

404: Not Found Dashboard not found

Curl example:

curl -X DELETE https://[e-mail]/api/v2/grafana/dashboards/production-overview

---

Get dashboard tags

List dashboard tags

GET /api/v2/grafana/tags

200: OK HTTP/1.1 200 Content-Type: application/json [ { "term":"templated", "count":1 }, { "term":"production", "count":4 } ]

Curl example:

curl -X GET https://[e-mail]/api/v2/grafana/tags

---

Search dashboards

Search dashboards

GET /api/v2/grafana/search

Returns a list of dashboards given a search query.

200: OK HTTP/1.1 200 Content-Type: application/json [ { "id":1, "title":"Production Overview", "uri":"db/production-overview", "type":"dash-db", "tags":[ templated, production ], "isStarred":true }, { "id":4, "title":"Production Webservers", "uri":"db/production-webservers", "type":"dash-db", "tags":[ production ], "isStarred":true } ]

400: Bad Request Invalid form data

Curl example:

curl -i -X GET https://[e-mail]/api/v2/grafana/search?query=prod

Curl Example to Return all Dashboards:

curl -i -X GET https://[e-mail]/api/v2/grafana/search\?query\=%

---

Dashboard Rendered PNGs

Render dashboard png

GET /api/v2/grafana/render/?target=

Returns a link to a publicly accessible PNG image of a dashboard panel. To display any data on the graph you must include a ‘target’, you can append multiple targets to the request as follows: ?target=foo.bar.A&target=foo.bar.B

Path Parameters

Name	Type	Description
target*	String	to match a metric pattern
from	String	Format: -<num>m|h|d|w|M|Y default: -6h
to	String	Format: now-<num>m|h|d|w|M|Y
width	String	number measured in pixels default: 1000
height	String	number measured in pixels default: 500
theme	String	Format: “light” | “dark ” default: dark
fill	String	Format: number in range 0 (no fill) to 10 default: 1

200: OK HTTP/1.1 200 Content-Type: application/json http://i.mfhg.io/render-api/<user-id>/<filename>.png

400: Bad Request Invalid form data

Curl Example:

curl -i -X GET "https://<api-key>@api.hostedgraphite.com/api/v2/grafana/render/?target=foo.bar"

Time Queries:

• m = Minutes

• h = Hours

• d = Days

• w = Weeks

• M = Months

• Y = Years

Grafana HTTP API

You can access additional dashboard/folder details using the Grafana HTTP API, just make sure to create a new Grafana API Key that you can use for the Authorization Header in your requests:

Add API Key

Example curl request to create a new Folder using the Grafana API:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer " <grafana-api-key>" https://www.hostedgraphite.com/<UID>/grafana/api/folders -d '{"title": "Test Folder"}'