api.go 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201
  1. package api
  2. import (
  3. "github.com/Unknwon/macaron"
  4. "github.com/grafana/grafana/pkg/api/dtos"
  5. "github.com/grafana/grafana/pkg/middleware"
  6. m "github.com/grafana/grafana/pkg/models"
  7. "github.com/macaron-contrib/binding"
  8. )
  9. // Register adds http routes
  10. func Register(r *macaron.Macaron) {
  11. reqSignedIn := middleware.Auth(&middleware.AuthOptions{ReqSignedIn: true})
  12. reqGrafanaAdmin := middleware.Auth(&middleware.AuthOptions{ReqSignedIn: true, ReqGrafanaAdmin: true})
  13. reqEditorRole := middleware.RoleAuth(m.ROLE_EDITOR, m.ROLE_ADMIN)
  14. reqOrgAdmin := middleware.RoleAuth(m.ROLE_ADMIN)
  15. quota := middleware.Quota
  16. bind := binding.Bind
  17. // not logged in views
  18. r.Get("/", reqSignedIn, Index)
  19. r.Get("/logout", Logout)
  20. r.Post("/login", quota("session"), bind(dtos.LoginCommand{}), wrap(LoginPost))
  21. r.Get("/login/:name", quota("session"), OAuthLogin)
  22. r.Get("/login", LoginView)
  23. r.Get("/invite/:code", Index)
  24. // authed views
  25. r.Get("/profile/", reqSignedIn, Index)
  26. r.Get("/org/", reqSignedIn, Index)
  27. r.Get("/org/new", reqSignedIn, Index)
  28. r.Get("/datasources/", reqSignedIn, Index)
  29. r.Get("/datasources/edit/*", reqSignedIn, Index)
  30. r.Get("/org/users/", reqSignedIn, Index)
  31. r.Get("/org/apikeys/", reqSignedIn, Index)
  32. r.Get("/dashboard/import/", reqSignedIn, Index)
  33. r.Get("/admin/settings", reqGrafanaAdmin, Index)
  34. r.Get("/admin/users", reqGrafanaAdmin, Index)
  35. r.Get("/admin/users/create", reqGrafanaAdmin, Index)
  36. r.Get("/admin/users/edit/:id", reqGrafanaAdmin, Index)
  37. r.Get("/admin/orgs", reqGrafanaAdmin, Index)
  38. r.Get("/admin/orgs/edit/:id", reqGrafanaAdmin, Index)
  39. r.Get("/org/apps", reqSignedIn, Index)
  40. r.Get("/org/apps/edit/*", reqSignedIn, Index)
  41. r.Get("/dashboard/*", reqSignedIn, Index)
  42. r.Get("/dashboard-solo/*", reqSignedIn, Index)
  43. // sign up
  44. r.Get("/signup", Index)
  45. r.Get("/api/user/signup/options", wrap(GetSignUpOptions))
  46. r.Post("/api/user/signup", quota("user"), bind(dtos.SignUpForm{}), wrap(SignUp))
  47. r.Post("/api/user/signup/step2", bind(dtos.SignUpStep2Form{}), wrap(SignUpStep2))
  48. // invited
  49. r.Get("/api/user/invite/:code", wrap(GetInviteInfoByCode))
  50. r.Post("/api/user/invite/complete", bind(dtos.CompleteInviteForm{}), wrap(CompleteInvite))
  51. // reset password
  52. r.Get("/user/password/send-reset-email", Index)
  53. r.Get("/user/password/reset", Index)
  54. r.Post("/api/user/password/send-reset-email", bind(dtos.SendResetPasswordEmailForm{}), wrap(SendResetPasswordEmail))
  55. r.Post("/api/user/password/reset", bind(dtos.ResetUserPasswordForm{}), wrap(ResetPassword))
  56. // dashboard snapshots
  57. r.Post("/api/snapshots/", bind(m.CreateDashboardSnapshotCommand{}), CreateDashboardSnapshot)
  58. r.Get("/dashboard/snapshot/*", Index)
  59. r.Get("/api/snapshot/shared-options/", GetSharingOptions)
  60. r.Get("/api/snapshots/:key", GetDashboardSnapshot)
  61. r.Get("/api/snapshots-delete/:key", DeleteDashboardSnapshot)
  62. // api renew session based on remember cookie
  63. r.Get("/api/login/ping", quota("session"), LoginApiPing)
  64. // authed api
  65. r.Group("/api", func() {
  66. // user (signed in)
  67. r.Group("/user", func() {
  68. r.Get("/", wrap(GetSignedInUser))
  69. r.Put("/", bind(m.UpdateUserCommand{}), wrap(UpdateSignedInUser))
  70. r.Post("/using/:id", wrap(UserSetUsingOrg))
  71. r.Get("/orgs", wrap(GetSignedInUserOrgList))
  72. r.Post("/stars/dashboard/:id", wrap(StarDashboard))
  73. r.Delete("/stars/dashboard/:id", wrap(UnstarDashboard))
  74. r.Put("/password", bind(m.ChangeUserPasswordCommand{}), wrap(ChangeUserPassword))
  75. r.Get("/quotas", wrap(GetUserQuotas))
  76. })
  77. // users (admin permission required)
  78. r.Group("/users", func() {
  79. r.Get("/", wrap(SearchUsers))
  80. r.Get("/:id", wrap(GetUserById))
  81. r.Get("/:id/orgs", wrap(GetUserOrgList))
  82. r.Put("/:id", bind(m.UpdateUserCommand{}), wrap(UpdateUser))
  83. }, reqGrafanaAdmin)
  84. // org information available to all users.
  85. r.Group("/org", func() {
  86. r.Get("/", wrap(GetOrgCurrent))
  87. r.Get("/quotas", wrap(GetOrgQuotas))
  88. })
  89. // current org
  90. r.Group("/org", func() {
  91. r.Put("/", bind(dtos.UpdateOrgForm{}), wrap(UpdateOrgCurrent))
  92. r.Put("/address", bind(dtos.UpdateOrgAddressForm{}), wrap(UpdateOrgAddressCurrent))
  93. r.Post("/users", quota("user"), bind(m.AddOrgUserCommand{}), wrap(AddOrgUserToCurrentOrg))
  94. r.Get("/users", wrap(GetOrgUsersForCurrentOrg))
  95. r.Patch("/users/:userId", bind(m.UpdateOrgUserCommand{}), wrap(UpdateOrgUserForCurrentOrg))
  96. r.Delete("/users/:userId", wrap(RemoveOrgUserForCurrentOrg))
  97. // invites
  98. r.Get("/invites", wrap(GetPendingOrgInvites))
  99. r.Post("/invites", quota("user"), bind(dtos.AddInviteForm{}), wrap(AddOrgInvite))
  100. r.Patch("/invites/:code/revoke", wrap(RevokeInvite))
  101. // apps
  102. r.Get("/apps", wrap(GetAppPlugins))
  103. r.Post("/apps", bind(m.UpdateAppPluginCmd{}), wrap(UpdateAppPlugin))
  104. }, reqOrgAdmin)
  105. // create new org
  106. r.Post("/orgs", quota("org"), bind(m.CreateOrgCommand{}), wrap(CreateOrg))
  107. // search all orgs
  108. r.Get("/orgs", reqGrafanaAdmin, wrap(SearchOrgs))
  109. // orgs (admin routes)
  110. r.Group("/orgs/:orgId", func() {
  111. r.Get("/", wrap(GetOrgById))
  112. r.Put("/", bind(dtos.UpdateOrgForm{}), wrap(UpdateOrg))
  113. r.Put("/address", bind(dtos.UpdateOrgAddressForm{}), wrap(UpdateOrgAddress))
  114. r.Delete("/", wrap(DeleteOrgById))
  115. r.Get("/users", wrap(GetOrgUsers))
  116. r.Post("/users", bind(m.AddOrgUserCommand{}), wrap(AddOrgUser))
  117. r.Patch("/users/:userId", bind(m.UpdateOrgUserCommand{}), wrap(UpdateOrgUser))
  118. r.Delete("/users/:userId", wrap(RemoveOrgUser))
  119. r.Get("/quotas", wrap(GetOrgQuotas))
  120. r.Put("/quotas/:target", bind(m.UpdateOrgQuotaCmd{}), wrap(UpdateOrgQuota))
  121. }, reqGrafanaAdmin)
  122. // auth api keys
  123. r.Group("/auth/keys", func() {
  124. r.Get("/", wrap(GetApiKeys))
  125. r.Post("/", quota("api_key"), bind(m.AddApiKeyCommand{}), wrap(AddApiKey))
  126. r.Delete("/:id", wrap(DeleteApiKey))
  127. }, reqOrgAdmin)
  128. // Data sources
  129. r.Group("/datasources", func() {
  130. r.Get("/", GetDataSources)
  131. r.Post("/", quota("data_source"), bind(m.AddDataSourceCommand{}), AddDataSource)
  132. r.Put("/:id", bind(m.UpdateDataSourceCommand{}), UpdateDataSource)
  133. r.Delete("/:id", DeleteDataSource)
  134. r.Get("/:id", wrap(GetDataSourceById))
  135. r.Get("/plugins", GetDataSourcePlugins)
  136. }, reqOrgAdmin)
  137. r.Get("/frontend/settings/", GetFrontendSettings)
  138. r.Any("/datasources/proxy/:id/*", reqSignedIn, ProxyDataSourceRequest)
  139. r.Any("/datasources/proxy/:id", reqSignedIn, ProxyDataSourceRequest)
  140. // Dashboard
  141. r.Group("/dashboards", func() {
  142. r.Combo("/db/:slug").Get(GetDashboard).Delete(DeleteDashboard)
  143. r.Post("/db", reqEditorRole, bind(m.SaveDashboardCommand{}), PostDashboard)
  144. r.Get("/file/:file", GetDashboardFromJsonFile)
  145. r.Get("/home", GetHomeDashboard)
  146. r.Get("/tags", GetDashboardTags)
  147. })
  148. // Search
  149. r.Get("/search/", Search)
  150. // metrics
  151. r.Get("/metrics/test", GetTestMetrics)
  152. }, reqSignedIn)
  153. // admin api
  154. r.Group("/api/admin", func() {
  155. r.Get("/settings", AdminGetSettings)
  156. r.Post("/users", bind(dtos.AdminCreateUserForm{}), AdminCreateUser)
  157. r.Put("/users/:id/password", bind(dtos.AdminUpdateUserPasswordForm{}), AdminUpdateUserPassword)
  158. r.Put("/users/:id/permissions", bind(dtos.AdminUpdateUserPermissionsForm{}), AdminUpdateUserPermissions)
  159. r.Delete("/users/:id", AdminDeleteUser)
  160. r.Get("/users/:id/quotas", wrap(GetUserQuotas))
  161. r.Put("/users/:id/quotas/:target", bind(m.UpdateUserQuotaCmd{}), wrap(UpdateUserQuota))
  162. }, reqGrafanaAdmin)
  163. // rendering
  164. r.Get("/render/*", reqSignedIn, RenderToPng)
  165. InitApiPluginRoutes(r)
  166. r.NotFound(NotFoundHandler)
  167. }