Create grafana dashboards with api

Question

I'm trying to create grafana dashboards from a template with the api from grafana. I use grafana v2.0.2 at the moment.

I have an api key and I'm able to get the dashboards with curl, but I'm unable to create dashboards.

When I do the following request: curl -i -H "Authorization: Bearer eyJrIobfuscatedlkIjoxfQ==" http://localhost:3000/api/dashboards/db/webserver2 then I get the json back for the dasboard.

When I try to create the simplest dashboard I found in the api examples it does not work: curl -i -H "Authorization: Bearer eyJrIobfuscatedlkIjoxfQ==" -d /tmp/simpledash http://localhost:3000/api/dashboards/db where /tmp/simpledash contains:

{
  "dashboard": {
    "id": null,
    "title": "Production Overview",
    "tags": [ "templated" ],
    "timezone": "browser",
    "rows": [
      {
      }
    ]
    "schemaVersion": 6,
    "version": 0
  },
  "overwrite": false
 }

I get the following response:

HTTP/1.1 422 status code 422
Content-Type: application/json; charset=utf-8
Date: Wed, 01 Jul 2015 16:16:48 GMT
Content-Length: 84

[{"fieldNames":   ["Dashboard"],"classification":"RequiredError","message":"Required"}]

I tried some variations of the json, but I always get that response and on the internet I could not find a working example. Anyone have a working example for me? I like to have this working so I can create dashboard from ansible.

Thanks!

I found I got JS errors if the "rows" array has an empty object [{}] inside it, sending [] on its own seems to have corrected this. It seems the JS sees the object and attempts to extract values from it. — Rebs
– Rebs, Commented Feb 1, 2016 at 4:38

Mahadev Gouda · Accepted Answer · 2018-07-04 07:37:02Z

The reason why it's failing is that the API needs to know that the payload is json.

with cURL

curl -XPOST -i http://localhost:3000/api/dashboards/db --data-binary @./test.json -H "Content-Type: application/json"

with ansible

- name: postinstall::dashsetups
  uri:
    url: http://{{grafana.ip}}:{{grafana.bind}}/api/dashboards/db
    method: POST
    user: "{{ admin_usr }}"
    password: "{{ admin_pwd }}"
    body: "{{ lookup('template', item.file) }}"
    status_code: 200
    body_format: raw
    force_basic_auth: yes
    HEADER_Content-Type: "application/json"
  with_items: "{{ grafana.dashboards }}"

and vars file containing dashboards,

"grafana":{"dashboards": [
          {
            "name": "t1",
            "file": "./dashboards/filename.json.j2",
            "dash_name": "Test 1"
          },
          {
            "name": "t2",
            "file": "./dashboards/filename2.json.j2",
            "dash_name": "Test 2"
          },
          {
            "name": "t3",
            "file": "./dashboards/template3.json.j2",
            "dash_name": "Test 3"
          }
        ]
}

Alex Laverty · Accepted Answer · 2015-07-09 01:36:24Z

5

I figured this out last night, the example on the website is missing a comma just before "schemaVersion"

correct json should be :

{
  "dashboard": {
    "id": null,
    "title": "Production Overview",
    "tags": [ "templated" ],
    "timezone": "browser",
    "rows": [
      {
      }
    ],
    "schemaVersion": 6,
    "version": 0
  },
  "overwrite": false
 }

if you copy your json into this json validator it'll show you exactly where the issue is :

http://jsonlint.com/

answered Jul 9, 2015 at 1:36

Alex Laverty

4851 gold badge9 silver badges17 bronze badges

Comments

solipsistnation · Accepted Answer · 2015-08-25 23:38:44Z

4

To use curl to post data from a file, put an @ before the filename, like this:

curl -i -H "Authorization: Bearer eyJrIobfuscatedlkIjoxfQ==" -d @/tmp/simpledash http://localhost:3000/api/dashboards/db

answered Aug 25, 2015 at 23:38

solipsistnation

412 bronze badges

Comments

mojdeh · Accepted Answer · 2018-01-01 08:32:41Z

1

I solved the problem like this:

1- first create your datasource like this (In my case I used the combination of collectd, prometheus and grafana)

curl --user admin:admin 'http://IPADDR:3000/api/datasources' -X  POST -H 'Content-Type: application/json;charset=UTF-8'  --data-binary '{"name":"test","type":"prometheus","url":"http://localhost:9090","access":"proxy","basicAuth":false}'

2-For adding the customized json dashboard, edit grafana.ini file and enable Dashboard json file section like below:

;##################### Dashboard JSON files #####################
 [dashboards.json]
 enabled = true
 path = /var/lib/grafana/dashboards

3- then copy dashboard json file to /var/lib/grafana/dashboards (you need to restart the service)

answered Jan 1, 2018 at 8:32

mojdeh

1842 silver badges3 bronze badges

1 Comment

Leo Over a year ago

This worked for me too. I did have to change the exported dashboard Json source file annotation to be the literal name of the datasource eg: Replacing "${DATASOURCE}" with "test"

Karan Singh · Accepted Answer · 2017-02-02 14:32:34Z

0

Userful ONE-LINER to import JSON dashboards from your machine

for i in `ls *.json` ;do curl -i -u GRAFANA_USERNAME:GRAFANA_PASSWORD -H "Content-Type: application/json" -X POST http://GRAFANA_HOST/api/dashboards/db -d @$i ; done

Do change GRAFANA_USERNAME , GRAFANA_PASSWORD and GRAFANA_HOST from the above command.

answered Feb 2, 2017 at 14:32

Karan Singh

11 bronze badge

Comments

Mahadev Gouda · Accepted Answer · 2018-07-03 09:22:51Z

0

I am adding one more way that is using python script

import requests
url='http://admin:admin@localhost:3000/api/dashboards/db'
data='''{
  "dashboard": {
    "id": null,
    "uid": "mahadev",
    "title": "scriptedDashboard",
    "tags": [ "templated" ],
    "timezone": "browser",
    "schemaVersion": 16,
    "version": 0
  },
  "folderId": 48,
  "overwrite": false
}'''
headers={"Content-Type": 'application/json'}
response = requests.post(url, data=data,headers=headers)
print (response.text)

answered Jul 3, 2018 at 9:22

Mahadev Gouda

82512 silver badges16 bronze badges

Collectives™ on Stack Overflow

Create grafana dashboards with api

6 Answers 6

Comments

Comments

Comments

1 Comment

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

Comments

Comments

Comments

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related