mirror of
https://github.com/grafana/grafana.git
synced 2024-11-25 18:30:41 -06:00
2e16d5499e
* add api route for validating a dashboard json * add feature flag for showDashboardValidationWarnings * tidy up * comments and messages * swagger specs * fix typo * more swagger * tests! * tidy test a little bit * no more ioutil * api will return different status code depending on validation error * clean up * handle 4xx errors * remove console.log * fix backend tests * tidy up * Swagger: Exclude alpha endpoints Co-authored-by: Sofia Papagiannaki <1632407+papagian@users.noreply.github.com>
684 lines
45 KiB
Go
684 lines
45 KiB
Go
// Package api Grafana HTTP API.
|
|
//
|
|
// The Grafana backend exposes an HTTP API, the same API is used by the frontend to do
|
|
// everything from saving dashboards, creating users and updating data sources.
|
|
//
|
|
// Schemes: http, https
|
|
// BasePath: /api
|
|
// Version: 0.0.1
|
|
// Contact: Grafana Labs<hello@grafana.com> https://grafana.com
|
|
//
|
|
// Consumes:
|
|
// - application/json
|
|
//
|
|
// Produces:
|
|
// - application/json
|
|
//
|
|
// Security:
|
|
// - basic:
|
|
// - api_key:
|
|
//
|
|
// SecurityDefinitions:
|
|
// basic:
|
|
// type: basic
|
|
// api_key:
|
|
// type: apiKey
|
|
// name: Authorization
|
|
// in: header
|
|
//
|
|
// swagger:meta
|
|
package api
|
|
|
|
import (
|
|
"github.com/grafana/grafana/pkg/api/routing"
|
|
"github.com/grafana/grafana/pkg/infra/log"
|
|
"github.com/grafana/grafana/pkg/middleware"
|
|
"github.com/grafana/grafana/pkg/models"
|
|
"github.com/grafana/grafana/pkg/plugins"
|
|
ac "github.com/grafana/grafana/pkg/services/accesscontrol"
|
|
"github.com/grafana/grafana/pkg/services/correlations"
|
|
"github.com/grafana/grafana/pkg/services/dashboards"
|
|
"github.com/grafana/grafana/pkg/services/datasources"
|
|
"github.com/grafana/grafana/pkg/services/featuremgmt"
|
|
publicdashboardsapi "github.com/grafana/grafana/pkg/services/publicdashboards/api"
|
|
"github.com/grafana/grafana/pkg/services/serviceaccounts"
|
|
"github.com/grafana/grafana/pkg/setting"
|
|
"github.com/grafana/grafana/pkg/web"
|
|
)
|
|
|
|
var plog = log.New("api")
|
|
|
|
// registerRoutes registers all API HTTP routes.
|
|
func (hs *HTTPServer) registerRoutes() {
|
|
reqNoAuth := middleware.NoAuth()
|
|
reqSignedIn := middleware.ReqSignedIn
|
|
reqNotSignedIn := middleware.ReqNotSignedIn
|
|
reqSignedInNoAnonymous := middleware.ReqSignedInNoAnonymous
|
|
reqGrafanaAdmin := middleware.ReqGrafanaAdmin
|
|
reqEditorRole := middleware.ReqEditorRole
|
|
reqOrgAdmin := middleware.ReqOrgAdmin
|
|
reqOrgAdminDashOrFolderAdminOrTeamAdmin := middleware.OrgAdminDashOrFolderAdminOrTeamAdmin(hs.SQLStore, hs.DashboardService, hs.teamService)
|
|
reqCanAccessTeams := middleware.AdminOrEditorAndFeatureEnabled(hs.Cfg.EditorsCanAdmin)
|
|
reqSnapshotPublicModeOrSignedIn := middleware.SnapshotPublicModeOrSignedIn(hs.Cfg)
|
|
redirectFromLegacyPanelEditURL := middleware.RedirectFromLegacyPanelEditURL(hs.Cfg)
|
|
authorize := ac.Middleware(hs.AccessControl)
|
|
authorizeInOrg := ac.AuthorizeInOrgMiddleware(hs.AccessControl, hs.accesscontrolService, hs.userService)
|
|
quota := middleware.Quota(hs.QuotaService)
|
|
|
|
r := hs.RouteRegister
|
|
|
|
// not logged in views
|
|
r.Get("/logout", hs.Logout)
|
|
r.Post("/login", quota("session"), routing.Wrap(hs.LoginPost))
|
|
r.Get("/login/:name", quota("session"), hs.OAuthLogin)
|
|
r.Get("/login", hs.LoginView)
|
|
r.Get("/invite/:code", hs.Index)
|
|
|
|
// authed views
|
|
r.Get("/", reqSignedIn, hs.Index)
|
|
r.Get("/profile/", reqSignedInNoAnonymous, hs.Index)
|
|
r.Get("/profile/password", reqSignedInNoAnonymous, hs.Index)
|
|
r.Get("/.well-known/change-password", redirectToChangePassword)
|
|
r.Get("/profile/switch-org/:id", reqSignedInNoAnonymous, hs.ChangeActiveOrgAndRedirectToHome)
|
|
r.Get("/org/", authorize(reqOrgAdmin, ac.OrgPreferencesAccessEvaluator), hs.Index)
|
|
r.Get("/org/new", authorizeInOrg(reqGrafanaAdmin, ac.UseGlobalOrg, ac.OrgsCreateAccessEvaluator), hs.Index)
|
|
r.Get("/datasources/", authorize(reqOrgAdmin, datasources.ConfigurationPageAccess), hs.Index)
|
|
r.Get("/datasources/new", authorize(reqOrgAdmin, datasources.NewPageAccess), hs.Index)
|
|
r.Get("/datasources/edit/*", authorize(reqOrgAdmin, datasources.EditPageAccess), hs.Index)
|
|
r.Get("/datasources/correlations", authorize(reqOrgAdmin, correlations.ConfigurationPageAccess), hs.Index)
|
|
r.Get("/org/users", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgUsersRead)), hs.Index)
|
|
r.Get("/org/users/new", reqOrgAdmin, hs.Index)
|
|
r.Get("/org/users/invite", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgUsersAdd)), hs.Index)
|
|
r.Get("/org/teams", authorize(reqCanAccessTeams, ac.EvalPermission(ac.ActionTeamsRead)), hs.Index)
|
|
r.Get("/org/teams/edit/*", authorize(reqCanAccessTeams, ac.TeamsEditAccessEvaluator), hs.Index)
|
|
r.Get("/org/teams/new", authorize(reqCanAccessTeams, ac.EvalPermission(ac.ActionTeamsCreate)), hs.Index)
|
|
r.Get("/org/serviceaccounts", authorize(reqOrgAdmin, ac.EvalPermission(serviceaccounts.ActionRead)), hs.Index)
|
|
r.Get("/org/serviceaccounts/:serviceAccountId", authorize(reqOrgAdmin, ac.EvalPermission(serviceaccounts.ActionRead)), hs.Index)
|
|
r.Get("/org/apikeys/", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionAPIKeyRead)), hs.Index)
|
|
r.Get("/dashboard/import/", reqSignedIn, hs.Index)
|
|
r.Get("/configuration", reqGrafanaAdmin, hs.Index)
|
|
r.Get("/admin", reqGrafanaAdmin, hs.Index)
|
|
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)
|
|
r.Get("/admin/orgs", authorizeInOrg(reqGrafanaAdmin, ac.UseGlobalOrg, ac.OrgsAccessEvaluator), hs.Index)
|
|
r.Get("/admin/orgs/edit/:id", authorizeInOrg(reqGrafanaAdmin, ac.UseGlobalOrg, ac.OrgsAccessEvaluator), hs.Index)
|
|
r.Get("/admin/stats", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionServerStatsRead)), hs.Index)
|
|
r.Get("/admin/storage/*", reqGrafanaAdmin, hs.Index)
|
|
r.Get("/admin/ldap", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionLDAPStatusRead)), hs.Index)
|
|
r.Get("/styleguide", reqSignedIn, hs.Index)
|
|
|
|
r.Get("/live", reqGrafanaAdmin, hs.Index)
|
|
r.Get("/live/pipeline", reqGrafanaAdmin, hs.Index)
|
|
r.Get("/live/cloud", reqGrafanaAdmin, hs.Index)
|
|
|
|
r.Get("/plugins", reqSignedIn, hs.Index)
|
|
r.Get("/plugins/:id/", reqSignedIn, hs.Index)
|
|
r.Get("/plugins/:id/edit", reqSignedIn, hs.Index) // deprecated
|
|
r.Get("/plugins/:id/page/:page", reqSignedIn, hs.Index)
|
|
// App Root Page
|
|
appPluginIDScope := plugins.ScopeProvider.GetResourceScope(ac.Parameter(":id"))
|
|
r.Get("/a/:id/*", authorize(reqSignedIn, ac.EvalPermission(plugins.ActionAppAccess, appPluginIDScope)), hs.Index)
|
|
r.Get("/a/:id", authorize(reqSignedIn, ac.EvalPermission(plugins.ActionAppAccess, appPluginIDScope)), hs.Index)
|
|
|
|
r.Get("/d/:uid/:slug", reqSignedIn, redirectFromLegacyPanelEditURL, hs.Index)
|
|
r.Get("/d/:uid", reqSignedIn, redirectFromLegacyPanelEditURL, hs.Index)
|
|
r.Get("/dashboard/script/*", reqSignedIn, hs.Index)
|
|
r.Get("/dashboard/new", reqSignedIn, hs.Index)
|
|
r.Get("/dashboard-solo/snapshot/*", hs.Index)
|
|
r.Get("/d-solo/:uid/:slug", reqSignedIn, hs.Index)
|
|
r.Get("/d-solo/:uid", reqSignedIn, hs.Index)
|
|
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)
|
|
r.Get("/goto/:uid", reqSignedIn, hs.redirectFromShortURL, hs.Index)
|
|
|
|
if hs.Features.IsEnabled(featuremgmt.FlagDashboardsFromStorage) {
|
|
r.Get("/g/*", reqSignedIn, hs.Index)
|
|
}
|
|
|
|
if hs.Features.IsEnabled(featuremgmt.FlagPublicDashboards) {
|
|
// list public dashboards
|
|
r.Get("/public-dashboards/list", reqSignedIn, hs.Index)
|
|
|
|
// anonymous view public dashboard
|
|
r.Get("/public-dashboards/:accessToken",
|
|
publicdashboardsapi.SetPublicDashboardFlag,
|
|
publicdashboardsapi.SetPublicDashboardOrgIdOnContext(hs.PublicDashboardsApi.PublicDashboardService),
|
|
publicdashboardsapi.CountPublicDashboardRequest(),
|
|
hs.Index,
|
|
)
|
|
}
|
|
|
|
r.Get("/explore", authorize(func(c *models.ReqContext) {
|
|
if f, ok := reqSignedIn.(func(c *models.ReqContext)); ok {
|
|
f(c)
|
|
}
|
|
middleware.EnsureEditorOrViewerCanEdit(c)
|
|
}, ac.EvalPermission(ac.ActionDatasourcesExplore)), hs.Index)
|
|
|
|
r.Get("/playlists/", reqSignedIn, hs.Index)
|
|
r.Get("/playlists/*", reqSignedIn, hs.Index)
|
|
r.Get("/alerting/", reqSignedIn, hs.Index)
|
|
r.Get("/alerting/*", reqSignedIn, hs.Index)
|
|
r.Get("/library-panels/", reqSignedIn, hs.Index)
|
|
r.Get("/monitoring/", reqSignedIn, hs.Index)
|
|
r.Get("/monitoring/*", reqSignedIn, hs.Index)
|
|
r.Get("/alerts-and-incidents", reqSignedIn, hs.Index)
|
|
r.Get("/alerts-and-incidents/*", reqSignedIn, hs.Index)
|
|
|
|
// sign up
|
|
r.Get("/verify", hs.Index)
|
|
r.Get("/signup", hs.Index)
|
|
r.Get("/api/user/signup/options", routing.Wrap(GetSignUpOptions))
|
|
r.Post("/api/user/signup", quota("user"), routing.Wrap(hs.SignUp))
|
|
r.Post("/api/user/signup/step2", routing.Wrap(hs.SignUpStep2))
|
|
|
|
// invited
|
|
r.Get("/api/user/invite/:code", routing.Wrap(hs.GetInviteInfoByCode))
|
|
r.Post("/api/user/invite/complete", routing.Wrap(hs.CompleteInvite))
|
|
|
|
// reset password
|
|
r.Get("/user/password/send-reset-email", reqNotSignedIn, hs.Index)
|
|
r.Get("/user/password/reset", hs.Index)
|
|
|
|
r.Post("/api/user/password/send-reset-email", routing.Wrap(hs.SendResetPasswordEmail))
|
|
r.Post("/api/user/password/reset", routing.Wrap(hs.ResetPassword))
|
|
|
|
// dashboard snapshots
|
|
r.Get("/dashboard/snapshot/*", reqNoAuth, hs.Index)
|
|
r.Get("/dashboard/snapshots/", reqSignedIn, hs.Index)
|
|
|
|
// api renew session based on cookie
|
|
r.Get("/api/login/ping", quota("session"), routing.Wrap(hs.LoginAPIPing))
|
|
|
|
// expose plugin file system assets
|
|
r.Get("/public/plugins/:pluginId/*", hs.getPluginAssets)
|
|
|
|
if hs.Features.IsEnabled(featuremgmt.FlagSwaggerUi) {
|
|
r.Get("/swagger-ui", swaggerUI)
|
|
r.Get("/openapi3", openapi3)
|
|
}
|
|
|
|
// authed api
|
|
r.Group("/api", func(apiRoute routing.RouteRegister) {
|
|
// user (signed in)
|
|
apiRoute.Group("/user", func(userRoute routing.RouteRegister) {
|
|
userRoute.Get("/", routing.Wrap(hs.GetSignedInUser))
|
|
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))
|
|
|
|
userRoute.Get("/stars", routing.Wrap(hs.GetStars))
|
|
// Deprecated: use /stars/dashboard/uid/:uid API instead.
|
|
userRoute.Post("/stars/dashboard/:id", routing.Wrap(hs.StarDashboard))
|
|
// Deprecated: use /stars/dashboard/uid/:uid API instead.
|
|
userRoute.Delete("/stars/dashboard/:id", routing.Wrap(hs.UnstarDashboard))
|
|
|
|
userRoute.Post("/stars/dashboard/uid/:uid", routing.Wrap(hs.StarDashboardByUID))
|
|
userRoute.Delete("/stars/dashboard/uid/:uid", routing.Wrap(hs.UnstarDashboardByUID))
|
|
|
|
userRoute.Put("/password", routing.Wrap(hs.ChangeUserPassword))
|
|
userRoute.Get("/quotas", routing.Wrap(hs.GetUserQuotas))
|
|
userRoute.Put("/helpflags/:id", routing.Wrap(hs.SetHelpFlag))
|
|
// For dev purpose
|
|
userRoute.Get("/helpflags/clear", routing.Wrap(hs.ClearHelpFlags))
|
|
|
|
userRoute.Get("/preferences", routing.Wrap(hs.GetUserPreferences))
|
|
userRoute.Put("/preferences", routing.Wrap(hs.UpdateUserPreferences))
|
|
userRoute.Patch("/preferences", routing.Wrap(hs.PatchUserPreferences))
|
|
|
|
userRoute.Get("/auth-tokens", routing.Wrap(hs.GetUserAuthTokens))
|
|
userRoute.Post("/revoke-auth-token", routing.Wrap(hs.RevokeUserAuthToken))
|
|
}, reqSignedInNoAnonymous)
|
|
|
|
apiRoute.Group("/users", func(usersRoute routing.RouteRegister) {
|
|
userIDScope := ac.Scope("global.users", "id", ac.Parameter(":id"))
|
|
usersRoute.Get("/", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersRead)), routing.Wrap(hs.searchUsersService.SearchUsers))
|
|
usersRoute.Get("/search", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersRead)), routing.Wrap(hs.searchUsersService.SearchUsersWithPaging))
|
|
usersRoute.Get("/:id", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersRead, userIDScope)), routing.Wrap(hs.GetUserByID))
|
|
usersRoute.Get("/:id/teams", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersRead, userIDScope)), routing.Wrap(hs.GetUserTeams))
|
|
usersRoute.Get("/:id/orgs", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersRead, userIDScope)), routing.Wrap(hs.GetUserOrgList))
|
|
// query parameters /users/lookup?loginOrEmail=admin@example.com
|
|
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))
|
|
})
|
|
|
|
// team (admin permission required)
|
|
apiRoute.Group("/teams", func(teamsRoute routing.RouteRegister) {
|
|
teamsRoute.Post("/", authorize(reqCanAccessTeams, ac.EvalPermission(ac.ActionTeamsCreate)), routing.Wrap(hs.CreateTeam))
|
|
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))
|
|
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))
|
|
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))
|
|
})
|
|
|
|
// team without requirement of user to be org admin
|
|
apiRoute.Group("/teams", func(teamsRoute routing.RouteRegister) {
|
|
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))
|
|
})
|
|
|
|
// org information available to all users.
|
|
apiRoute.Group("/org", func(orgRoute routing.RouteRegister) {
|
|
orgRoute.Get("/", authorize(reqSignedIn, ac.EvalPermission(ac.ActionOrgsRead)), routing.Wrap(hs.GetCurrentOrg))
|
|
orgRoute.Get("/quotas", authorize(reqSignedIn, ac.EvalPermission(ac.ActionOrgsQuotasRead)), routing.Wrap(hs.GetCurrentOrgQuotas))
|
|
})
|
|
|
|
if hs.Features.IsEnabled(featuremgmt.FlagStorage) {
|
|
// Will eventually be replaced with the 'object' route
|
|
apiRoute.Group("/storage", hs.StorageService.RegisterHTTPRoutes)
|
|
|
|
// Allow HTTP access to the object storage feature (dev only for now)
|
|
if hs.Features.IsEnabled(featuremgmt.FlagGrpcServer) {
|
|
apiRoute.Group("/object", hs.httpObjectStore.RegisterHTTPRoutes)
|
|
}
|
|
}
|
|
|
|
if hs.Features.IsEnabled(featuremgmt.FlagPanelTitleSearch) {
|
|
apiRoute.Group("/search-v2", hs.SearchV2HTTPService.RegisterHTTPRoutes)
|
|
}
|
|
|
|
if hs.QueryLibraryHTTPService != nil && !hs.QueryLibraryHTTPService.IsDisabled() {
|
|
apiRoute.Group("/query-library", hs.QueryLibraryHTTPService.RegisterHTTPRoutes)
|
|
}
|
|
|
|
// current org
|
|
apiRoute.Group("/org", func(orgRoute routing.RouteRegister) {
|
|
userIDScope := ac.Scope("users", "id", ac.Parameter(":userId"))
|
|
orgRoute.Put("/", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgsWrite)), routing.Wrap(hs.UpdateCurrentOrg))
|
|
orgRoute.Put("/address", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgsWrite)), routing.Wrap(hs.UpdateCurrentOrgAddress))
|
|
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))
|
|
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.ActionOrgUsersWrite, userIDScope)), routing.Wrap(hs.UpdateOrgUserForCurrentOrg))
|
|
orgRoute.Delete("/users/:userId", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgUsersRemove, userIDScope)), routing.Wrap(hs.RemoveOrgUserForCurrentOrg))
|
|
|
|
// invites
|
|
orgRoute.Get("/invites", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgUsersAdd)), routing.Wrap(hs.GetPendingOrgInvites))
|
|
orgRoute.Post("/invites", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgUsersAdd)), quota("user"), routing.Wrap(hs.AddOrgInvite))
|
|
orgRoute.Patch("/invites/:code/revoke", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgUsersAdd)), routing.Wrap(hs.RevokeInvite))
|
|
|
|
// prefs
|
|
orgRoute.Get("/preferences", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgsPreferencesRead)), routing.Wrap(hs.GetOrgPreferences))
|
|
orgRoute.Put("/preferences", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgsPreferencesWrite)), routing.Wrap(hs.UpdateOrgPreferences))
|
|
orgRoute.Patch("/preferences", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionOrgsPreferencesWrite)), routing.Wrap(hs.PatchOrgPreferences))
|
|
})
|
|
|
|
// current org without requirement of user to be org admin
|
|
apiRoute.Group("/org", func(orgRoute routing.RouteRegister) {
|
|
lookupEvaluator := func() ac.Evaluator {
|
|
if hs.License.FeatureEnabled("accesscontrol.enforcement") {
|
|
return ac.EvalPermission(ac.ActionOrgUsersRead)
|
|
}
|
|
// For oss we allow users with access to update permissions on either folders, teams or dashboards to perform the lookup
|
|
return ac.EvalAny(
|
|
ac.EvalPermission(ac.ActionOrgUsersRead),
|
|
ac.EvalPermission(ac.ActionTeamsPermissionsWrite),
|
|
ac.EvalPermission(dashboards.ActionFoldersPermissionsWrite),
|
|
ac.EvalPermission(dashboards.ActionDashboardsPermissionsWrite),
|
|
)
|
|
}
|
|
orgRoute.Get("/users/lookup", authorize(reqOrgAdminDashOrFolderAdminOrTeamAdmin, lookupEvaluator()), routing.Wrap(hs.GetOrgUsersForCurrentOrgLookup))
|
|
})
|
|
|
|
// create new org
|
|
apiRoute.Post("/orgs", authorizeInOrg(reqSignedIn, ac.UseGlobalOrg, ac.EvalPermission(ac.ActionOrgsCreate)), quota("org"), routing.Wrap(hs.CreateOrg))
|
|
|
|
// search all orgs
|
|
apiRoute.Get("/orgs", authorizeInOrg(reqGrafanaAdmin, ac.UseGlobalOrg, ac.EvalPermission(ac.ActionOrgsRead)), routing.Wrap(hs.SearchOrgs))
|
|
|
|
// orgs (admin routes)
|
|
apiRoute.Group("/orgs/:orgId", func(orgsRoute routing.RouteRegister) {
|
|
userIDScope := ac.Scope("users", "id", ac.Parameter(":userId"))
|
|
orgsRoute.Get("/", authorizeInOrg(reqGrafanaAdmin, ac.UseOrgFromContextParams, ac.EvalPermission(ac.ActionOrgsRead)), routing.Wrap(hs.GetOrgByID))
|
|
orgsRoute.Put("/", authorizeInOrg(reqGrafanaAdmin, ac.UseOrgFromContextParams, ac.EvalPermission(ac.ActionOrgsWrite)), routing.Wrap(hs.UpdateOrg))
|
|
orgsRoute.Put("/address", authorizeInOrg(reqGrafanaAdmin, ac.UseOrgFromContextParams, ac.EvalPermission(ac.ActionOrgsWrite)), routing.Wrap(hs.UpdateOrgAddress))
|
|
orgsRoute.Delete("/", authorizeInOrg(reqGrafanaAdmin, ac.UseOrgFromContextParams, ac.EvalPermission(ac.ActionOrgsDelete)), routing.Wrap(hs.DeleteOrgByID))
|
|
orgsRoute.Get("/users", authorizeInOrg(reqGrafanaAdmin, ac.UseOrgFromContextParams, ac.EvalPermission(ac.ActionOrgUsersRead)), routing.Wrap(hs.GetOrgUsers))
|
|
orgsRoute.Post("/users", authorizeInOrg(reqGrafanaAdmin, ac.UseOrgFromContextParams, ac.EvalPermission(ac.ActionOrgUsersAdd, ac.ScopeUsersAll)), routing.Wrap(hs.AddOrgUser))
|
|
orgsRoute.Patch("/users/:userId", authorizeInOrg(reqGrafanaAdmin, ac.UseOrgFromContextParams, ac.EvalPermission(ac.ActionOrgUsersWrite, userIDScope)), routing.Wrap(hs.UpdateOrgUser))
|
|
orgsRoute.Delete("/users/:userId", authorizeInOrg(reqGrafanaAdmin, ac.UseOrgFromContextParams, ac.EvalPermission(ac.ActionOrgUsersRemove, userIDScope)), routing.Wrap(hs.RemoveOrgUser))
|
|
orgsRoute.Get("/quotas", authorizeInOrg(reqGrafanaAdmin, ac.UseOrgFromContextParams, ac.EvalPermission(ac.ActionOrgsQuotasRead)), routing.Wrap(hs.GetOrgQuotas))
|
|
orgsRoute.Put("/quotas/:target", authorizeInOrg(reqGrafanaAdmin, ac.UseOrgFromContextParams, ac.EvalPermission(ac.ActionOrgsQuotasWrite)), routing.Wrap(hs.UpdateOrgQuota))
|
|
})
|
|
|
|
// orgs (admin routes)
|
|
apiRoute.Get("/orgs/name/:name/", authorizeInOrg(reqGrafanaAdmin, ac.UseGlobalOrg, ac.EvalPermission(ac.ActionOrgsRead)), routing.Wrap(hs.GetOrgByName))
|
|
|
|
// auth api keys
|
|
apiRoute.Group("/auth/keys", func(keysRoute routing.RouteRegister) {
|
|
apikeyIDScope := ac.Scope("apikeys", "id", ac.Parameter(":id"))
|
|
keysRoute.Get("/", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionAPIKeyRead)), routing.Wrap(hs.GetAPIKeys))
|
|
keysRoute.Post("/", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionAPIKeyCreate)), quota("api_key"), routing.Wrap(hs.AddAPIKey))
|
|
keysRoute.Delete("/:id", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionAPIKeyDelete, apikeyIDScope)), routing.Wrap(hs.DeleteAPIKey))
|
|
})
|
|
|
|
// Preferences
|
|
apiRoute.Group("/preferences", func(prefRoute routing.RouteRegister) {
|
|
prefRoute.Post("/set-home-dash", routing.Wrap(hs.SetHomeDashboard))
|
|
})
|
|
|
|
// Data sources
|
|
apiRoute.Group("/datasources", func(datasourceRoute routing.RouteRegister) {
|
|
idScope := datasources.ScopeProvider.GetResourceScope(ac.Parameter(":id"))
|
|
uidScope := datasources.ScopeProvider.GetResourceScopeUID(ac.Parameter(":uid"))
|
|
nameScope := datasources.ScopeProvider.GetResourceScopeName(ac.Parameter(":name"))
|
|
datasourceRoute.Get("/", authorize(reqOrgAdmin, ac.EvalPermission(datasources.ActionRead)), routing.Wrap(hs.GetDataSources))
|
|
datasourceRoute.Post("/", authorize(reqOrgAdmin, ac.EvalPermission(datasources.ActionCreate)), quota("data_source"), routing.Wrap(hs.AddDataSource))
|
|
datasourceRoute.Put("/:id", authorize(reqOrgAdmin, ac.EvalPermission(datasources.ActionWrite, idScope)), routing.Wrap(hs.UpdateDataSourceByID))
|
|
datasourceRoute.Put("/uid/:uid", authorize(reqOrgAdmin, ac.EvalPermission(datasources.ActionWrite, uidScope)), routing.Wrap(hs.UpdateDataSourceByUID))
|
|
datasourceRoute.Delete("/:id", authorize(reqOrgAdmin, ac.EvalPermission(datasources.ActionDelete, idScope)), routing.Wrap(hs.DeleteDataSourceById))
|
|
datasourceRoute.Delete("/uid/:uid", authorize(reqOrgAdmin, ac.EvalPermission(datasources.ActionDelete, uidScope)), routing.Wrap(hs.DeleteDataSourceByUID))
|
|
datasourceRoute.Delete("/name/:name", authorize(reqOrgAdmin, ac.EvalPermission(datasources.ActionDelete, nameScope)), routing.Wrap(hs.DeleteDataSourceByName))
|
|
datasourceRoute.Get("/:id", authorize(reqOrgAdmin, ac.EvalPermission(datasources.ActionRead, idScope)), routing.Wrap(hs.GetDataSourceById))
|
|
datasourceRoute.Get("/uid/:uid", authorize(reqOrgAdmin, ac.EvalPermission(datasources.ActionRead, uidScope)), routing.Wrap(hs.GetDataSourceByUID))
|
|
datasourceRoute.Get("/name/:name", authorize(reqOrgAdmin, ac.EvalPermission(datasources.ActionRead, nameScope)), routing.Wrap(hs.GetDataSourceByName))
|
|
datasourceRoute.Get("/id/:name", authorize(reqSignedIn, ac.EvalPermission(datasources.ActionIDRead, nameScope)), routing.Wrap(hs.GetDataSourceIdByName))
|
|
})
|
|
|
|
pluginIDScope := plugins.ScopeProvider.GetResourceScope(ac.Parameter(":pluginId"))
|
|
apiRoute.Get("/plugins", routing.Wrap(hs.GetPluginList))
|
|
apiRoute.Get("/plugins/:pluginId/settings", routing.Wrap(hs.GetPluginSettingByID)) // RBAC check performed in handler for App Plugins
|
|
apiRoute.Get("/plugins/:pluginId/markdown/:name", routing.Wrap(hs.GetPluginMarkdown))
|
|
apiRoute.Get("/plugins/:pluginId/health", routing.Wrap(hs.CheckHealth))
|
|
apiRoute.Any("/plugins/:pluginId/resources", authorize(reqSignedIn, ac.EvalPermission(plugins.ActionAppAccess, pluginIDScope)), hs.CallResource)
|
|
apiRoute.Any("/plugins/:pluginId/resources/*", authorize(reqSignedIn, ac.EvalPermission(plugins.ActionAppAccess, pluginIDScope)), hs.CallResource)
|
|
apiRoute.Get("/plugins/errors", routing.Wrap(hs.GetPluginErrorsList))
|
|
apiRoute.Any("/plugin-proxy/:pluginId/*", authorize(reqSignedIn, ac.EvalPermission(plugins.ActionAppAccess, pluginIDScope)), hs.ProxyPluginRequest)
|
|
apiRoute.Any("/plugin-proxy/:pluginId", authorize(reqSignedIn, ac.EvalPermission(plugins.ActionAppAccess, pluginIDScope)), hs.ProxyPluginRequest)
|
|
|
|
if hs.Cfg.PluginAdminEnabled && !hs.Cfg.PluginAdminExternalManageEnabled {
|
|
apiRoute.Group("/plugins", func(pluginRoute routing.RouteRegister) {
|
|
pluginRoute.Post("/:pluginId/install", authorize(reqGrafanaAdmin, ac.EvalPermission(plugins.ActionInstall)), routing.Wrap(hs.InstallPlugin))
|
|
pluginRoute.Post("/:pluginId/uninstall", authorize(reqGrafanaAdmin, ac.EvalPermission(plugins.ActionInstall)), routing.Wrap(hs.UninstallPlugin))
|
|
})
|
|
}
|
|
|
|
apiRoute.Group("/plugins", func(pluginRoute routing.RouteRegister) {
|
|
pluginRoute.Get("/:pluginId/dashboards/", reqOrgAdmin, routing.Wrap(hs.GetPluginDashboards))
|
|
pluginRoute.Post("/:pluginId/settings", authorize(reqOrgAdmin, ac.EvalPermission(plugins.ActionWrite, pluginIDScope)), routing.Wrap(hs.UpdatePluginSetting))
|
|
pluginRoute.Get("/:pluginId/metrics", reqOrgAdmin, routing.Wrap(hs.CollectPluginMetrics))
|
|
})
|
|
|
|
apiRoute.Get("/frontend/settings/", hs.GetFrontendSettings)
|
|
apiRoute.Any("/datasources/proxy/:id/*", authorize(reqSignedIn, ac.EvalPermission(datasources.ActionQuery)), hs.ProxyDataSourceRequest)
|
|
apiRoute.Any("/datasources/proxy/uid/:uid/*", authorize(reqSignedIn, ac.EvalPermission(datasources.ActionQuery)), hs.ProxyDataSourceRequestWithUID)
|
|
apiRoute.Any("/datasources/proxy/:id", authorize(reqSignedIn, ac.EvalPermission(datasources.ActionQuery)), hs.ProxyDataSourceRequest)
|
|
apiRoute.Any("/datasources/proxy/uid/:uid", authorize(reqSignedIn, ac.EvalPermission(datasources.ActionQuery)), hs.ProxyDataSourceRequestWithUID)
|
|
// Deprecated: use /datasources/uid/:uid/resources API instead.
|
|
apiRoute.Any("/datasources/:id/resources", authorize(reqSignedIn, ac.EvalPermission(datasources.ActionQuery)), hs.CallDatasourceResource)
|
|
apiRoute.Any("/datasources/uid/:uid/resources", authorize(reqSignedIn, ac.EvalPermission(datasources.ActionQuery)), hs.CallDatasourceResourceWithUID)
|
|
// Deprecated: use /datasources/uid/:uid/resources/* API instead.
|
|
apiRoute.Any("/datasources/:id/resources/*", authorize(reqSignedIn, ac.EvalPermission(datasources.ActionQuery)), hs.CallDatasourceResource)
|
|
apiRoute.Any("/datasources/uid/:uid/resources/*", authorize(reqSignedIn, ac.EvalPermission(datasources.ActionQuery)), hs.CallDatasourceResourceWithUID)
|
|
// Deprecated: use /datasources/uid/:uid/health API instead.
|
|
apiRoute.Any("/datasources/:id/health", authorize(reqSignedIn, ac.EvalPermission(datasources.ActionQuery)), routing.Wrap(hs.CheckDatasourceHealth))
|
|
apiRoute.Any("/datasources/uid/:uid/health", authorize(reqSignedIn, ac.EvalPermission(datasources.ActionQuery)), routing.Wrap(hs.CheckDatasourceHealthWithUID))
|
|
|
|
// Folders
|
|
apiRoute.Group("/folders", func(folderRoute routing.RouteRegister) {
|
|
idScope := dashboards.ScopeFoldersProvider.GetResourceScope(ac.Parameter(":id"))
|
|
uidScope := dashboards.ScopeFoldersProvider.GetResourceScopeUID(ac.Parameter(":uid"))
|
|
folderRoute.Get("/", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionFoldersRead)), routing.Wrap(hs.GetFolders))
|
|
folderRoute.Get("/id/:id", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionFoldersRead, idScope)), routing.Wrap(hs.GetFolderByID))
|
|
folderRoute.Post("/", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionFoldersCreate)), routing.Wrap(hs.CreateFolder))
|
|
|
|
folderRoute.Group("/:uid", func(folderUidRoute routing.RouteRegister) {
|
|
folderUidRoute.Get("/", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionFoldersRead, uidScope)), routing.Wrap(hs.GetFolderByUID))
|
|
folderUidRoute.Put("/", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionFoldersWrite, uidScope)), routing.Wrap(hs.UpdateFolder))
|
|
folderUidRoute.Delete("/", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionFoldersDelete, uidScope)), routing.Wrap(hs.DeleteFolder))
|
|
|
|
folderUidRoute.Group("/permissions", func(folderPermissionRoute routing.RouteRegister) {
|
|
folderPermissionRoute.Get("/", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionFoldersPermissionsRead, uidScope)), routing.Wrap(hs.GetFolderPermissionList))
|
|
folderPermissionRoute.Post("/", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionFoldersPermissionsWrite, uidScope)), routing.Wrap(hs.UpdateFolderPermissions))
|
|
})
|
|
})
|
|
})
|
|
|
|
// Dashboard
|
|
apiRoute.Group("/dashboards", func(dashboardRoute routing.RouteRegister) {
|
|
dashboardRoute.Get("/uid/:uid", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsRead)), routing.Wrap(hs.GetDashboard))
|
|
dashboardRoute.Delete("/uid/:uid", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsDelete)), routing.Wrap(hs.DeleteDashboardByUID))
|
|
dashboardRoute.Group("/uid/:uid", func(dashUidRoute routing.RouteRegister) {
|
|
dashUidRoute.Get("/versions", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsWrite)), routing.Wrap(hs.GetDashboardVersions))
|
|
dashUidRoute.Post("/restore", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsWrite)), routing.Wrap(hs.RestoreDashboardVersion))
|
|
dashUidRoute.Get("/versions/:id", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsWrite)), routing.Wrap(hs.GetDashboardVersion))
|
|
dashUidRoute.Group("/permissions", func(dashboardPermissionRoute routing.RouteRegister) {
|
|
dashboardPermissionRoute.Get("/", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsPermissionsRead)), routing.Wrap(hs.GetDashboardPermissionList))
|
|
dashboardPermissionRoute.Post("/", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsPermissionsWrite)), routing.Wrap(hs.UpdateDashboardPermissions))
|
|
})
|
|
})
|
|
|
|
dashboardRoute.Group("/uid/:uid", func(dashUidRoute routing.RouteRegister) {
|
|
if hs.ThumbService != nil {
|
|
dashUidRoute.Get("/img/:kind/:theme", hs.ThumbService.GetImage)
|
|
if hs.Features.IsEnabled(featuremgmt.FlagDashboardPreviewsAdmin) {
|
|
dashUidRoute.Post("/img/:kind/:theme", reqGrafanaAdmin, hs.ThumbService.SetImage)
|
|
dashUidRoute.Put("/img/:kind/:theme", reqGrafanaAdmin, hs.ThumbService.UpdateThumbnailState)
|
|
}
|
|
}
|
|
})
|
|
|
|
dashboardRoute.Post("/calculate-diff", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsWrite)), routing.Wrap(hs.CalculateDashboardDiff))
|
|
dashboardRoute.Post("/validate", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsWrite)), routing.Wrap(hs.ValidateDashboard))
|
|
dashboardRoute.Post("/trim", routing.Wrap(hs.TrimDashboard))
|
|
|
|
dashboardRoute.Post("/db", authorize(reqSignedIn, ac.EvalAny(ac.EvalPermission(dashboards.ActionDashboardsCreate), ac.EvalPermission(dashboards.ActionDashboardsWrite))), routing.Wrap(hs.PostDashboard))
|
|
dashboardRoute.Get("/home", routing.Wrap(hs.GetHomeDashboard))
|
|
dashboardRoute.Get("/tags", hs.GetDashboardTags)
|
|
|
|
// Deprecated: used to convert internal IDs to UIDs
|
|
dashboardRoute.Get("/ids/:ids", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsRead)), hs.GetDashboardUIDs)
|
|
|
|
// Deprecated: use /uid/:uid API instead.
|
|
dashboardRoute.Group("/id/:dashboardId", func(dashIdRoute routing.RouteRegister) {
|
|
dashIdRoute.Get("/versions", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsWrite)), routing.Wrap(hs.GetDashboardVersions))
|
|
dashIdRoute.Get("/versions/:id", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsWrite)), routing.Wrap(hs.GetDashboardVersion))
|
|
dashIdRoute.Post("/restore", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsWrite)), routing.Wrap(hs.RestoreDashboardVersion))
|
|
|
|
dashIdRoute.Group("/permissions", func(dashboardPermissionRoute routing.RouteRegister) {
|
|
dashboardPermissionRoute.Get("/", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsPermissionsRead)), routing.Wrap(hs.GetDashboardPermissionList))
|
|
dashboardPermissionRoute.Post("/", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsPermissionsWrite)), routing.Wrap(hs.UpdateDashboardPermissions))
|
|
})
|
|
})
|
|
})
|
|
|
|
// Dashboard snapshots
|
|
apiRoute.Group("/dashboard/snapshots", func(dashboardRoute routing.RouteRegister) {
|
|
dashboardRoute.Get("/", routing.Wrap(hs.SearchDashboardSnapshots))
|
|
})
|
|
|
|
// Playlist
|
|
apiRoute.Group("/playlists", func(playlistRoute routing.RouteRegister) {
|
|
playlistRoute.Get("/", routing.Wrap(hs.SearchPlaylists))
|
|
playlistRoute.Get("/:uid", hs.ValidateOrgPlaylist, routing.Wrap(hs.GetPlaylist))
|
|
playlistRoute.Get("/:uid/items", hs.ValidateOrgPlaylist, routing.Wrap(hs.GetPlaylistItems))
|
|
playlistRoute.Get("/:uid/dashboards", hs.ValidateOrgPlaylist, routing.Wrap(hs.GetPlaylistDashboards))
|
|
playlistRoute.Delete("/:uid", reqEditorRole, hs.ValidateOrgPlaylist, routing.Wrap(hs.DeletePlaylist))
|
|
playlistRoute.Put("/:uid", reqEditorRole, hs.ValidateOrgPlaylist, routing.Wrap(hs.UpdatePlaylist))
|
|
playlistRoute.Post("/", reqEditorRole, routing.Wrap(hs.CreatePlaylist))
|
|
})
|
|
|
|
// Search
|
|
apiRoute.Get("/search/sorting", routing.Wrap(hs.ListSortOptions))
|
|
apiRoute.Get("/search/", routing.Wrap(hs.Search))
|
|
|
|
// metrics
|
|
// DataSource w/ expressions
|
|
apiRoute.Post("/ds/query", authorize(reqSignedIn, ac.EvalPermission(datasources.ActionQuery)), routing.Wrap(hs.QueryMetricsV2))
|
|
|
|
apiRoute.Group("/alerts", func(alertsRoute routing.RouteRegister) {
|
|
alertsRoute.Post("/test", routing.Wrap(hs.AlertTest))
|
|
alertsRoute.Post("/:alertId/pause", reqEditorRole, routing.Wrap(hs.PauseAlert(setting.AlertingEnabled)))
|
|
alertsRoute.Get("/:alertId", hs.ValidateOrgAlert, routing.Wrap(hs.GetAlert))
|
|
alertsRoute.Get("/", routing.Wrap(hs.GetAlerts))
|
|
alertsRoute.Get("/states-for-dashboard", routing.Wrap(hs.GetAlertStatesForDashboard))
|
|
})
|
|
|
|
var notifiersAuthHandler web.Handler
|
|
if hs.Cfg.UnifiedAlerting.IsEnabled() {
|
|
notifiersAuthHandler = reqSignedIn
|
|
} else {
|
|
notifiersAuthHandler = reqEditorRole
|
|
}
|
|
|
|
apiRoute.Get("/alert-notifiers", notifiersAuthHandler, routing.Wrap(
|
|
hs.GetAlertNotifiers(hs.Cfg.UnifiedAlerting.IsEnabled())),
|
|
)
|
|
|
|
apiRoute.Group("/alert-notifications", func(alertNotifications routing.RouteRegister) {
|
|
alertNotifications.Get("/", routing.Wrap(hs.GetAlertNotifications))
|
|
alertNotifications.Post("/test", routing.Wrap(hs.NotificationTest))
|
|
alertNotifications.Post("/", routing.Wrap(hs.CreateAlertNotification))
|
|
alertNotifications.Put("/:notificationId", routing.Wrap(hs.UpdateAlertNotification))
|
|
alertNotifications.Get("/:notificationId", routing.Wrap(hs.GetAlertNotificationByID))
|
|
alertNotifications.Delete("/:notificationId", routing.Wrap(hs.DeleteAlertNotification))
|
|
alertNotifications.Get("/uid/:uid", routing.Wrap(hs.GetAlertNotificationByUID))
|
|
alertNotifications.Put("/uid/:uid", routing.Wrap(hs.UpdateAlertNotificationByUID))
|
|
alertNotifications.Delete("/uid/:uid", routing.Wrap(hs.DeleteAlertNotificationByUID))
|
|
}, reqEditorRole)
|
|
|
|
// alert notifications without requirement of user to be org editor
|
|
apiRoute.Group("/alert-notifications", func(orgRoute routing.RouteRegister) {
|
|
orgRoute.Get("/lookup", routing.Wrap(hs.GetAlertNotificationLookup))
|
|
})
|
|
|
|
apiRoute.Get("/annotations", authorize(reqSignedIn, ac.EvalPermission(ac.ActionAnnotationsRead)), routing.Wrap(hs.GetAnnotations))
|
|
apiRoute.Post("/annotations/mass-delete", authorize(reqOrgAdmin, ac.EvalPermission(ac.ActionAnnotationsDelete)), routing.Wrap(hs.MassDeleteAnnotations))
|
|
|
|
apiRoute.Group("/annotations", func(annotationsRoute routing.RouteRegister) {
|
|
annotationsRoute.Post("/", authorize(reqSignedIn, ac.EvalPermission(ac.ActionAnnotationsCreate)), routing.Wrap(hs.PostAnnotation))
|
|
annotationsRoute.Get("/:annotationId", authorize(reqSignedIn, ac.EvalPermission(ac.ActionAnnotationsRead, ac.ScopeAnnotationsID)), routing.Wrap(hs.GetAnnotationByID))
|
|
annotationsRoute.Delete("/:annotationId", authorize(reqSignedIn, ac.EvalPermission(ac.ActionAnnotationsDelete, ac.ScopeAnnotationsID)), routing.Wrap(hs.DeleteAnnotationByID))
|
|
annotationsRoute.Put("/:annotationId", authorize(reqSignedIn, ac.EvalPermission(ac.ActionAnnotationsWrite, ac.ScopeAnnotationsID)), routing.Wrap(hs.UpdateAnnotation))
|
|
annotationsRoute.Patch("/:annotationId", authorize(reqSignedIn, ac.EvalPermission(ac.ActionAnnotationsWrite, ac.ScopeAnnotationsID)), routing.Wrap(hs.PatchAnnotation))
|
|
annotationsRoute.Post("/graphite", authorize(reqEditorRole, ac.EvalPermission(ac.ActionAnnotationsCreate, ac.ScopeAnnotationsTypeOrganization)), routing.Wrap(hs.PostGraphiteAnnotation))
|
|
annotationsRoute.Get("/tags", authorize(reqSignedIn, ac.EvalPermission(ac.ActionAnnotationsRead)), routing.Wrap(hs.GetAnnotationTags))
|
|
})
|
|
|
|
apiRoute.Post("/frontend-metrics", routing.Wrap(hs.PostFrontendMetrics))
|
|
|
|
apiRoute.Group("/live", func(liveRoute routing.RouteRegister) {
|
|
// the channel path is in the name
|
|
liveRoute.Post("/publish", routing.Wrap(hs.Live.HandleHTTPPublish))
|
|
|
|
// POST influx line protocol.
|
|
liveRoute.Post("/push/:streamId", hs.LivePushGateway.Handle)
|
|
|
|
// List available streams and fields
|
|
liveRoute.Get("/list", routing.Wrap(hs.Live.HandleListHTTP))
|
|
|
|
// Some channels may have info
|
|
liveRoute.Get("/info/*", routing.Wrap(hs.Live.HandleInfoHTTP))
|
|
|
|
if hs.Features.IsEnabled(featuremgmt.FlagLivePipeline) {
|
|
// POST Live data to be processed according to channel rules.
|
|
liveRoute.Post("/pipeline/push/*", hs.LivePushGateway.HandlePipelinePush)
|
|
liveRoute.Post("/pipeline-convert-test", routing.Wrap(hs.Live.HandlePipelineConvertTestHTTP), reqOrgAdmin)
|
|
liveRoute.Get("/pipeline-entities", routing.Wrap(hs.Live.HandlePipelineEntitiesListHTTP), reqOrgAdmin)
|
|
liveRoute.Get("/channel-rules", routing.Wrap(hs.Live.HandleChannelRulesListHTTP), reqOrgAdmin)
|
|
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)
|
|
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)
|
|
}
|
|
})
|
|
|
|
// short urls
|
|
apiRoute.Post("/short-urls", routing.Wrap(hs.createShortURL))
|
|
|
|
apiRoute.Group("/comments", func(commentRoute routing.RouteRegister) {
|
|
commentRoute.Post("/get", routing.Wrap(hs.commentsGet))
|
|
commentRoute.Post("/create", routing.Wrap(hs.commentsCreate))
|
|
})
|
|
}, reqSignedIn)
|
|
|
|
// admin api
|
|
r.Group("/api/admin", func(adminRoute routing.RouteRegister) {
|
|
adminRoute.Get("/settings", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionSettingsRead)), routing.Wrap(hs.AdminGetSettings))
|
|
if hs.Features.IsEnabled(featuremgmt.FlagShowFeatureFlagsInUI) {
|
|
adminRoute.Get("/settings/features", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionSettingsRead)), hs.Features.HandleGetSettings)
|
|
}
|
|
adminRoute.Get("/stats", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionServerStatsRead)), routing.Wrap(hs.AdminGetStats))
|
|
adminRoute.Post("/pause-all-alerts", reqGrafanaAdmin, routing.Wrap(hs.PauseAllAlerts(setting.AlertingEnabled)))
|
|
|
|
if hs.ThumbService != nil && hs.Features.IsEnabled(featuremgmt.FlagDashboardPreviewsAdmin) {
|
|
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))
|
|
}
|
|
|
|
if hs.Features.IsEnabled(featuremgmt.FlagExport) {
|
|
adminRoute.Get("/export", reqGrafanaAdmin, routing.Wrap(hs.ExportService.HandleGetStatus))
|
|
adminRoute.Post("/export", reqGrafanaAdmin, routing.Wrap(hs.ExportService.HandleRequestExport))
|
|
adminRoute.Post("/export/stop", reqGrafanaAdmin, routing.Wrap(hs.ExportService.HandleRequestStop))
|
|
adminRoute.Get("/export/options", reqGrafanaAdmin, routing.Wrap(hs.ExportService.HandleGetOptions))
|
|
}
|
|
|
|
adminRoute.Post("/encryption/rotate-data-keys", reqGrafanaAdmin, routing.Wrap(hs.AdminRotateDataEncryptionKeys))
|
|
adminRoute.Post("/encryption/reencrypt-data-keys", reqGrafanaAdmin, routing.Wrap(hs.AdminReEncryptEncryptionKeys))
|
|
adminRoute.Post("/encryption/reencrypt-secrets", reqGrafanaAdmin, routing.Wrap(hs.AdminReEncryptSecrets))
|
|
adminRoute.Post("/encryption/rollback-secrets", reqGrafanaAdmin, routing.Wrap(hs.AdminRollbackSecrets))
|
|
adminRoute.Post("/encryption/migrate-secrets/to-plugin", reqGrafanaAdmin, routing.Wrap(hs.AdminMigrateSecretsToPlugin))
|
|
adminRoute.Post("/encryption/migrate-secrets/from-plugin", reqGrafanaAdmin, routing.Wrap(hs.AdminMigrateSecretsFromPlugin))
|
|
adminRoute.Post("/encryption/delete-secretsmanagerplugin-secrets", reqGrafanaAdmin, routing.Wrap(hs.AdminDeleteAllSecretsManagerPluginSecrets))
|
|
|
|
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))
|
|
adminRoute.Post("/provisioning/alerting/reload", authorize(reqGrafanaAdmin, ac.EvalPermission(ActionProvisioningReload, ScopeProvisionersAlertRules)), routing.Wrap(hs.AdminProvisioningReloadAlerting))
|
|
|
|
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))
|
|
})
|
|
|
|
// Administering users
|
|
r.Group("/api/admin/users", func(adminUserRoute routing.RouteRegister) {
|
|
userIDScope := ac.Scope("global.users", "id", ac.Parameter(":id"))
|
|
|
|
adminUserRoute.Post("/", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersCreate)), routing.Wrap(hs.AdminCreateUser))
|
|
adminUserRoute.Put("/:id/password", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersPasswordUpdate, userIDScope)), routing.Wrap(hs.AdminUpdateUserPassword))
|
|
adminUserRoute.Put("/:id/permissions", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersPermissionsUpdate, userIDScope)), routing.Wrap(hs.AdminUpdateUserPermissions))
|
|
adminUserRoute.Delete("/:id", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersDelete, userIDScope)), routing.Wrap(hs.AdminDeleteUser))
|
|
adminUserRoute.Post("/:id/disable", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersDisable, userIDScope)), routing.Wrap(hs.AdminDisableUser))
|
|
adminUserRoute.Post("/:id/enable", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersEnable, userIDScope)), routing.Wrap(hs.AdminEnableUser))
|
|
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))
|
|
|
|
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))
|
|
adminUserRoute.Post("/:id/revoke-auth-token", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionUsersAuthTokenUpdate, userIDScope)), routing.Wrap(hs.AdminRevokeUserAuthToken))
|
|
})
|
|
|
|
// rendering
|
|
r.Get("/render/*", reqSignedIn, hs.RenderToPng)
|
|
|
|
// grafana.net proxy
|
|
r.Any("/api/gnet/*", reqSignedIn, hs.ProxyGnetRequest)
|
|
|
|
// Gravatar service
|
|
r.Get("/avatar/:hash", hs.AvatarCacheServer.Handler)
|
|
|
|
// Snapshots
|
|
r.Post("/api/snapshots/", reqSnapshotPublicModeOrSignedIn, hs.CreateDashboardSnapshot)
|
|
r.Get("/api/snapshot/shared-options/", reqSignedIn, GetSharingOptions)
|
|
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))
|
|
}
|