Grafana
Документация GlaberGraph
Ресурсы для разработчиков
API Grafana
Справочное руководство по HTTP API Grafana
Справочное руководство по HTTP API Grafana
Каждый экземпляр Grafana предоставляет HTTP API, используемый фронтендом Grafana для управления ресурсами: сохранения дашбордов, создания пользователей, обновления источников данных, удаления алертов и многого другого. С помощью HTTP API можно программно получать доступ к ресурсам вашего экземпляра Grafana или управлять ими.
Если вам нужно управлять другими ресурсами вашего стека Grafana Cloud или получать к ним доступ, вместо этого обратитесь к API Grafana Cloud.
HTTP API нового поколения
Grafana объявляет устаревшими устаревшие API (/api) в пользу нового поколения улучшенных API (/apis), которые следуют стандартизированной структуре API и согласованному версионированию API.
Дополнительные сведения см. в разделах:
- Новая структура API в Grafana с информацией о новой структуре HTTP API.
- Руководство по миграции API с подробностями о процессе объявления устаревших API.
Спецификация API Grafana
HTTP API Grafana соответствуют как спецификации OpenAPI v2 (Swagger 2.0), так и спецификации OpenAPI v3. Хотя обе описывают один и тот же набор маршрутов HTTP API Grafana (дашборды, папки, источники данных, организации, пользователи, команды, RBAC, провижининг алертов и т. д.), канонической спецификацией и источником истины является v2, а v3 получается из файла v2 с помощью скрипта преобразования.
Если вы используете HTTP API Grafana:
- Используйте v2, если ваш инструментарий (генераторы SDK, более старый Swagger UI,
terraform-provider-grafana) ожидает Swagger 2.0. - Используйте v3, если ваш инструментарий требует OpenAPI 3.x (например, более новые инструменты генерации кода, некоторые API-шлюзы, новые возможности импорта в Postman).
Просмотреть и опробовать обе спецификации можно в редакторе Swagger UI, который обслуживается сервером Grafana, перейдя по пути /swagger-ui.
Аутентификация
В OSS вы можете аутентифицировать запросы к HTTP API с помощью basic-аутентификации или токена сервисной учётной записи. В Grafana Cloud доступен только вариант с токеном сервисной учётной записи. Дополнительные сведения см. в разделе Аутентификация в HTTP API.
Список доступных HTTP API
В следующей таблице перечислены все доступные справочные страницы по HTTP API. Сначала идут новые API, затем устаревшие.
Связанные материалы
Используйте следующие материалы для дальнейшей работы с API Grafana:
- Структура API: см. Новая структура API в Grafana.
- Руководство по миграции: см. Переход на новые API.
- Swagger UI: откройте страницу
/swaggerв вашем экземпляре Grafana, чтобы изучить схемы конечных точек и опробовать запросы.