API documentation — Grafana

Cited by

Facts read from this source

• Http API Report an error

  “Every Grafana instance exposes an HTTP API, used by the Grafana frontend to manage resources like saving dashboards, creating users, updating data sources, deleting alerts, and more.”

• New APIs Report an error

  “Grafana is deprecating legacy APIs (/api) in favor of a new generation of improved APIs (/apis) which follow a standardized API structure alongside consistent API versioning.”

• Openapi spec Report an error

  “Grafana HTTP APIs comply both with the OpenAPI v2 specification (Swagger 2.0) and OpenAPI v3 specification.”

• Swagger UI Report an error

  “You can browse and try out both via the Swagger UI editor, served by the Grafana server, by navigating to /swagger-ui.”

• Authentication Report an error

  “In OSS, you can authenticate your requests to the HTTP APIs using basic auth or a service account token. In Grafana Cloud, only the service account token option is available.”

• New APIs list Report an error

  “Alert enrichment HTTP API (Swagger) New No Alert notifications HTTP API (Swagger) New No Banners HTTP API (Swagger) New No Dashboard HTTP API New /api/dashboards/* Folder HTTP API New /api/folders/* SLO (Swagger) / Kubernetes CRD New - Cloud only No Playlist HTTP API New No Resource history HTTP API New No Secrets Management HTTP API New No Stars HTTP API New /api/collection/*”

• Legacy APIs deprecated Report an error

  “Admin HTTP API Deprecated Not Applicable Alerting Provisioning HTTP API Deprecated Not Applicable Annotations HTTP API Deprecated Not Applicable Correlations HTTP API Deprecated Not Applicable Dashboard Permissions HTTP API Deprecated Not Applicable Dashboard Versions HTTP API Deprecated Not Applicable Data source HTTP API Deprecated Not Applicable Data source LBAC rules HTTP API Deprecated Not Applicable Data source permissions HTTP API Deprecated Not Applicable Folder/Dashboard Search HTTP API Deprecated Not Applicable Folder Permissions HTTP API Deprecated Not Applicable Library Element HTTP API Deprecated Not Applicable Licensing HTTP API Deprecated Not Applicable Organization HTTP API Deprecated Not Applicable Other HTTP API Deprecated Not Applicable Preferences API Deprecated Not Applicable Query and Resource Caching HTTP API Deprecated Not Applicable Query History HTTP API Deprecated Not Applicable RBAC HTTP API Deprecated Not Applicable Reporting API Deprecated Not Applicable Service account HTTP API Deprecated Not Applicable Shared Dashboards HTTP API Deprecated Not Applicable Short URL HTTP API Deprecated Not Applicable Snapshot API Deprecated Not Applicable SSO Settings API Deprecated Not Applicable Stars API - /user/stars/* Deprecated Not Applicable Team HTTP API Deprecated Not Applicable Team Sync HTTP API Deprecated Not Applicable User HTTP API Deprecated Not Applicable”

• Cloud API separate Report an error

  “If you need to manage or access other resources from your Grafana Cloud Stack, refer to the Grafana Cloud API instead.”

• Terraform provider Report an error

  “Use v2 if your tooling (SDK generators, older Swagger UI, terraform-provider-grafana) expects Swagger 2.0.”

Scores citing this record

• The Data Analyst Sharing, scheduled reports & embedding
• The Data Analyst Access control, administration & portability
• The Finance Controller Sharing, scheduled reports & embedding
• The Finance Controller Access control, administration & portability
• The IT Administrator Sharing, scheduled reports & embedding
• The IT Administrator Access control, administration & portability
• The Managing Director Access control, administration & portability
• The SaaS Product Lead Access control, administration & portability
• The Skeptic Sharing, scheduled reports & embedding
• The Skeptic Access control, administration & portability