Working with Grafana API

curl -H "Authorization: Bearer eyJrIjoi..." \
  http://localhost:3000/api/dashboards/home</code>
</pre>
</div>
</div>
<div class="note">
<strong>Note:</strong> API keys can be generated via the Grafana UI under <code>Configuration > API Keys</code> or <code>Service Accounts</code>.
</div>
<div class="warning">
<strong>Warning:</strong> Never expose API keys in client-side code or version control.
</div>
<h2 id="2-using-dashboard-api">2. Using Dashboard API<a href="#2-using-dashboard-api" class="toc__headingLink" aria-label="Link to this section"><svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path></svg></a></h2>
<table>
<tbody>
<tr>
<th>Endpoint</th>
<th>Method</th>
<th>Description</th>
<th>Notes</th>
</tr>
<tr>
<td class="property">/api/dashboards/db</td>
<td>POST</td>
<td>Create a new dashboard</td>
<td>Requires write permissions</td>
</tr>
<tr>
<td class="property">/api/dashboards/db</td>
<td>PUT</td>
<td>Update an existing dashboard</td>
<td>Overwrites the entire dashboard JSON</td>
</tr>
<tr>
<td class="property">/api/dashboards/uid/{uid}</td>
<td>GET</td>
<td>Get a dashboard by UID</td>
<td>Returns full dashboard JSON</td>
</tr>
<tr>
<td class="property">/api/dashboards/id/{id}</td>
<td>GET</td>
<td>Get a dashboard by ID</td>
<td>Returns full dashboard JSON</td>
</tr>
<tr>
<td class="property">/api/dashboards/id/{id}</td>
<td>DELETE</td>
<td>Delete a dashboard by ID</td>
<td>Deletes the dashboard permanently</td>
</tr>
</tbody>
</table>

<div class="example">
<h2 id="example-create-a-new-dashboard">Example: Create a new dashboard<a href="#example-create-a-new-dashboard" class="toc__headingLink" aria-label="Link to this section"><svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path></svg></a></h2>
<div class="codeBlock" data-language="json">
<pre><code>{
  "dashboard": {
    "title": "My New Dashboard",
    "panels": [
      {
        "id": 1,
        "type": "graph",
        "title": "CPU Usage"
      }
    ]
  },
  "folderId": 0,
  "overwrite": false
}

{
  "dashboard": {
    "id": 123,
    "title": "Updated Dashboard Title",
    "panels": [
      {
        "id": 1,
        "type": "graph",
        "title": "CPU Usage"
      }
    ]
  },
  "overwrite": true
}

{
  "name": "Prometheus",
  "type": "prometheus",
  "url": "http://localhost:9090",
  "access": "proxy",
  "isDefault": false
}

{
  "id": 1,
  "name": "Prometheus Updated",
  "type": "prometheus",
  "url": "http://localhost:9091",
  "access": "proxy",
  "isDefault": true
}

{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "login": "johndoe",
  "password": "securePassword123"
}

{
  "isGrafanaAdmin": true
}

curl -H "Authorization: Bearer <API_TOKEN>" \
     -H "Content-Type: application/json" \
     https://grafana.example.com/api/org

curl -H "Authorization: Bearer <API_TOKEN>" \
     -H "Content-Type: application/json" \
     -X PUT \
     https://grafana.example.com/api/org \
     -d '{"name": "New Org Name"}'

curl -H "Authorization: Bearer <API_TOKEN>" \
     -H "Content-Type: application/json" \
     -X POST \
     https://grafana.example.com/api/org/users \
     -d '{"loginOrEmail": "user@example.com", "role": "Editor"}'

curl -H "Authorization: Bearer <API_TOKEN>" \
  "http://localhost:3000/api/search?query=prod&limit=10"

const searchParams = {
  query: "db",
  folderIds: [1, 3],
  limit: 20
};

fetch("http://localhost:3000/api/search", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <API_TOKEN>",
    "Content-Type": "application/json"
  },
  params: searchParams
})

{
  "dashboardId": 123,
  "panelId": 456,
  "time": 1678886400000,
  "text": "Deployment completed",
  "tags": ["deployment", "prod"]
}

curl -H "Authorization: Bearer <token>" \
  "http://localhost:3000/api/annotations?from=1678886400000&to=1678972800000"

{
  "name": "CPU Usage Alert",
  "condition": "A > 80",
  "for": "5m",
  "labels": {
    "severity": "warning"
  },
  "annotations": {
    "summary": "High CPU usage detected"
  }
}

curl -H "Authorization: Bearer <API_TOKEN>" \
     -H "Content-Type: application/json" \
     http://localhost:3000/api/v1/rules

const snapshot = {
  dashboard: {
    title: "Production Metrics",
    panels: [],
    ...
  },
  expires: 86400,
  name: "Daily Production Snapshot"
};

fetch("/api/snapshots", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(snapshot)
})
.then(res => res.json())
.then(data => console.log("Snapshot URL:", data.url));

curl -H "Authorization: Bearer <API_TOKEN>" http://localhost:3000/api/health

{
  "commit": "abc123",
  "database": "connected",
  "edition": "oss",
  "version": "11.0.0"
}

{
  "title": "Production Dashboards",
  "uid": "prod-dash"
}

curl --request GET \
  --url 'http://localhost:3000/api/folders' \
  --header 'Authorization: Bearer <your_token>'

{
  "title": "Updated Production Dashboards",
  "uid": "prod-dash"
}

const response = await fetch("https://grafana.example.com/api/dashboards/uid/my-dashboard", {
  headers: {
    "Authorization": "Bearer <API_TOKEN>"
  }
});

if (!response.ok) {
  switch (response.status) {
    case 400:
      console.error("Invalid request parameters");
      break;
    case 401:
      console.error("Authentication failed");
      break;
    case 403:
      console.error("Access denied");
      break;
    case 404:
      console.error("Dashboard not found");
      break;
    case 429:
      console.error("Rate limit exceeded");
      break;
    default:
      console.error(`Unexpected error: ${response.status}`);
  }
} else {
  const data = await response.json();
  console.log("Dashboard loaded successfully", data);
}