How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Grafana

Grafana Dashboards API

Manage dashboards

Documentation Provider Profile APIs.io OpenAPI GitHub

Grafana Dashboards API is one of 78 APIs that Grafana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Dashboards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, and 1 JSON Schema.

This API exposes 30 operations across 24 paths, and defines 61 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 4 base URLs: https://{instance}.grafana.net/api, http://localhost:3000/api, http://{defaultHost}, https://{defaultHost}.

30 operations 24 paths 61 schemas 4 DELETE17 GET1 PATCH8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
http://localhost:3000/api
Authentication
HTTP Bearer, HTTP Basic, API Key, API Key, HTTP Basic
Resource Areas
1

Authentication & Security 5

Grafana Dashboards API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). It accepts HTTP basic authentication (BasicAuth). An API key is passed in the header as Authorization (ApiKeyAuth). An API key is passed in the header as Authorization (api_key). It accepts HTTP basic authentication (basic).

  • BearerAuth — Service account token or API key
  • ApiKeyAuth — Format: Bearer

Paths & Operations 30

Across 24 paths, the API surfaces 30 operations — 4 DELETE, 17 GET, 1 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Dashboards 30

Manage dashboards

POST
/dashboards/db
Create or update a dashboard
createUpdateDashboard body → 200401403
GET
/dashboards/uid/{uid}
Get dashboard by UID
getDashboardByUid 1 param → 200404
DELETE
/dashboards/uid/{uid}
Delete dashboard by UID
deleteDashboardByUid 1 param → 200404
GET
/search
Search dashboards and folders
searchDashboards 6 params → 200
GET
/reports/dashboards/{uid}
Grafana Get Reports By Dashboard UID
getReportsByDashboardUID 1 param → 200401403500
GET
/dashboard/snapshots
Grafana Search Dashboard Snapshots
searchDashboardSnapshots 2 params → 200500
GET
/dashboards/homedeprecated
Grafana Get Home Dashboard
getHomeDashboard → 200401500
GET
/dashboards/id/{DashboardID}/permissionsdeprecated
Grafana Get Dashboard Permissions List By ID
getDashboardPermissionsListByID 1 param → 200401403404500
POST
/dashboards/id/{DashboardID}/permissionsdeprecated
Grafana Update Dashboard Permissions By ID
updateDashboardPermissionsByID 1 param body → 200400401403404500
GET
/dashboards/id/{DashboardID}/versionsdeprecated
Grafana Get Dashboard Versions By ID
getDashboardVersionsByID 1 param → 200401403404500
GET
/dashboards/id/{DashboardID}/versions/{DashboardVersionID}deprecated
Grafana Get Dashboard Version By ID
getDashboardVersionByID 2 params → 200401403404500
POST
/dashboards/import
Grafana Import Dashboard
importDashboard body → 200400401412422500
POST
/dashboards/interpolate
Grafana Interpolate Dashboard
interpolateDashboard → 200400401422500
GET
/dashboards/public-dashboards
Grafana List Public Dashboards
listPublicDashboards → 200401403500
GET
/dashboards/tags
Grafana Get Dashboard Tags
getDashboardTags → 200401500
GET
/dashboards/uid/{dashboardUid}/public-dashboards
Grafana Get Public Dashboard
getPublicDashboard 1 param → 200400401403404500
DELETE
/dashboards/uid/{dashboardUid}/public-dashboards/{uid}
Grafana Delete Public Dashboard
deletePublicDashboard 2 params → 200400401403500
PATCH
/dashboards/uid/{dashboardUid}/public-dashboards/{uid}
Grafana Update Public Dashboard
updatePublicDashboard 2 params body → 200400401403500
GET
/dashboards/uid/{uid}/permissions
Grafana Get Dashboard Permissions List By UID
getDashboardPermissionsListByUID 1 param → 200401403404500
POST
/dashboards/uid/{uid}/permissions
Grafana Update Dashboard Permissions By UID
updateDashboardPermissionsByUID 1 param body → 200400401403404500
POST
/dashboards/uid/{uid}/restore
Grafana Restore Dashboard Version By UID
restoreDashboardVersionByUID 1 param body → 200400401403404500
GET
/dashboards/uid/{uid}/versions
Grafana Get Dashboard Versions By UID
getDashboardVersionsByUID 3 params → 200401403404500
GET
/dashboards/uid/{uid}/versions/{DashboardVersionID}
Grafana Get Dashboard Version By UID
getDashboardVersionByUID 2 params → 200401403404500
GET
/public/dashboards/{accessToken}
Grafana View Public Dashboard
viewPublicDashboard 1 param → 200400401403404500
POST
/public/dashboards/{accessToken}/panels/{panelId}/query
Grafana Query Public Dashboard
queryPublicDashboard 2 params → 200400401403404500
GET
/snapshots-delete/{deleteKey}
Grafana Delete Dashboard Snapshot By Delete Key
deleteDashboardSnapshotByDeleteKey 1 param → 200401403404500
GET
/snapshots/{key}
Grafana Get Dashboard Snapshot
getDashboardSnapshot 1 param → 200400404500
DELETE
/snapshots/{key}
Grafana Delete Dashboard Snapshot
deleteDashboardSnapshot 1 param → 200403404500
POST
/user/stars/dashboard/uid/{dashboard_uid}
Grafana Star Dashboard By UID
starDashboardByUID 1 param → 200400401403500
DELETE
/user/stars/dashboard/uid/{dashboard_uid}
Grafana Unstar Dashboard By UID
unstarDashboardByUID 1 param → 200400401403500

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are DashboardMeta_2 (27 properties), DashboardACLInfoDTO (24 properties), DashboardMeta (19 properties), Report (19 properties). Each schema is shown below with its type and property counts.

