2020-12-15 02:32:06 -06:00
|
|
|
// Package api contains API logic.
|
2014-12-15 14:25:02 -06:00
|
|
|
package api
|
|
|
|
|
|
|
|
import (
|
2020-12-09 09:22:24 -06:00
|
|
|
"time"
|
|
|
|
|
2016-02-20 16:51:22 -06:00
|
|
|
"github.com/grafana/grafana/pkg/api/avatar"
|
2021-02-04 00:37:28 -06:00
|
|
|
"github.com/grafana/grafana/pkg/api/frontendlogging"
|
2018-06-25 09:36:47 -05:00
|
|
|
"github.com/grafana/grafana/pkg/api/routing"
|
2020-12-15 02:32:06 -06:00
|
|
|
"github.com/grafana/grafana/pkg/infra/log"
|
2015-02-05 03:37:13 -06:00
|
|
|
"github.com/grafana/grafana/pkg/middleware"
|
2019-06-26 01:47:03 -05:00
|
|
|
"github.com/grafana/grafana/pkg/models"
|
2021-08-24 04:36:28 -05:00
|
|
|
ac "github.com/grafana/grafana/pkg/services/accesscontrol"
|
2021-04-14 09:31:27 -05:00
|
|
|
acmiddleware "github.com/grafana/grafana/pkg/services/accesscontrol/middleware"
|
2022-01-26 11:44:20 -06:00
|
|
|
"github.com/grafana/grafana/pkg/services/featuremgmt"
|
2014-12-15 14:25:02 -06:00
|
|
|
)
|
|
|
|
|
2020-12-15 02:32:06 -06:00
|
|
|
var plog = log.New("api")
|
|
|
|
|
2020-10-28 03:36:57 -05:00
|
|
|
// registerRoutes registers all API HTTP routes.
|
2018-03-22 16:13:46 -05:00
|
|
|
func (hs *HTTPServer) registerRoutes() {
|
2021-03-16 10:46:34 -05:00
|
|
|
reqNoAuth := middleware.NoAuth()
|
2018-10-11 05:36:04 -05:00
|
|
|
reqSignedIn := middleware.ReqSignedIn
|
2021-06-14 11:02:05 -05:00
|
|
|
reqNotSignedIn := middleware.ReqNotSignedIn
|
2021-02-27 11:04:28 -06:00
|
|
|
reqSignedInNoAnonymous := middleware.ReqSignedInNoAnonymous
|
2018-10-11 05:36:04 -05:00
|
|
|
reqGrafanaAdmin := middleware.ReqGrafanaAdmin
|
|
|
|
reqEditorRole := middleware.ReqEditorRole
|
|
|
|
reqOrgAdmin := middleware.ReqOrgAdmin
|
2021-09-17 02:19:36 -05:00
|
|
|
reqOrgAdminFolderAdminOrTeamAdmin := middleware.OrgAdminFolderAdminOrTeamAdmin
|
2022-02-09 06:44:38 -06:00
|
|
|
reqCanAccessTeams := middleware.AdminOrEditorAndFeatureEnabled(hs.Cfg.EditorsCanAdmin)
|
2020-12-11 04:44:44 -06:00
|
|
|
reqSnapshotPublicModeOrSignedIn := middleware.SnapshotPublicModeOrSignedIn(hs.Cfg)
|
2020-12-15 12:09:04 -06:00
|
|
|
redirectFromLegacyPanelEditURL := middleware.RedirectFromLegacyPanelEditURL(hs.Cfg)
|
2021-04-14 09:31:27 -05:00
|
|
|
authorize := acmiddleware.Middleware(hs.AccessControl)
|
2021-11-17 03:12:28 -06:00
|
|
|
authorizeInOrg := acmiddleware.AuthorizeInOrgMiddleware(hs.AccessControl, hs.SQLStore)
|
2019-02-11 14:12:01 -06:00
|
|
|
quota := middleware.Quota(hs.QuotaService)
|
2014-12-15 14:25:02 -06:00
|
|
|
|
2018-04-27 06:41:58 -05:00
|
|
|
r := hs.RouteRegister
|
2016-08-29 07:45:28 -05:00
|
|
|
|
2015-01-14 07:25:12 -06:00
|
|
|
// not logged in views
|
2019-01-15 08:15:52 -06:00
|
|
|
r.Get("/logout", hs.Logout)
|
2021-10-06 05:52:27 -05:00
|
|
|
r.Post("/login", quota("session"), routing.Wrap(hs.LoginPost))
|
2019-01-15 08:15:52 -06:00
|
|
|
r.Get("/login/:name", quota("session"), hs.OAuthLogin)
|
2018-10-09 10:47:43 -05:00
|
|
|
r.Get("/login", hs.LoginView)
|
|
|
|
r.Get("/invite/:code", hs.Index)
|
2014-12-15 14:25:02 -06:00
|
|
|
|
2015-01-14 07:25:12 -06:00
|
|
|
// authed views
|
2020-11-10 16:36:35 -06:00
|
|
|
r.Get("/", reqSignedIn, hs.Index)
|
2021-02-27 11:04:28 -06:00
|
|
|
r.Get("/profile/", reqSignedInNoAnonymous, hs.Index)
|
|
|
|
r.Get("/profile/password", reqSignedInNoAnonymous, hs.Index)
|
2020-11-10 16:36:35 -06:00
|
|
|
r.Get("/.well-known/change-password", redirectToChangePassword)
|
2021-02-27 11:04:28 -06:00
|
|
|
r.Get("/profile/switch-org/:id", reqSignedInNoAnonymous, hs.ChangeActiveOrgAndRedirectToHome)
|
2021-11-18 07:10:38 -06:00
|
|
|
r.Get("/org/", authorize(reqOrgAdmin, orgPreferencesAccessEvaluator), hs.Index)
|
|
|
|
r.Get("/org/new", authorizeInOrg(reqGrafanaAdmin, acmiddleware.UseGlobalOrg, orgsCreateAccessEvaluator), hs.Index)
|
2021-09-22 06:50:21 -05:00
|
|
|
r.Get("/datasources/", authorize(reqOrgAdmin, dataSourcesConfigurationAccessEvaluator), hs.Index)
|
|
|
|
r.Get("/datasources/new", authorize(reqOrgAdmin, dataSourcesNewAccessEvaluator), hs.Index)
|
|
|
|
r.Get("/datasources/edit/*", authorize(reqOrgAdmin, dataSourcesEditAccessEvaluator), hs.Index)
|
2022-01-13 07:40:32 -06:00
|
|
|
r.Get("/org/users", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgUsersRead)), hs.Index)
|
2019-03-04 08:51:18 -06:00
|
|
|
r.Get("/org/users/new", reqOrgAdmin, hs.Index)
|
2021-08-24 04:36:28 -05:00
|
|
|
r.Get("/org/users/invite", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionUsersCreate)), hs.Index)
|
2022-02-03 10:49:39 -06:00
|
|
|
r.Get("/org/teams", authorize(reqCanAccessTeams, ac.EvalPermission(ac.ActionTeamsRead)), hs.Index)
|
|
|
|
r.Get("/org/teams/edit/*", authorize(reqCanAccessTeams, teamsEditAccessEvaluator), hs.Index)
|
|
|
|
r.Get("/org/teams/new", authorize(reqCanAccessTeams, ac.EvalPermission(ac.ActionTeamsCreate)), hs.Index)
|
2022-01-19 10:03:45 -06:00
|
|
|
r.Get("/org/serviceaccounts", middleware.ReqOrgAdmin, hs.Index)
|
|
|
|
r.Get("/org/serviceaccounts/:serviceAccountId", middleware.ReqOrgAdmin, hs.Index)
|
2019-03-04 08:51:18 -06:00
|
|
|
r.Get("/org/apikeys/", reqOrgAdmin, hs.Index)
|
2018-10-09 10:47:43 -05:00
|
|
|
r.Get("/dashboard/import/", reqSignedIn, hs.Index)
|
|
|
|
r.Get("/configuration", reqGrafanaAdmin, hs.Index)
|
|
|
|
r.Get("/admin", reqGrafanaAdmin, hs.Index)
|
2021-08-24 04:36:28 -05:00
|
|
|
r.Get("/admin/settings", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionSettingsRead)), hs.Index)
|
|
|
|
r.Get("/admin/users", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersRead, ac.ScopeGlobalUsersAll)), hs.Index)
|
|
|
|
r.Get("/admin/users/create", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersCreate)), hs.Index)
|
|
|
|
r.Get("/admin/users/edit/:id", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersRead)), hs.Index)
|
2021-11-18 07:10:38 -06:00
|
|
|
r.Get("/admin/orgs", authorizeInOrg(reqGrafanaAdmin, acmiddleware.UseGlobalOrg, orgsAccessEvaluator), hs.Index)
|
|
|
|
r.Get("/admin/orgs/edit/:id", authorizeInOrg(reqGrafanaAdmin, acmiddleware.UseGlobalOrg, orgsAccessEvaluator), hs.Index)
|
2021-08-24 04:36:28 -05:00
|
|
|
r.Get("/admin/stats", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionServerStatsRead)), hs.Index)
|
|
|
|
r.Get("/admin/ldap", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionLDAPStatusRead)), hs.Index)
|
2018-10-09 10:47:43 -05:00
|
|
|
r.Get("/styleguide", reqSignedIn, hs.Index)
|
|
|
|
|
2021-09-13 23:09:55 -05:00
|
|
|
r.Get("/live", reqGrafanaAdmin, hs.Index)
|
|
|
|
r.Get("/live/pipeline", reqGrafanaAdmin, hs.Index)
|
|
|
|
r.Get("/live/cloud", reqGrafanaAdmin, hs.Index)
|
|
|
|
|
2018-10-09 10:47:43 -05:00
|
|
|
r.Get("/plugins", reqSignedIn, hs.Index)
|
2019-05-02 12:15:39 -05:00
|
|
|
r.Get("/plugins/:id/", reqSignedIn, hs.Index)
|
|
|
|
r.Get("/plugins/:id/edit", reqSignedIn, hs.Index) // deprecated
|
2018-10-09 10:47:43 -05:00
|
|
|
r.Get("/plugins/:id/page/:page", reqSignedIn, hs.Index)
|
2019-05-02 12:15:39 -05:00
|
|
|
r.Get("/a/:id/*", reqSignedIn, hs.Index) // App Root Page
|
2021-07-05 03:24:14 -05:00
|
|
|
r.Get("/a/:id", reqSignedIn, hs.Index)
|
2018-10-09 10:47:43 -05:00
|
|
|
|
2020-06-17 05:51:41 -05:00
|
|
|
r.Get("/d/:uid/:slug", reqSignedIn, redirectFromLegacyPanelEditURL, hs.Index)
|
|
|
|
r.Get("/d/:uid", reqSignedIn, redirectFromLegacyPanelEditURL, hs.Index)
|
2018-10-09 10:47:43 -05:00
|
|
|
r.Get("/dashboard/script/*", reqSignedIn, hs.Index)
|
2020-11-10 16:36:35 -06:00
|
|
|
r.Get("/dashboard/new", reqSignedIn, hs.Index)
|
2018-10-09 10:47:43 -05:00
|
|
|
r.Get("/dashboard-solo/snapshot/*", hs.Index)
|
|
|
|
r.Get("/d-solo/:uid/:slug", reqSignedIn, hs.Index)
|
2019-10-14 11:21:44 -05:00
|
|
|
r.Get("/d-solo/:uid", reqSignedIn, hs.Index)
|
2018-10-09 10:47:43 -05:00
|
|
|
r.Get("/dashboard-solo/script/*", reqSignedIn, hs.Index)
|
|
|
|
r.Get("/import/dashboard", reqSignedIn, hs.Index)
|
|
|
|
r.Get("/dashboards/", reqSignedIn, hs.Index)
|
|
|
|
r.Get("/dashboards/*", reqSignedIn, hs.Index)
|
2020-10-14 05:48:48 -05:00
|
|
|
r.Get("/goto/:uid", reqSignedIn, hs.redirectFromShortURL, hs.Index)
|
2018-10-09 10:47:43 -05:00
|
|
|
|
2021-07-02 07:43:12 -05:00
|
|
|
r.Get("/explore", authorize(func(c *models.ReqContext) {
|
|
|
|
if f, ok := reqSignedIn.(func(c *models.ReqContext)); ok {
|
|
|
|
f(c)
|
|
|
|
}
|
|
|
|
middleware.EnsureEditorOrViewerCanEdit(c)
|
2021-08-24 04:36:28 -05:00
|
|
|
}, ac.EvalPermission(ac.ActionDatasourcesExplore)), hs.Index)
|
2018-10-09 10:47:43 -05:00
|
|
|
|
|
|
|
r.Get("/playlists/", reqSignedIn, hs.Index)
|
|
|
|
r.Get("/playlists/*", reqSignedIn, hs.Index)
|
2021-05-17 03:15:17 -05:00
|
|
|
r.Get("/alerting/", reqSignedIn, hs.Index)
|
|
|
|
r.Get("/alerting/*", reqSignedIn, hs.Index)
|
2015-12-22 04:07:15 -06:00
|
|
|
|
2015-01-14 07:25:12 -06:00
|
|
|
// sign up
|
2020-09-07 10:24:46 -05:00
|
|
|
r.Get("/verify", hs.Index)
|
2018-10-09 10:47:43 -05:00
|
|
|
r.Get("/signup", hs.Index)
|
2021-01-15 07:43:20 -06:00
|
|
|
r.Get("/api/user/signup/options", routing.Wrap(GetSignUpOptions))
|
2022-01-27 03:33:02 -06:00
|
|
|
r.Post("/api/user/signup", quota("user"), routing.Wrap(hs.SignUp))
|
2021-11-29 03:18:01 -06:00
|
|
|
r.Post("/api/user/signup/step2", routing.Wrap(hs.SignUpStep2))
|
2014-12-15 14:25:02 -06:00
|
|
|
|
2015-07-20 08:52:49 -05:00
|
|
|
// invited
|
2022-01-31 10:24:52 -06:00
|
|
|
r.Get("/api/user/invite/:code", routing.Wrap(hs.GetInviteInfoByCode))
|
2021-11-29 03:18:01 -06:00
|
|
|
r.Post("/api/user/invite/complete", routing.Wrap(hs.CompleteInvite))
|
2015-07-20 08:52:49 -05:00
|
|
|
|
2015-06-08 03:57:01 -05:00
|
|
|
// reset password
|
2021-06-14 11:02:05 -05:00
|
|
|
r.Get("/user/password/send-reset-email", reqNotSignedIn, hs.Index)
|
2018-10-09 10:47:43 -05:00
|
|
|
r.Get("/user/password/reset", hs.Index)
|
2015-06-08 03:57:01 -05:00
|
|
|
|
2022-02-03 03:33:46 -06:00
|
|
|
r.Post("/api/user/password/send-reset-email", routing.Wrap(hs.SendResetPasswordEmail))
|
|
|
|
r.Post("/api/user/password/reset", routing.Wrap(hs.ResetPassword))
|
2014-12-15 14:25:02 -06:00
|
|
|
|
2015-03-21 07:53:16 -05:00
|
|
|
// dashboard snapshots
|
2021-03-16 10:46:34 -05:00
|
|
|
r.Get("/dashboard/snapshot/*", reqNoAuth, hs.Index)
|
2018-10-09 10:47:43 -05:00
|
|
|
r.Get("/dashboard/snapshots/", reqSignedIn, hs.Index)
|
2015-03-26 14:34:58 -05:00
|
|
|
|
2019-02-04 10:37:07 -06:00
|
|
|
// api renew session based on cookie
|
2021-01-15 07:43:20 -06:00
|
|
|
r.Get("/api/login/ping", quota("session"), routing.Wrap(hs.LoginAPIPing))
|
2015-04-07 02:25:00 -05:00
|
|
|
|
2021-04-21 08:17:23 -05:00
|
|
|
// expose plugin file system assets
|
2021-09-08 01:49:05 -05:00
|
|
|
r.Get("/public/plugins/:pluginId/*", hs.getPluginAssets)
|
2021-04-21 08:17:23 -05:00
|
|
|
|
2022-02-08 06:38:43 -06:00
|
|
|
if hs.Features.IsEnabled(featuremgmt.FlagSwaggerUi) {
|
|
|
|
r.Get("/swagger-ui", swaggerUI)
|
|
|
|
}
|
|
|
|
|
2015-01-14 07:25:12 -06:00
|
|
|
// authed api
|
2018-06-25 09:36:47 -05:00
|
|
|
r.Group("/api", func(apiRoute routing.RouteRegister) {
|
2015-05-19 04:47:14 -05:00
|
|
|
// user (signed in)
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/user", func(userRoute routing.RouteRegister) {
|
2022-01-05 02:59:17 -06:00
|
|
|
userRoute.Get("/", routing.Wrap(hs.GetSignedInUser))
|
2022-01-26 13:24:05 -06:00
|
|
|
userRoute.Put("/", routing.Wrap(hs.UpdateSignedInUser))
|
|
|
|
userRoute.Post("/using/:id", routing.Wrap(hs.UserSetUsingOrg))
|
|
|
|
userRoute.Get("/orgs", routing.Wrap(hs.GetSignedInUserOrgList))
|
|
|
|
userRoute.Get("/teams", routing.Wrap(hs.GetSignedInUserTeamList))
|
2021-01-15 07:43:20 -06:00
|
|
|
|
2022-01-24 04:52:35 -06:00
|
|
|
userRoute.Post("/stars/dashboard/:id", routing.Wrap(hs.StarDashboard))
|
|
|
|
userRoute.Delete("/stars/dashboard/:id", routing.Wrap(hs.UnstarDashboard))
|
2021-01-15 07:43:20 -06:00
|
|
|
|
2022-01-26 13:24:05 -06:00
|
|
|
userRoute.Put("/password", routing.Wrap(hs.ChangeUserPassword))
|
2022-02-03 02:20:20 -06:00
|
|
|
userRoute.Get("/quotas", routing.Wrap(hs.GetUserQuotas))
|
2022-01-26 13:24:05 -06:00
|
|
|
userRoute.Put("/helpflags/:id", routing.Wrap(hs.SetHelpFlag))
|
2016-11-09 03:41:39 -06:00
|
|
|
// For dev purpose
|
2022-01-26 13:24:05 -06:00
|
|
|
userRoute.Get("/helpflags/clear", routing.Wrap(hs.ClearHelpFlags))
|
2016-04-02 15:54:06 -05:00
|
|
|
|
2021-11-02 07:41:45 -05:00
|
|
|
userRoute.Get("/preferences", routing.Wrap(hs.GetUserPreferences))
|
2021-11-29 03:18:01 -06:00
|
|
|
userRoute.Put("/preferences", routing.Wrap(hs.UpdateUserPreferences))
|
2019-03-08 08:15:38 -06:00
|
|
|
|
2021-01-15 07:43:20 -06:00
|
|
|
userRoute.Get("/auth-tokens", routing.Wrap(hs.GetUserAuthTokens))
|
2021-11-29 03:18:01 -06:00
|
|
|
userRoute.Post("/revoke-auth-token", routing.Wrap(hs.RevokeUserAuthToken))
|
2021-02-27 11:04:28 -06:00
|
|
|
}, reqSignedInNoAnonymous)
|
2015-01-19 11:01:04 -06:00
|
|
|
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/users", func(usersRoute routing.RouteRegister) {
|
2021-10-07 04:54:43 -05:00
|
|
|
userIDScope := ac.Scope("global", "users", "id", ac.Parameter(":id"))
|
2021-09-29 05:51:49 -05:00
|
|
|
usersRoute.Get("/", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersRead, ac.ScopeGlobalUsersAll)), routing.Wrap(hs.searchUsersService.SearchUsers))
|
|
|
|
usersRoute.Get("/search", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersRead, ac.ScopeGlobalUsersAll)), routing.Wrap(hs.searchUsersService.SearchUsersWithPaging))
|
2022-01-05 02:59:17 -06:00
|
|
|
usersRoute.Get("/:id", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersRead, userIDScope)), routing.Wrap(hs.GetUserByID))
|
2022-01-26 13:24:05 -06:00
|
|
|
usersRoute.Get("/:id/teams", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersTeamRead, userIDScope)), routing.Wrap(hs.GetUserTeams))
|
|
|
|
usersRoute.Get("/:id/orgs", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersRead, userIDScope)), routing.Wrap(hs.GetUserOrgList))
|
2017-01-30 23:25:55 -06:00
|
|
|
// query parameters /users/lookup?loginOrEmail=admin@example.com
|
2022-01-26 13:24:05 -06:00
|
|
|
usersRoute.Get("/lookup", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersRead, ac.ScopeGlobalUsersAll)), routing.Wrap(hs.GetUserByLoginOrEmail))
|
|
|
|
usersRoute.Put("/:id", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersWrite, userIDScope)), routing.Wrap(hs.UpdateUser))
|
|
|
|
usersRoute.Post("/:id/using/:orgId", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersWrite, userIDScope)), routing.Wrap(hs.UpdateUserActiveOrg))
|
2021-04-14 09:31:27 -05:00
|
|
|
})
|
2015-05-18 10:28:15 -05:00
|
|
|
|
2017-12-08 09:25:45 -06:00
|
|
|
// team (admin permission required)
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/teams", func(teamsRoute routing.RouteRegister) {
|
2022-01-26 08:48:41 -06:00
|
|
|
teamsRoute.Post("/", authorize(reqCanAccessTeams, ac.EvalPermission(ac.ActionTeamsCreate)), routing.Wrap(hs.CreateTeam))
|
2022-01-27 09:16:44 -06:00
|
|
|
teamsRoute.Put("/:teamId", authorize(reqCanAccessTeams, ac.EvalPermission(ac.ActionTeamsWrite, ac.ScopeTeamsID)), routing.Wrap(hs.UpdateTeam))
|
|
|
|
teamsRoute.Delete("/:teamId", authorize(reqCanAccessTeams, ac.EvalPermission(ac.ActionTeamsDelete, ac.ScopeTeamsID)), routing.Wrap(hs.DeleteTeamByID))
|
2022-01-26 08:48:41 -06:00
|
|
|
teamsRoute.Get("/:teamId/members", authorize(reqCanAccessTeams, ac.EvalPermission(ac.ActionTeamsPermissionsRead, ac.ScopeTeamsID)), routing.Wrap(hs.GetTeamMembers))
|
|
|
|
teamsRoute.Post("/:teamId/members", authorize(reqCanAccessTeams, ac.EvalPermission(ac.ActionTeamsPermissionsWrite, ac.ScopeTeamsID)), routing.Wrap(hs.AddTeamMember))
|
|
|
|
teamsRoute.Put("/:teamId/members/:userId", authorize(reqCanAccessTeams, ac.EvalPermission(ac.ActionTeamsPermissionsWrite, ac.ScopeTeamsID)), routing.Wrap(hs.UpdateTeamMember))
|
|
|
|
teamsRoute.Delete("/:teamId/members/:userId", authorize(reqCanAccessTeams, ac.EvalPermission(ac.ActionTeamsPermissionsWrite, ac.ScopeTeamsID)), routing.Wrap(hs.RemoveTeamMember))
|
2022-01-28 05:17:54 -06:00
|
|
|
teamsRoute.Get("/:teamId/preferences", authorize(reqCanAccessTeams, ac.EvalPermission(ac.ActionTeamsRead, ac.ScopeTeamsID)), routing.Wrap(hs.GetTeamPreferences))
|
|
|
|
teamsRoute.Put("/:teamId/preferences", authorize(reqCanAccessTeams, ac.EvalPermission(ac.ActionTeamsWrite, ac.ScopeTeamsID)), routing.Wrap(hs.UpdateTeamPreferences))
|
2022-01-10 11:05:53 -06:00
|
|
|
})
|
2017-04-09 18:24:16 -05:00
|
|
|
|
2018-04-06 07:08:23 -05:00
|
|
|
// team without requirement of user to be org admin
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/teams", func(teamsRoute routing.RouteRegister) {
|
2022-02-09 09:17:31 -06:00
|
|
|
teamsRoute.Get("/:teamId", authorize(reqSignedIn, ac.EvalPermission(ac.ActionTeamsRead, ac.ScopeTeamsID)), routing.Wrap(hs.GetTeamByID))
|
|
|
|
teamsRoute.Get("/search", authorize(reqSignedIn, ac.EvalPermission(ac.ActionTeamsRead)), routing.Wrap(hs.SearchTeams))
|
2018-04-06 07:08:23 -05:00
|
|
|
})
|
|
|
|
|
2015-09-10 12:18:36 -05:00
|
|
|
// org information available to all users.
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/org", func(orgRoute routing.RouteRegister) {
|
2021-11-17 03:12:28 -06:00
|
|
|
orgRoute.Get("/", authorize(reqSignedIn, ac.EvalPermission(ActionOrgsRead)), routing.Wrap(GetCurrentOrg))
|
|
|
|
orgRoute.Get("/quotas", authorize(reqSignedIn, ac.EvalPermission(ActionOrgsQuotasRead)), routing.Wrap(hs.GetCurrentOrgQuotas))
|
2015-09-10 12:18:36 -05:00
|
|
|
})
|
|
|
|
|
|
|
|
// current org
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/org", func(orgRoute routing.RouteRegister) {
|
2021-10-07 04:54:43 -05:00
|
|
|
userIDScope := ac.Scope("users", "id", ac.Parameter(":userId"))
|
2022-01-25 13:30:08 -06:00
|
|
|
orgRoute.Put("/", authorize(reqOrgAdmin, ac.EvalPermission(ActionOrgsWrite)), routing.Wrap(hs.UpdateCurrentOrg))
|
|
|
|
orgRoute.Put("/address", authorize(reqOrgAdmin, ac.EvalPermission(ActionOrgsWrite)), routing.Wrap(hs.UpdateCurrentOrgAddress))
|
2022-01-13 07:40:32 -06:00
|
|
|
orgRoute.Get("/users", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgUsersRead)), routing.Wrap(hs.GetOrgUsersForCurrentOrg))
|
|
|
|
orgRoute.Get("/users/search", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgUsersRead)), routing.Wrap(hs.SearchOrgUsersWithPaging))
|
2021-11-29 03:18:01 -06:00
|
|
|
orgRoute.Post("/users", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgUsersAdd, ac.ScopeUsersAll)), quota("user"), routing.Wrap(hs.AddOrgUserToCurrentOrg))
|
|
|
|
orgRoute.Patch("/users/:userId", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgUsersRoleUpdate, userIDScope)), routing.Wrap(hs.UpdateOrgUserForCurrentOrg))
|
2021-11-17 03:12:28 -06:00
|
|
|
orgRoute.Delete("/users/:userId", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgUsersRemove, userIDScope)), routing.Wrap(hs.RemoveOrgUserForCurrentOrg))
|
2015-07-17 02:51:34 -05:00
|
|
|
|
|
|
|
// invites
|
2022-01-31 10:24:52 -06:00
|
|
|
orgRoute.Get("/invites", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionUsersCreate)), routing.Wrap(hs.GetPendingOrgInvites))
|
|
|
|
orgRoute.Post("/invites", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionUsersCreate)), quota("user"), routing.Wrap(hs.AddOrgInvite))
|
|
|
|
orgRoute.Patch("/invites/:code/revoke", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionUsersCreate)), routing.Wrap(hs.RevokeInvite))
|
2015-12-17 23:46:40 -06:00
|
|
|
|
2016-04-02 15:54:06 -05:00
|
|
|
// prefs
|
2021-11-17 03:12:28 -06:00
|
|
|
orgRoute.Get("/preferences", authorize(reqOrgAdmin, ac.EvalPermission(ActionOrgsPreferencesRead)), routing.Wrap(hs.GetOrgPreferences))
|
2021-11-29 03:18:01 -06:00
|
|
|
orgRoute.Put("/preferences", authorize(reqOrgAdmin, ac.EvalPermission(ActionOrgsPreferencesWrite)), routing.Wrap(hs.UpdateOrgPreferences))
|
2021-04-22 05:19:41 -05:00
|
|
|
})
|
2015-05-19 03:16:32 -05:00
|
|
|
|
2018-04-06 07:08:23 -05:00
|
|
|
// current org without requirement of user to be org admin
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/org", func(orgRoute routing.RouteRegister) {
|
2022-01-13 07:40:32 -06:00
|
|
|
orgRoute.Get("/users/lookup", authorize(reqOrgAdminFolderAdminOrTeamAdmin, ac.EvalPermission(ac.ActionOrgUsersRead)), routing.Wrap(hs.GetOrgUsersForCurrentOrgLookup))
|
2018-04-06 07:08:23 -05:00
|
|
|
})
|
|
|
|
|
2015-05-19 03:16:32 -05:00
|
|
|
// create new org
|
2021-11-29 03:18:01 -06:00
|
|
|
apiRoute.Post("/orgs", authorizeInOrg(reqSignedIn, acmiddleware.UseGlobalOrg, ac.EvalPermission(ActionOrgsCreate)), quota("org"), routing.Wrap(hs.CreateOrg))
|
2015-05-19 03:16:32 -05:00
|
|
|
|
2015-05-19 04:47:14 -05:00
|
|
|
// search all orgs
|
2022-02-09 04:45:31 -06:00
|
|
|
apiRoute.Get("/orgs", authorizeInOrg(reqGrafanaAdmin, acmiddleware.UseGlobalOrg, ac.EvalPermission(ActionOrgsRead)), routing.Wrap(hs.SearchOrgs))
|
2015-05-19 04:47:14 -05:00
|
|
|
|
2015-05-19 03:16:32 -05:00
|
|
|
// orgs (admin routes)
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/orgs/:orgId", func(orgsRoute routing.RouteRegister) {
|
2021-11-17 03:12:28 -06:00
|
|
|
userIDScope := ac.Scope("users", "id", ac.Parameter(":userId"))
|
|
|
|
orgsRoute.Get("/", authorizeInOrg(reqGrafanaAdmin, acmiddleware.UseOrgFromContextParams, ac.EvalPermission(ActionOrgsRead)), routing.Wrap(GetOrgByID))
|
2022-01-25 13:30:08 -06:00
|
|
|
orgsRoute.Put("/", authorizeInOrg(reqGrafanaAdmin, acmiddleware.UseOrgFromContextParams, ac.EvalPermission(ActionOrgsWrite)), routing.Wrap(hs.UpdateOrg))
|
|
|
|
orgsRoute.Put("/address", authorizeInOrg(reqGrafanaAdmin, acmiddleware.UseOrgFromContextParams, ac.EvalPermission(ActionOrgsWrite)), routing.Wrap(hs.UpdateOrgAddress))
|
|
|
|
orgsRoute.Delete("/", authorizeInOrg(reqGrafanaAdmin, acmiddleware.UseOrgFromContextParams, ac.EvalPermission(ActionOrgsDelete)), routing.Wrap(hs.DeleteOrgByID))
|
2021-11-17 03:12:28 -06:00
|
|
|
orgsRoute.Get("/users", authorizeInOrg(reqGrafanaAdmin, acmiddleware.UseOrgFromContextParams, ac.EvalPermission(ac.ActionOrgUsersRead, ac.ScopeUsersAll)), routing.Wrap(hs.GetOrgUsers))
|
2021-11-29 03:18:01 -06:00
|
|
|
orgsRoute.Post("/users", authorizeInOrg(reqGrafanaAdmin, acmiddleware.UseOrgFromContextParams, ac.EvalPermission(ac.ActionOrgUsersAdd, ac.ScopeUsersAll)), routing.Wrap(hs.AddOrgUser))
|
|
|
|
orgsRoute.Patch("/users/:userId", authorizeInOrg(reqGrafanaAdmin, acmiddleware.UseOrgFromContextParams, ac.EvalPermission(ac.ActionOrgUsersRoleUpdate, userIDScope)), routing.Wrap(hs.UpdateOrgUser))
|
2021-11-17 03:12:28 -06:00
|
|
|
orgsRoute.Delete("/users/:userId", authorizeInOrg(reqGrafanaAdmin, acmiddleware.UseOrgFromContextParams, ac.EvalPermission(ac.ActionOrgUsersRemove, userIDScope)), routing.Wrap(hs.RemoveOrgUser))
|
|
|
|
orgsRoute.Get("/quotas", authorizeInOrg(reqGrafanaAdmin, acmiddleware.UseOrgFromContextParams, ac.EvalPermission(ActionOrgsQuotasRead)), routing.Wrap(hs.GetOrgQuotas))
|
2021-11-29 03:18:01 -06:00
|
|
|
orgsRoute.Put("/quotas/:target", authorizeInOrg(reqGrafanaAdmin, acmiddleware.UseOrgFromContextParams, ac.EvalPermission(ActionOrgsQuotasWrite)), routing.Wrap(hs.UpdateOrgQuota))
|
2021-04-22 05:19:41 -05:00
|
|
|
})
|
2015-01-26 13:26:17 -06:00
|
|
|
|
2016-01-12 15:50:56 -06:00
|
|
|
// orgs (admin routes)
|
2021-11-17 03:12:28 -06:00
|
|
|
apiRoute.Get("/orgs/name/:name/", authorizeInOrg(reqGrafanaAdmin, acmiddleware.UseGlobalOrg, ac.EvalPermission(ActionOrgsRead)), routing.Wrap(hs.GetOrgByName))
|
2016-01-12 15:50:56 -06:00
|
|
|
|
2015-01-27 01:26:11 -06:00
|
|
|
// auth api keys
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/auth/keys", func(keysRoute routing.RouteRegister) {
|
2022-02-07 07:14:54 -06:00
|
|
|
keysRoute.Get("/", routing.Wrap(hs.GetAPIKeys))
|
2022-02-03 02:59:26 -06:00
|
|
|
keysRoute.Post("/", quota("api_key"), routing.Wrap(hs.AddAPIKey))
|
2022-02-07 07:14:54 -06:00
|
|
|
keysRoute.Delete("/:id", routing.Wrap(hs.DeleteAPIKey))
|
2015-12-03 09:43:55 -06:00
|
|
|
}, reqOrgAdmin)
|
2015-01-26 13:26:17 -06:00
|
|
|
|
2016-03-17 01:35:06 -05:00
|
|
|
// Preferences
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/preferences", func(prefRoute routing.RouteRegister) {
|
2022-02-03 02:20:20 -06:00
|
|
|
prefRoute.Post("/set-home-dash", routing.Wrap(hs.SetHomeDashboard))
|
2016-03-17 01:35:06 -05:00
|
|
|
})
|
2016-03-11 08:30:05 -06:00
|
|
|
|
2015-01-14 07:25:12 -06:00
|
|
|
// Data sources
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/datasources", func(datasourceRoute routing.RouteRegister) {
|
2022-01-17 03:16:12 -06:00
|
|
|
datasourceRoute.Get("/", authorize(reqOrgAdmin, ac.EvalPermission(ActionDatasourcesRead)), routing.Wrap(hs.GetDataSources))
|
2022-02-09 07:01:32 -06:00
|
|
|
datasourceRoute.Post("/", authorize(reqOrgAdmin, ac.EvalPermission(ActionDatasourcesCreate)), quota("data_source"), routing.Wrap(hs.AddDataSource))
|
2021-11-29 03:18:01 -06:00
|
|
|
datasourceRoute.Put("/:id", authorize(reqOrgAdmin, ac.EvalPermission(ActionDatasourcesWrite, ScopeDatasourceID)), routing.Wrap(hs.UpdateDataSource))
|
2021-09-01 08:18:17 -05:00
|
|
|
datasourceRoute.Delete("/:id", authorize(reqOrgAdmin, ac.EvalPermission(ActionDatasourcesDelete, ScopeDatasourceID)), routing.Wrap(hs.DeleteDataSourceById))
|
|
|
|
datasourceRoute.Delete("/uid/:uid", authorize(reqOrgAdmin, ac.EvalPermission(ActionDatasourcesDelete, ScopeDatasourceUID)), routing.Wrap(hs.DeleteDataSourceByUID))
|
|
|
|
datasourceRoute.Delete("/name/:name", authorize(reqOrgAdmin, ac.EvalPermission(ActionDatasourcesDelete, ScopeDatasourceName)), routing.Wrap(hs.DeleteDataSourceByName))
|
2022-01-17 03:16:12 -06:00
|
|
|
datasourceRoute.Get("/:id", authorize(reqOrgAdmin, ac.EvalPermission(ActionDatasourcesRead)), routing.Wrap(hs.GetDataSourceById))
|
|
|
|
datasourceRoute.Get("/uid/:uid", authorize(reqOrgAdmin, ac.EvalPermission(ActionDatasourcesRead)), routing.Wrap(hs.GetDataSourceByUID))
|
2022-02-09 07:01:32 -06:00
|
|
|
datasourceRoute.Get("/name/:name", authorize(reqOrgAdmin, ac.EvalPermission(ActionDatasourcesRead)), routing.Wrap(hs.GetDataSourceByName))
|
2021-09-01 08:18:17 -05:00
|
|
|
})
|
2015-12-03 09:43:55 -06:00
|
|
|
|
2022-02-09 07:01:32 -06:00
|
|
|
apiRoute.Get("/datasources/id/:name", authorize(reqSignedIn, ac.EvalPermission(ActionDatasourcesIDRead, ScopeDatasourceName)), routing.Wrap(hs.GetDataSourceIdByName))
|
2016-03-07 14:25:26 -06:00
|
|
|
|
2021-01-15 07:43:20 -06:00
|
|
|
apiRoute.Get("/plugins", routing.Wrap(hs.GetPluginList))
|
2021-03-17 10:06:10 -05:00
|
|
|
apiRoute.Get("/plugins/:pluginId/settings", routing.Wrap(hs.GetPluginSettingByID))
|
2021-03-08 00:02:49 -06:00
|
|
|
apiRoute.Get("/plugins/:pluginId/markdown/:name", routing.Wrap(hs.GetPluginMarkdown))
|
2021-01-15 07:43:20 -06:00
|
|
|
apiRoute.Get("/plugins/:pluginId/health", routing.Wrap(hs.CheckHealth))
|
2020-03-03 04:45:16 -06:00
|
|
|
apiRoute.Any("/plugins/:pluginId/resources", hs.CallResource)
|
|
|
|
apiRoute.Any("/plugins/:pluginId/resources/*", hs.CallResource)
|
2021-05-12 13:05:16 -05:00
|
|
|
apiRoute.Get("/plugins/errors", routing.Wrap(hs.GetPluginErrorsList))
|
|
|
|
|
2021-08-04 04:49:05 -05:00
|
|
|
apiRoute.Group("/plugins", func(pluginRoute routing.RouteRegister) {
|
2021-11-29 03:18:01 -06:00
|
|
|
pluginRoute.Post("/:pluginId/install", routing.Wrap(hs.InstallPlugin))
|
2021-08-04 04:49:05 -05:00
|
|
|
pluginRoute.Post("/:pluginId/uninstall", routing.Wrap(hs.UninstallPlugin))
|
|
|
|
}, reqGrafanaAdmin)
|
2016-03-11 02:57:20 -06:00
|
|
|
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/plugins", func(pluginRoute routing.RouteRegister) {
|
2021-03-08 00:02:49 -06:00
|
|
|
pluginRoute.Get("/:pluginId/dashboards/", routing.Wrap(hs.GetPluginDashboards))
|
2021-11-29 03:18:01 -06:00
|
|
|
pluginRoute.Post("/:pluginId/settings", routing.Wrap(hs.UpdatePluginSetting))
|
2021-01-15 07:43:20 -06:00
|
|
|
pluginRoute.Get("/:pluginId/metrics", routing.Wrap(hs.CollectPluginMetrics))
|
2015-12-03 09:43:55 -06:00
|
|
|
}, reqOrgAdmin)
|
|
|
|
|
2018-10-09 10:47:43 -05:00
|
|
|
apiRoute.Get("/frontend/settings/", hs.GetFrontendSettings)
|
2021-10-21 08:41:40 -05:00
|
|
|
apiRoute.Any("/datasources/proxy/:id/*", authorize(reqSignedIn, ac.EvalPermission(ActionDatasourcesQuery)), hs.ProxyDataSourceRequest)
|
|
|
|
apiRoute.Any("/datasources/proxy/:id", authorize(reqSignedIn, ac.EvalPermission(ActionDatasourcesQuery)), hs.ProxyDataSourceRequest)
|
|
|
|
apiRoute.Any("/datasources/:id/resources", authorize(reqSignedIn, ac.EvalPermission(ActionDatasourcesQuery)), hs.CallDatasourceResource)
|
|
|
|
apiRoute.Any("/datasources/:id/resources/*", authorize(reqSignedIn, ac.EvalPermission(ActionDatasourcesQuery)), hs.CallDatasourceResource)
|
|
|
|
apiRoute.Any("/datasources/:id/health", authorize(reqSignedIn, ac.EvalPermission(ActionDatasourcesQuery)), routing.Wrap(hs.CheckDatasourceHealth))
|
2015-02-10 03:19:43 -06:00
|
|
|
|
2018-01-29 06:51:01 -06:00
|
|
|
// Folders
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/folders", func(folderRoute routing.RouteRegister) {
|
2021-03-17 10:06:10 -05:00
|
|
|
folderRoute.Get("/", routing.Wrap(hs.GetFolders))
|
|
|
|
folderRoute.Get("/id/:id", routing.Wrap(hs.GetFolderByID))
|
2021-11-29 03:18:01 -06:00
|
|
|
folderRoute.Post("/", routing.Wrap(hs.CreateFolder))
|
2018-02-20 08:25:16 -06:00
|
|
|
|
2018-06-25 09:36:47 -05:00
|
|
|
folderRoute.Group("/:uid", func(folderUidRoute routing.RouteRegister) {
|
2021-03-17 10:06:10 -05:00
|
|
|
folderUidRoute.Get("/", routing.Wrap(hs.GetFolderByUID))
|
2021-11-29 03:18:01 -06:00
|
|
|
folderUidRoute.Put("/", routing.Wrap(hs.UpdateFolder))
|
2021-03-02 03:34:01 -06:00
|
|
|
folderUidRoute.Delete("/", routing.Wrap(hs.DeleteFolder))
|
2018-02-20 08:25:16 -06:00
|
|
|
|
2018-06-25 09:36:47 -05:00
|
|
|
folderUidRoute.Group("/permissions", func(folderPermissionRoute routing.RouteRegister) {
|
2021-01-15 07:43:20 -06:00
|
|
|
folderPermissionRoute.Get("/", routing.Wrap(hs.GetFolderPermissionList))
|
2021-11-29 03:18:01 -06:00
|
|
|
folderPermissionRoute.Post("/", routing.Wrap(hs.UpdateFolderPermissions))
|
2018-02-20 08:25:16 -06:00
|
|
|
})
|
|
|
|
})
|
2018-01-29 06:51:01 -06:00
|
|
|
})
|
|
|
|
|
2015-01-14 07:25:12 -06:00
|
|
|
// Dashboard
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/dashboards", func(dashboardRoute routing.RouteRegister) {
|
2021-01-15 07:43:20 -06:00
|
|
|
dashboardRoute.Get("/uid/:uid", routing.Wrap(hs.GetDashboard))
|
2021-01-20 02:28:10 -06:00
|
|
|
dashboardRoute.Delete("/uid/:uid", routing.Wrap(hs.DeleteDashboardByUID))
|
2018-01-29 14:23:07 -06:00
|
|
|
|
2021-12-23 11:43:53 -06:00
|
|
|
if hs.ThumbService != nil {
|
2022-02-09 03:23:32 -06:00
|
|
|
dashboardRoute.Get("/uid/:uid/img/:kind/:theme", hs.ThumbService.GetImage)
|
|
|
|
dashboardRoute.Post("/uid/:uid/img/:kind/:theme", hs.ThumbService.SetImage)
|
|
|
|
dashboardRoute.Put("/uid/:uid/img/:kind/:theme", hs.ThumbService.UpdateThumbnailState)
|
2021-12-23 11:43:53 -06:00
|
|
|
}
|
|
|
|
|
2022-02-10 02:58:52 -06:00
|
|
|
dashboardRoute.Post("/calculate-diff", routing.Wrap(hs.CalculateDashboardDiff))
|
2021-11-29 03:18:01 -06:00
|
|
|
dashboardRoute.Post("/trim", routing.Wrap(hs.TrimDashboard))
|
2017-06-07 04:50:09 -05:00
|
|
|
|
2021-11-29 03:18:01 -06:00
|
|
|
dashboardRoute.Post("/db", routing.Wrap(hs.PostDashboard))
|
2021-01-15 07:43:20 -06:00
|
|
|
dashboardRoute.Get("/home", routing.Wrap(hs.GetHomeDashboard))
|
2022-02-07 05:43:43 -06:00
|
|
|
dashboardRoute.Get("/tags", hs.GetDashboardTags)
|
2017-10-12 10:38:49 -05:00
|
|
|
|
2018-06-25 09:36:47 -05:00
|
|
|
dashboardRoute.Group("/id/:dashboardId", func(dashIdRoute routing.RouteRegister) {
|
2022-02-07 05:43:43 -06:00
|
|
|
dashIdRoute.Get("/versions", routing.Wrap(hs.GetDashboardVersions))
|
|
|
|
dashIdRoute.Get("/versions/:id", routing.Wrap(hs.GetDashboardVersion))
|
2021-11-29 03:18:01 -06:00
|
|
|
dashIdRoute.Post("/restore", routing.Wrap(hs.RestoreDashboardVersion))
|
2017-10-12 10:38:49 -05:00
|
|
|
|
2018-06-25 09:36:47 -05:00
|
|
|
dashIdRoute.Group("/permissions", func(dashboardPermissionRoute routing.RouteRegister) {
|
2021-01-15 07:43:20 -06:00
|
|
|
dashboardPermissionRoute.Get("/", routing.Wrap(hs.GetDashboardPermissionList))
|
2021-11-29 03:18:01 -06:00
|
|
|
dashboardPermissionRoute.Post("/", routing.Wrap(hs.UpdateDashboardPermissions))
|
2017-10-12 10:38:49 -05:00
|
|
|
})
|
|
|
|
})
|
2015-01-14 07:25:12 -06:00
|
|
|
})
|
2015-01-26 13:26:17 -06:00
|
|
|
|
2016-01-19 07:05:24 -06:00
|
|
|
// Dashboard snapshots
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/dashboard/snapshots", func(dashboardRoute routing.RouteRegister) {
|
2022-02-08 10:57:59 -06:00
|
|
|
dashboardRoute.Get("/", routing.Wrap(hs.SearchDashboardSnapshots))
|
2016-01-19 07:05:24 -06:00
|
|
|
})
|
2016-01-19 03:37:36 -06:00
|
|
|
|
2015-12-22 04:07:15 -06:00
|
|
|
// Playlist
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/playlists", func(playlistRoute routing.RouteRegister) {
|
2022-01-27 03:33:02 -06:00
|
|
|
playlistRoute.Get("/", routing.Wrap(hs.SearchPlaylists))
|
|
|
|
playlistRoute.Get("/:id", hs.ValidateOrgPlaylist, routing.Wrap(hs.GetPlaylist))
|
|
|
|
playlistRoute.Get("/:id/items", hs.ValidateOrgPlaylist, routing.Wrap(hs.GetPlaylistItems))
|
|
|
|
playlistRoute.Get("/:id/dashboards", hs.ValidateOrgPlaylist, routing.Wrap(hs.GetPlaylistDashboards))
|
|
|
|
playlistRoute.Delete("/:id", reqEditorRole, hs.ValidateOrgPlaylist, routing.Wrap(hs.DeletePlaylist))
|
|
|
|
playlistRoute.Put("/:id", reqEditorRole, hs.ValidateOrgPlaylist, routing.Wrap(hs.UpdatePlaylist))
|
|
|
|
playlistRoute.Post("/", reqEditorRole, routing.Wrap(hs.CreatePlaylist))
|
2015-12-22 04:07:15 -06:00
|
|
|
})
|
|
|
|
|
2015-01-14 07:25:12 -06:00
|
|
|
// Search
|
2021-01-15 07:43:20 -06:00
|
|
|
apiRoute.Get("/search/sorting", routing.Wrap(hs.ListSortOptions))
|
2022-02-03 11:46:38 -06:00
|
|
|
apiRoute.Get("/search/", routing.Wrap(hs.Search))
|
2015-01-26 13:26:17 -06:00
|
|
|
|
2015-01-14 07:25:12 -06:00
|
|
|
// metrics
|
2021-11-29 03:18:01 -06:00
|
|
|
apiRoute.Post("/tsdb/query", authorize(reqSignedIn, ac.EvalPermission(ActionDatasourcesQuery)), routing.Wrap(hs.QueryMetrics))
|
2017-09-13 07:53:38 -05:00
|
|
|
|
2019-10-31 18:22:00 -05:00
|
|
|
// DataSource w/ expressions
|
2021-11-29 03:18:01 -06:00
|
|
|
apiRoute.Post("/ds/query", authorize(reqSignedIn, ac.EvalPermission(ActionDatasourcesQuery)), routing.Wrap(hs.QueryMetricsV2))
|
2019-10-31 18:22:00 -05:00
|
|
|
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/alerts", func(alertsRoute routing.RouteRegister) {
|
2021-11-29 03:18:01 -06:00
|
|
|
alertsRoute.Post("/test", routing.Wrap(hs.AlertTest))
|
2022-02-04 06:41:15 -06:00
|
|
|
alertsRoute.Post("/:alertId/pause", reqEditorRole, routing.Wrap(hs.PauseAlert))
|
|
|
|
alertsRoute.Get("/:alertId", hs.ValidateOrgAlert, routing.Wrap(hs.GetAlert))
|
|
|
|
alertsRoute.Get("/", routing.Wrap(hs.GetAlerts))
|
|
|
|
alertsRoute.Get("/states-for-dashboard", routing.Wrap(hs.GetAlertStatesForDashboard))
|
2016-04-26 10:36:50 -05:00
|
|
|
})
|
|
|
|
|
2021-05-04 06:58:39 -05:00
|
|
|
apiRoute.Get("/alert-notifiers", reqEditorRole, routing.Wrap(
|
2022-02-04 06:41:15 -06:00
|
|
|
hs.GetAlertNotifiers(hs.Cfg.UnifiedAlerting.IsEnabled())),
|
2021-05-04 06:58:39 -05:00
|
|
|
)
|
2016-07-14 06:32:16 -05:00
|
|
|
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/alert-notifications", func(alertNotifications routing.RouteRegister) {
|
2022-02-04 06:41:15 -06:00
|
|
|
alertNotifications.Get("/", routing.Wrap(hs.GetAlertNotifications))
|
|
|
|
alertNotifications.Post("/test", routing.Wrap(hs.NotificationTest))
|
|
|
|
alertNotifications.Post("/", routing.Wrap(hs.CreateAlertNotification))
|
2021-11-29 03:18:01 -06:00
|
|
|
alertNotifications.Put("/:notificationId", routing.Wrap(hs.UpdateAlertNotification))
|
2022-02-04 06:41:15 -06:00
|
|
|
alertNotifications.Get("/:notificationId", routing.Wrap(hs.GetAlertNotificationByID))
|
|
|
|
alertNotifications.Delete("/:notificationId", routing.Wrap(hs.DeleteAlertNotification))
|
|
|
|
alertNotifications.Get("/uid/:uid", routing.Wrap(hs.GetAlertNotificationByUID))
|
2021-11-29 03:18:01 -06:00
|
|
|
alertNotifications.Put("/uid/:uid", routing.Wrap(hs.UpdateAlertNotificationByUID))
|
2022-02-04 06:41:15 -06:00
|
|
|
alertNotifications.Delete("/uid/:uid", routing.Wrap(hs.DeleteAlertNotificationByUID))
|
2016-10-19 01:01:14 -05:00
|
|
|
}, reqEditorRole)
|
2016-07-14 06:32:16 -05:00
|
|
|
|
2019-08-12 13:03:48 -05:00
|
|
|
// alert notifications without requirement of user to be org editor
|
|
|
|
apiRoute.Group("/alert-notifications", func(orgRoute routing.RouteRegister) {
|
2022-02-04 06:41:15 -06:00
|
|
|
orgRoute.Get("/lookup", routing.Wrap(hs.GetAlertNotificationLookup))
|
2019-08-12 13:03:48 -05:00
|
|
|
})
|
|
|
|
|
2022-02-11 12:43:29 -06:00
|
|
|
apiRoute.Get("/annotations", authorize(reqSignedIn, ac.EvalPermission(ac.ActionAnnotationsRead, ac.ScopeAnnotationsAll)), routing.Wrap(GetAnnotations))
|
2021-11-29 03:18:01 -06:00
|
|
|
apiRoute.Post("/annotations/mass-delete", reqOrgAdmin, routing.Wrap(DeleteAnnotations))
|
2017-04-12 08:46:41 -05:00
|
|
|
|
2018-06-25 09:36:47 -05:00
|
|
|
apiRoute.Group("/annotations", func(annotationsRoute routing.RouteRegister) {
|
2021-11-29 03:18:01 -06:00
|
|
|
annotationsRoute.Post("/", routing.Wrap(PostAnnotation))
|
2021-01-15 07:43:20 -06:00
|
|
|
annotationsRoute.Delete("/:annotationId", routing.Wrap(DeleteAnnotationByID))
|
2021-11-29 03:18:01 -06:00
|
|
|
annotationsRoute.Put("/:annotationId", routing.Wrap(UpdateAnnotation))
|
|
|
|
annotationsRoute.Patch("/:annotationId", routing.Wrap(PatchAnnotation))
|
|
|
|
annotationsRoute.Post("/graphite", reqEditorRole, routing.Wrap(PostGraphiteAnnotation))
|
2022-02-11 12:43:29 -06:00
|
|
|
annotationsRoute.Get("/tags", authorize(reqSignedIn, ac.EvalPermission(ac.ActionAnnotationsTagsRead, ac.ScopeAnnotationsTagsAll)), routing.Wrap(GetAnnotationTags))
|
2017-12-20 17:52:21 -06:00
|
|
|
})
|
2016-09-08 04:25:45 -05:00
|
|
|
|
2021-11-29 03:18:01 -06:00
|
|
|
apiRoute.Post("/frontend-metrics", routing.Wrap(hs.PostFrontendMetrics))
|
2021-04-01 13:04:02 -05:00
|
|
|
|
2021-05-04 10:44:55 -05:00
|
|
|
apiRoute.Group("/live", func(liveRoute routing.RouteRegister) {
|
|
|
|
// the channel path is in the name
|
2021-11-29 03:18:01 -06:00
|
|
|
liveRoute.Post("/publish", routing.Wrap(hs.Live.HandleHTTPPublish))
|
2021-04-05 11:04:46 -05:00
|
|
|
|
2021-09-09 11:19:29 -05:00
|
|
|
// POST influx line protocol.
|
2021-05-04 10:44:55 -05:00
|
|
|
liveRoute.Post("/push/:streamId", hs.LivePushGateway.Handle)
|
2021-04-05 11:04:46 -05:00
|
|
|
|
2021-05-04 10:44:55 -05:00
|
|
|
// List available streams and fields
|
|
|
|
liveRoute.Get("/list", routing.Wrap(hs.Live.HandleListHTTP))
|
2021-04-23 14:55:31 -05:00
|
|
|
|
2021-05-04 10:44:55 -05:00
|
|
|
// Some channels may have info
|
|
|
|
liveRoute.Get("/info/*", routing.Wrap(hs.Live.HandleInfoHTTP))
|
2021-09-09 11:19:29 -05:00
|
|
|
|
2022-01-26 11:44:20 -06:00
|
|
|
if hs.Features.IsEnabled(featuremgmt.FlagLivePipeline) {
|
2021-09-09 11:19:29 -05:00
|
|
|
// POST Live data to be processed according to channel rules.
|
2021-11-15 03:43:18 -06:00
|
|
|
liveRoute.Post("/pipeline/push/*", hs.LivePushGateway.HandlePipelinePush)
|
2021-09-30 12:28:06 -05:00
|
|
|
liveRoute.Post("/pipeline-convert-test", routing.Wrap(hs.Live.HandlePipelineConvertTestHTTP), reqOrgAdmin)
|
2021-11-05 04:13:40 -05:00
|
|
|
liveRoute.Get("/pipeline-entities", routing.Wrap(hs.Live.HandlePipelineEntitiesListHTTP), reqOrgAdmin)
|
|
|
|
liveRoute.Get("/channel-rules", routing.Wrap(hs.Live.HandleChannelRulesListHTTP), reqOrgAdmin)
|
2021-09-30 11:29:32 -05:00
|
|
|
liveRoute.Post("/channel-rules", routing.Wrap(hs.Live.HandleChannelRulesPostHTTP), reqOrgAdmin)
|
|
|
|
liveRoute.Put("/channel-rules", routing.Wrap(hs.Live.HandleChannelRulesPutHTTP), reqOrgAdmin)
|
|
|
|
liveRoute.Delete("/channel-rules", routing.Wrap(hs.Live.HandleChannelRulesDeleteHTTP), reqOrgAdmin)
|
2021-11-09 10:12:10 -06:00
|
|
|
liveRoute.Get("/write-configs", routing.Wrap(hs.Live.HandleWriteConfigsListHTTP), reqOrgAdmin)
|
|
|
|
liveRoute.Post("/write-configs", routing.Wrap(hs.Live.HandleWriteConfigsPostHTTP), reqOrgAdmin)
|
|
|
|
liveRoute.Put("/write-configs", routing.Wrap(hs.Live.HandleWriteConfigsPutHTTP), reqOrgAdmin)
|
|
|
|
liveRoute.Delete("/write-configs", routing.Wrap(hs.Live.HandleWriteConfigsDeleteHTTP), reqOrgAdmin)
|
2021-09-09 11:19:29 -05:00
|
|
|
}
|
2021-05-04 10:44:55 -05:00
|
|
|
})
|
2021-03-30 05:23:29 -05:00
|
|
|
|
2020-10-14 05:48:48 -05:00
|
|
|
// short urls
|
2021-11-29 03:18:01 -06:00
|
|
|
apiRoute.Post("/short-urls", routing.Wrap(hs.createShortURL))
|
2015-01-15 05:16:54 -06:00
|
|
|
}, reqSignedIn)
|
|
|
|
|
|
|
|
// admin api
|
2018-06-25 09:36:47 -05:00
|
|
|
r.Group("/api/admin", func(adminRoute routing.RouteRegister) {
|
2021-08-24 04:36:28 -05:00
|
|
|
adminRoute.Get("/settings", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionSettingsRead)), routing.Wrap(hs.AdminGetSettings))
|
2022-01-26 11:44:20 -06:00
|
|
|
if hs.Features.IsEnabled(featuremgmt.FlagShowFeatureFlagsInUI) {
|
|
|
|
adminRoute.Get("/settings/features", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionSettingsRead)), hs.Features.HandleGetSettings)
|
|
|
|
}
|
2022-02-04 10:53:58 -06:00
|
|
|
adminRoute.Get("/stats", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionServerStatsRead)), routing.Wrap(hs.AdminGetStats))
|
2022-02-04 06:41:15 -06:00
|
|
|
adminRoute.Post("/pause-all-alerts", reqGrafanaAdmin, routing.Wrap(hs.PauseAllAlerts))
|
2021-04-22 05:19:41 -05:00
|
|
|
|
2022-01-10 10:21:35 -06:00
|
|
|
if hs.ThumbService != nil {
|
|
|
|
adminRoute.Post("/crawler/start", reqGrafanaAdmin, routing.Wrap(hs.ThumbService.StartCrawler))
|
|
|
|
adminRoute.Post("/crawler/stop", reqGrafanaAdmin, routing.Wrap(hs.ThumbService.StopCrawler))
|
|
|
|
adminRoute.Get("/crawler/status", reqGrafanaAdmin, routing.Wrap(hs.ThumbService.CrawlerStatus))
|
|
|
|
}
|
|
|
|
|
2021-08-24 04:36:28 -05:00
|
|
|
adminRoute.Post("/provisioning/dashboards/reload", authorize(reqGrafanaAdmin, ac.EvalPermission(ActionProvisioningReload, ScopeProvisionersDashboards)), routing.Wrap(hs.AdminProvisioningReloadDashboards))
|
|
|
|
adminRoute.Post("/provisioning/plugins/reload", authorize(reqGrafanaAdmin, ac.EvalPermission(ActionProvisioningReload, ScopeProvisionersPlugins)), routing.Wrap(hs.AdminProvisioningReloadPlugins))
|
|
|
|
adminRoute.Post("/provisioning/datasources/reload", authorize(reqGrafanaAdmin, ac.EvalPermission(ActionProvisioningReload, ScopeProvisionersDatasources)), routing.Wrap(hs.AdminProvisioningReloadDatasources))
|
|
|
|
adminRoute.Post("/provisioning/notifications/reload", authorize(reqGrafanaAdmin, ac.EvalPermission(ActionProvisioningReload, ScopeProvisionersNotifications)), routing.Wrap(hs.AdminProvisioningReloadNotifications))
|
2021-08-04 07:44:37 -05:00
|
|
|
|
2021-08-24 04:36:28 -05:00
|
|
|
adminRoute.Post("/ldap/reload", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionLDAPConfigReload)), routing.Wrap(hs.ReloadLDAPCfg))
|
|
|
|
adminRoute.Post("/ldap/sync/:id", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionLDAPUsersSync)), routing.Wrap(hs.PostSyncUserWithLDAP))
|
|
|
|
adminRoute.Get("/ldap/:username", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionLDAPUsersRead)), routing.Wrap(hs.GetUserFromLDAP))
|
|
|
|
adminRoute.Get("/ldap/status", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionLDAPStatusRead)), routing.Wrap(hs.GetLDAPStatus))
|
2021-04-22 05:19:41 -05:00
|
|
|
})
|
2014-12-15 14:25:02 -06:00
|
|
|
|
2021-04-14 09:31:27 -05:00
|
|
|
// Administering users
|
|
|
|
r.Group("/api/admin/users", func(adminUserRoute routing.RouteRegister) {
|
2021-10-07 04:54:43 -05:00
|
|
|
userIDScope := ac.Scope("global", "users", "id", ac.Parameter(":id"))
|
2021-08-24 04:36:28 -05:00
|
|
|
|
2021-11-29 03:18:01 -06:00
|
|
|
adminUserRoute.Post("/", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersCreate)), routing.Wrap(hs.AdminCreateUser))
|
2022-02-04 12:45:42 -06:00
|
|
|
adminUserRoute.Put("/:id/password", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersPasswordUpdate, userIDScope)), routing.Wrap(hs.AdminUpdateUserPassword))
|
2021-11-29 03:18:01 -06:00
|
|
|
adminUserRoute.Put("/:id/permissions", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersPermissionsUpdate, userIDScope)), routing.Wrap(hs.AdminUpdateUserPermissions))
|
2022-02-04 12:45:42 -06:00
|
|
|
adminUserRoute.Delete("/:id", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersDelete, userIDScope)), routing.Wrap(hs.AdminDeleteUser))
|
2021-08-24 04:36:28 -05:00
|
|
|
adminUserRoute.Post("/:id/disable", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersDisable, userIDScope)), routing.Wrap(hs.AdminDisableUser))
|
2022-02-04 12:45:42 -06:00
|
|
|
adminUserRoute.Post("/:id/enable", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersEnable, userIDScope)), routing.Wrap(hs.AdminEnableUser))
|
2022-02-03 02:20:20 -06:00
|
|
|
adminUserRoute.Get("/:id/quotas", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersQuotasList, userIDScope)), routing.Wrap(hs.GetUserQuotas))
|
|
|
|
adminUserRoute.Put("/:id/quotas/:target", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersQuotasUpdate, userIDScope)), routing.Wrap(hs.UpdateUserQuota))
|
2021-08-24 04:36:28 -05:00
|
|
|
|
|
|
|
adminUserRoute.Post("/:id/logout", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersLogout, userIDScope)), routing.Wrap(hs.AdminLogoutUser))
|
|
|
|
adminUserRoute.Get("/:id/auth-tokens", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersAuthTokenList, userIDScope)), routing.Wrap(hs.AdminGetUserAuthTokens))
|
2021-11-29 03:18:01 -06:00
|
|
|
adminUserRoute.Post("/:id/revoke-auth-token", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersAuthTokenUpdate, userIDScope)), routing.Wrap(hs.AdminRevokeUserAuthToken))
|
2021-04-14 09:31:27 -05:00
|
|
|
})
|
|
|
|
|
2014-12-15 14:25:02 -06:00
|
|
|
// rendering
|
2018-05-24 08:26:27 -05:00
|
|
|
r.Get("/render/*", reqSignedIn, hs.RenderToPng)
|
2015-01-06 02:11:00 -06:00
|
|
|
|
2016-04-08 15:42:33 -05:00
|
|
|
// grafana.net proxy
|
2021-11-12 04:07:12 -06:00
|
|
|
r.Any("/api/gnet/*", reqSignedIn, hs.ProxyGnetRequest)
|
2016-04-08 15:42:33 -05:00
|
|
|
|
2016-02-20 16:51:22 -06:00
|
|
|
// Gravatar service.
|
2021-03-10 05:41:29 -06:00
|
|
|
avatarCacheServer := avatar.NewCacheServer(hs.Cfg)
|
2017-11-17 06:13:58 -06:00
|
|
|
r.Get("/avatar/:hash", avatarCacheServer.Handler)
|
2016-02-20 16:51:22 -06:00
|
|
|
|
2019-09-02 08:15:46 -05:00
|
|
|
// Snapshots
|
2022-02-08 10:57:59 -06:00
|
|
|
r.Post("/api/snapshots/", reqSnapshotPublicModeOrSignedIn, hs.CreateDashboardSnapshot)
|
2019-09-02 08:15:46 -05:00
|
|
|
r.Get("/api/snapshot/shared-options/", reqSignedIn, GetSharingOptions)
|
2022-02-08 10:57:59 -06:00
|
|
|
r.Get("/api/snapshots/:key", routing.Wrap(hs.GetDashboardSnapshot))
|
|
|
|
r.Get("/api/snapshots-delete/:deleteKey", reqSnapshotPublicModeOrSignedIn, routing.Wrap(hs.DeleteDashboardSnapshotByDeleteKey))
|
|
|
|
r.Delete("/api/snapshots/:key", reqEditorRole, routing.Wrap(hs.DeleteDashboardSnapshot))
|
2020-11-12 05:29:43 -06:00
|
|
|
|
|
|
|
// Frontend logs
|
2021-11-01 04:53:33 -05:00
|
|
|
sourceMapStore := frontendlogging.NewSourceMapStore(hs.Cfg, hs.pluginStaticRouteResolver, frontendlogging.ReadSourceMapFromFS)
|
2021-03-18 07:53:01 -05:00
|
|
|
r.Post("/log", middleware.RateLimit(hs.Cfg.Sentry.EndpointRPS, hs.Cfg.Sentry.EndpointBurst, time.Now),
|
2021-11-29 03:18:01 -06:00
|
|
|
routing.Wrap(NewFrontendLogMessageHandler(sourceMapStore)))
|
2014-12-15 14:25:02 -06:00
|
|
|
}
|