# Grafana Enterprise API

**Canonical:** https://apis.io/apis/grafana-com/grafana-com-enterprise-api/  
**Provider:** Grafana — https://apis.io/providers/grafana-com/  
**Base URL:** /api  
**Documentation:** https://grafana.com/docs/grafana/latest/developers/http_api/

Grafana Enterprise API is one of 49 APIs that [Grafana](https://apis.io/providers/grafana-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Enterprise. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

These are only available in Grafana Enterprise

## Operations (60 of 65)

| Method | Path | Summary |
|---|---|---|
| GET | `/access-control/roles` | Get all roles |
| POST | `/access-control/roles` | Create a new custom role |
| GET | `/access-control/roles/{roleUID}` | Get a role |
| PUT | `/access-control/roles/{roleUID}` | Update a custom role |
| DELETE | `/access-control/roles/{roleUID}` | Delete a custom role |
| GET | `/access-control/roles/{roleUID}/assignments` | Get role assignments |
| PUT | `/access-control/roles/{roleUID}/assignments` | Set role assignments |
| GET | `/access-control/status` | Get status |
| POST | `/access-control/teams/roles/search` | List roles assigned to multiple teams |
| GET | `/access-control/teams/{teamId}/roles` | Get team roles |
| PUT | `/access-control/teams/{teamId}/roles` | Update team role |
| POST | `/access-control/teams/{teamId}/roles` | Add team role |
| DELETE | `/access-control/teams/{teamId}/roles/{roleUID}` | Remove team role |
| POST | `/access-control/users/roles/search` | List roles assigned to multiple users |
| GET | `/access-control/users/{userId}/roles` | List roles assigned to a user |
| PUT | `/access-control/users/{userId}/roles` | Set user role assignments |
| POST | `/access-control/users/{userId}/roles` | Add a user role assignment |
| DELETE | `/access-control/users/{userId}/roles/{roleUID}` | Remove a user role assignment |
| GET | `/admin/ldap-sync-status` | Returns the current state of the LDAP background sync integration |
| POST | `/admin/provisioning/access-control/reload` | You need to have a permission with action `provisioning:reload` with scope… |
| GET | `/datasources/uid/{uid}/lbac/teams` | Retrieves LBAC rules for a team |
| PUT | `/datasources/uid/{uid}/lbac/teams` | Updates LBAC rules for a team |
| GET | `/datasources/{dataSourceUID}/cache` | Get data source cache config |
| POST | `/datasources/{dataSourceUID}/cache` | Set data source cache config |
| POST | `/datasources/{dataSourceUID}/cache/clean` | Clean data source cache |
| POST | `/datasources/{dataSourceUID}/cache/disable` | Disable data source cache |
| POST | `/datasources/{dataSourceUID}/cache/enable` | Enable data source cache |
| GET | `/licensing/check` | Check license availability |
| GET | `/licensing/custom-permissions` | Get custom permissions report |
| GET | `/licensing/custom-permissions-csv` | Get custom permissions report in CSV format |
| GET | `/licensing/refresh-stats` | Refresh license stats |
| GET | `/licensing/token` | Get license token |
| POST | `/licensing/token` | Create license token |
| DELETE | `/licensing/token` | Remove license from database |
| POST | `/licensing/token/renew` | Manually force license refresh |
| GET | `/logout/saml` | GetLogout initiates single logout process |
| GET | `/recording-rules` | Lists all rules in the database: active or deleted |
| PUT | `/recording-rules` | Update the active status of a rule |
| POST | `/recording-rules` | Create a recording rule that is then registered and started |
| POST | `/recording-rules/test` | Test a recording rule |
| GET | `/recording-rules/writer` | Return the prometheus remote write target |
| POST | `/recording-rules/writer` | Create a remote write target |
| DELETE | `/recording-rules/writer` | Delete the remote write target |
| DELETE | `/recording-rules/{recordingRuleID}` | Delete removes the rule from the registry and stops it |
| GET | `/reports` | List reports |
| POST | `/reports` | Create a report |
| GET | `/reports/dashboards/{uid}` | List reports by dashboard uid |
| POST | `/reports/email` | Send a report |
| GET | `/reports/images/:image` | Get custom branding report image |
| GET | `/reports/render/csvs` | Download a CSV report |
| GET | `/reports/render/pdfs` | Render report for multiple dashboards |
| GET | `/reports/settings` | Get report settings |
| POST | `/reports/settings` | Save settings |
| POST | `/reports/test-email` | Send test report via email |
| GET | `/reports/{id}` | Get a report |
| PUT | `/reports/{id}` | Update a report |
| DELETE | `/reports/{id}` | Delete a report |
| POST | `/saml/acs` | It performs Assertion Consumer Service (ACS) |
| GET | `/saml/metadata` | It exposes the SP (Grafana's) metadata for the IdP's consumption |
| GET | `/saml/slo` | It performs Single Logout (SLO) callback |

…and 5 more operations. They are listed in full on the page.

## Machine-readable artifacts (32)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/grafana-com/refs/heads/main/openapi/grafana-com-enterprise-api-openapi.yml
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/
- **Authentication** — https://grafana.com/docs/grafana/latest/developers/http_api/authentication/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/dashboard/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/dashboard_versions/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/dashboard_permissions/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/dashboard_public/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/folder/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/folder_dashboard_search/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/folder_permissions/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/data_source/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/datasource_permissions/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/datasource_lbac_rules/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/annotations/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/org/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/user/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/team/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/team_sync/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/preferences/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/access_control/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/sso-settings/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/admin/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/licensing/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/reporting/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/query_and_resource_caching/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/library_element/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/correlations/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/snapshot/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/short_url/
- **Documentation** — https://grafana.com/docs/grafana/latest/developers/http_api/query_history/

## Other Grafana APIs (12)

- [Grafana Cloud API](https://apis.io/apis/grafana-com/grafana-cloud-api/)
- [Grafana Loki HTTP API](https://apis.io/apis/grafana-com/loki-http-api/)
- [Grafana Mimir HTTP API](https://apis.io/apis/grafana-com/mimir-http-api/)
- [Grafana Tempo HTTP API](https://apis.io/apis/grafana-com/tempo-http-api/)
- [Grafana Pyroscope HTTP API](https://apis.io/apis/grafana-com/pyroscope-http-api/)
- [Grafana k6 Cloud API](https://apis.io/apis/grafana-com/k6-cloud-api/)
- [Grafana OnCall API](https://apis.io/apis/grafana-com/oncall-api/)
- [Grafana Synthetic Monitoring API](https://apis.io/apis/grafana-com/synthetic-monitoring-api/)
- [Grafana Access Control API](https://apis.io/apis/grafana-com/grafana-com-access-control-api/)
- [Grafana Admin API](https://apis.io/apis/grafana-com/grafana-com-admin-api/)
- [Grafana Admin Ldap API](https://apis.io/apis/grafana-com/grafana-com-admin-ldap-api/)
- [Grafana Admin Provisioning API](https://apis.io/apis/grafana-com/grafana-com-admin-provisioning-api/)

## Tags

Enterprise

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/grafana-com/grafana-com-enterprise-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/grafana-com/.