DashboardMeta
object
19 properties
Target
object
Query target - structure varies by data source type
8 properties
DashboardLink
object
9 properties
TemplateVariable
object
12 properties
ErrorResponse
object
2 properties
DashboardFullWithMeta
object
2 properties
Panel
object
15 properties
DashboardSearchHit
object
14 properties
SaveDashboardResponse
object
6 properties
Dashboard
object
18 properties
SaveDashboardCommand
object
5 properties 1 required
Role
string
DashboardMeta_2
object
27 properties
FrameMetamatches
object
https://github.com/grafana/grafana/blob/master/packages/grafana-data/src/types/data.tsL11 NOTE -- in javascript this can accept any [key: string]: any; however…
13 properties
ImportDashboardResponseresponseobjectreturnedwhenimportingadashboard.
object
15 properties
DashboardSnapshotDTO
object
DashboardSnapshotDTO without dashboard map
7 properties
AnnotationPermission
object
+k8s:deepcopy-gen=true
2 properties
ErrorResponseBody
object
3 properties 1 required
SuccessResponseBody
object
1 property
Gethomedashboardresponse.
object
3 properties
TimeRange
object
Redefining this to avoid an import cycle
2 properties
ReportSchedule
object
8 properties
DashboardTagCloudItem
object
2 properties
LinkTransformationConfig
object
4 properties
EmailDTO
object
2 properties
ThresholdsConfig
object
ThresholdsConfig setup thresholds
2 properties
publicError1
object
PublicError is derived from Error and only contains information available to the end user.
4 properties 2 required
NoticeprovidesastructureforpresentingnotificationsinGrafanasuserinterface.
object
4 properties
postDashboardResponse
object
7 properties 6 required
UpdateDashboardACLCommand
object
1 property
FieldrepresentsatypedcolumnofdatawithinaFrame.
object
A Field is essentially a slice of various types with extra properties and methods. See NewField() for supported types. The slice data in the Field is a not exp…
3 properties
DataLink
object
DataLink define what
4 properties
ReportOptions
object
5 properties
PublicDashboard
object
12 properties
DataResponsecontainstheresultsfromaDataQuery.
object
A map of RefIDs (unique query identifiers) to this type makes up the Responses property of a QueryDataResponse. The Error property is used to allow for partial…
4 properties
ReportTimeRange
object
2 properties
DashboardVersionMeta
object
DashboardVersionMeta extends the DashboardVersionDTO with the names associated with the UserIds, overriding the field with the same name from the DashboardVers…
10 properties
RestoreDashboardVersionCommand
object
1 property
FieldTypeConfig
object
FieldTypeConfig has type specific configs, only one should be active at a time
1 property
DashboardACLInfoDTO
object
24 properties
Threshold
object
Threshold a single step on the threshold list
3 properties
FieldConfigrepresentsthedisplaypropertiesforaField.
object
18 properties
PublicDashboardListResponse
object
6 properties
ImportDashboardInputdefinitionofinputparameterswhenimportingadashboard.
object
4 properties
ImportDashboardRequestrequestobjectforimportingadashboard.
object
7 properties
Report
object
19 properties
FrameisacolumnardatastructurewhereeachcolumnisaField.
object
Each Field is well typed by its FieldType and supports optional Labels. A Frame is a general data container for Grafana. A Frame can be table data or time seri…
4 properties
DashboardVersionResponseMeta
object
2 properties
PublicDashboardDTO
object
6 properties
DashboardFullWithMeta_2
object
2 properties
DashboardACLUpdateItem
object
4 properties
SaveDashboardCommand_2
object
8 properties
InternalDataLink
object
InternalDataLink definition to allow Explore links to be constructed in the backend
6 properties
ReportDashboardID
object
3 properties
PublicDashboardListResponseWithPagination
object
4 properties
QueryDataResponsecontainstheresultsfromaQueryDataRequest.
object
It is the return type of a QueryData call.
1 property
ReportDashboard
object
3 properties
AnnotationActions
object
+k8s:deepcopy-gen=true
3 properties
deleteDashboardResponse
object
3 properties 3 required
QueryStatisusedforstoringarbitrarystatisticsmetadatarelatedtoaqueryanditsresulte.g.totalrequesttimedataprocessingtime.
object
The embedded FieldConfig's display name must be set. It corresponds to the QueryResultMetaStat on the frontend (https://github.com/grafana/grafana/blob/master/…
19 properties
EnumFieldConfig
object
Enum field config Vector values are used as lookup keys into the enum fields
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

grafana-dashboards-api-openapi.yml Raw ↑

Other APIs Grafana publishes across the network.

Grafana Access API
AE Profile APIs.io
Grafana Account API
AE Profile APIs.io
Grafana Accounts API
AE Profile APIs.io
Grafana Add API
AE Profile APIs.io
Grafana Address API
AE Profile APIs.io
Grafana Administrative API
AE Profile APIs.io
Grafana Alerts API
AE Profile APIs.io
Grafana All API
AE Profile APIs.io
Grafana Annotations API
AE Profile APIs.io
Grafana Built API
AE Profile APIs.io
Grafana Cache API
AE Profile APIs.io
Grafana Call API
AE Profile APIs.io
#Dashboards
← Back to G APIs
API Details
ID
grafana:grafana-dashboards-api
Base URL
http://localhost:3000/api
Docs
https://grafana.com/docs/grafana/latest/developers/http_api/
Provider
Grafana
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=grafana-dashboards-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/grafana-dashboards-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Grafana Dashboards API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.