api.go 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  1. package api
  2. import (
  3. "github.com/go-macaron/binding"
  4. "github.com/grafana/grafana/pkg/api/dtos"
  5. "github.com/grafana/grafana/pkg/middleware"
  6. m "github.com/grafana/grafana/pkg/models"
  7. "gopkg.in/macaron.v1"
  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("/admin/stats", reqGrafanaAdmin, Index)
  40. r.Get("/apps", reqSignedIn, Index)
  41. r.Get("/apps/edit/*", reqSignedIn, Index)
  42. r.Get("/dashboard/*", reqSignedIn, Index)
  43. r.Get("/dashboard-solo/*", reqSignedIn, Index)
  44. r.Get("/playlists/", reqSignedIn, Index)
  45. r.Get("/playlists/*", reqSignedIn, Index)
  46. // sign up
  47. r.Get("/signup", Index)
  48. r.Get("/api/user/signup/options", wrap(GetSignUpOptions))
  49. r.Post("/api/user/signup", quota("user"), bind(dtos.SignUpForm{}), wrap(SignUp))
  50. r.Post("/api/user/signup/step2", bind(dtos.SignUpStep2Form{}), wrap(SignUpStep2))
  51. // invited
  52. r.Get("/api/user/invite/:code", wrap(GetInviteInfoByCode))
  53. r.Post("/api/user/invite/complete", bind(dtos.CompleteInviteForm{}), wrap(CompleteInvite))
  54. // reset password
  55. r.Get("/user/password/send-reset-email", Index)
  56. r.Get("/user/password/reset", Index)
  57. r.Post("/api/user/password/send-reset-email", bind(dtos.SendResetPasswordEmailForm{}), wrap(SendResetPasswordEmail))
  58. r.Post("/api/user/password/reset", bind(dtos.ResetUserPasswordForm{}), wrap(ResetPassword))
  59. // dashboard snapshots
  60. r.Post("/api/snapshots/", bind(m.CreateDashboardSnapshotCommand{}), CreateDashboardSnapshot)
  61. r.Get("/dashboard/snapshot/*", Index)
  62. r.Get("/api/snapshot/shared-options/", GetSharingOptions)
  63. r.Get("/api/snapshots/:key", GetDashboardSnapshot)
  64. r.Get("/api/snapshots-delete/:key", DeleteDashboardSnapshot)
  65. // api renew session based on remember cookie
  66. r.Get("/api/login/ping", quota("session"), LoginApiPing)
  67. // authed api
  68. r.Group("/api", func() {
  69. // user (signed in)
  70. r.Group("/user", func() {
  71. r.Get("/", wrap(GetSignedInUser))
  72. r.Put("/", bind(m.UpdateUserCommand{}), wrap(UpdateSignedInUser))
  73. r.Post("/using/:id", wrap(UserSetUsingOrg))
  74. r.Get("/orgs", wrap(GetSignedInUserOrgList))
  75. r.Post("/stars/dashboard/:id", wrap(StarDashboard))
  76. r.Delete("/stars/dashboard/:id", wrap(UnstarDashboard))
  77. r.Put("/password", bind(m.ChangeUserPasswordCommand{}), wrap(ChangeUserPassword))
  78. r.Get("/quotas", wrap(GetUserQuotas))
  79. })
  80. // users (admin permission required)
  81. r.Group("/users", func() {
  82. r.Get("/", wrap(SearchUsers))
  83. r.Get("/:id", wrap(GetUserById))
  84. r.Get("/:id/orgs", wrap(GetUserOrgList))
  85. r.Put("/:id", bind(m.UpdateUserCommand{}), wrap(UpdateUser))
  86. }, reqGrafanaAdmin)
  87. // org information available to all users.
  88. r.Group("/org", func() {
  89. r.Get("/", wrap(GetOrgCurrent))
  90. r.Get("/quotas", wrap(GetOrgQuotas))
  91. })
  92. // current org
  93. r.Group("/org", func() {
  94. r.Put("/", bind(dtos.UpdateOrgForm{}), wrap(UpdateOrgCurrent))
  95. r.Put("/address", bind(dtos.UpdateOrgAddressForm{}), wrap(UpdateOrgAddressCurrent))
  96. r.Post("/users", quota("user"), bind(m.AddOrgUserCommand{}), wrap(AddOrgUserToCurrentOrg))
  97. r.Get("/users", wrap(GetOrgUsersForCurrentOrg))
  98. r.Patch("/users/:userId", bind(m.UpdateOrgUserCommand{}), wrap(UpdateOrgUserForCurrentOrg))
  99. r.Delete("/users/:userId", wrap(RemoveOrgUserForCurrentOrg))
  100. // invites
  101. r.Get("/invites", wrap(GetPendingOrgInvites))
  102. r.Post("/invites", quota("user"), bind(dtos.AddInviteForm{}), wrap(AddOrgInvite))
  103. r.Patch("/invites/:code/revoke", wrap(RevokeInvite))
  104. // apps
  105. r.Get("/apps", wrap(GetOrgAppsList))
  106. r.Get("/apps/:appId/settings", wrap(GetAppSettingsById))
  107. r.Post("/apps/:appId/settings", bind(m.UpdateAppSettingsCmd{}), wrap(UpdateAppSettings))
  108. }, reqOrgAdmin)
  109. // create new org
  110. r.Post("/orgs", quota("org"), bind(m.CreateOrgCommand{}), wrap(CreateOrg))
  111. // search all orgs
  112. r.Get("/orgs", reqGrafanaAdmin, wrap(SearchOrgs))
  113. // orgs (admin routes)
  114. r.Group("/orgs/:orgId", func() {
  115. r.Get("/", wrap(GetOrgById))
  116. r.Put("/", bind(dtos.UpdateOrgForm{}), wrap(UpdateOrg))
  117. r.Put("/address", bind(dtos.UpdateOrgAddressForm{}), wrap(UpdateOrgAddress))
  118. r.Delete("/", wrap(DeleteOrgById))
  119. r.Get("/users", wrap(GetOrgUsers))
  120. r.Post("/users", bind(m.AddOrgUserCommand{}), wrap(AddOrgUser))
  121. r.Patch("/users/:userId", bind(m.UpdateOrgUserCommand{}), wrap(UpdateOrgUser))
  122. r.Delete("/users/:userId", wrap(RemoveOrgUser))
  123. r.Get("/quotas", wrap(GetOrgQuotas))
  124. r.Put("/quotas/:target", bind(m.UpdateOrgQuotaCmd{}), wrap(UpdateOrgQuota))
  125. }, reqGrafanaAdmin)
  126. // orgs (admin routes)
  127. r.Group("/orgs/name/:name", func() {
  128. r.Get("/", wrap(GetOrgByName))
  129. }, reqGrafanaAdmin)
  130. // auth api keys
  131. r.Group("/auth/keys", func() {
  132. r.Get("/", wrap(GetApiKeys))
  133. r.Post("/", quota("api_key"), bind(m.AddApiKeyCommand{}), wrap(AddApiKey))
  134. r.Delete("/:id", wrap(DeleteApiKey))
  135. }, reqOrgAdmin)
  136. // Data sources
  137. r.Group("/datasources", func() {
  138. r.Get("/", GetDataSources)
  139. r.Post("/", quota("data_source"), bind(m.AddDataSourceCommand{}), AddDataSource)
  140. r.Put("/:id", bind(m.UpdateDataSourceCommand{}), UpdateDataSource)
  141. r.Delete("/:id", DeleteDataSource)
  142. r.Get("/:id", wrap(GetDataSourceById))
  143. r.Get("/plugins", GetDataSourcePlugins)
  144. }, reqOrgAdmin)
  145. r.Get("/frontend/settings/", GetFrontendSettings)
  146. r.Any("/datasources/proxy/:id/*", reqSignedIn, ProxyDataSourceRequest)
  147. r.Any("/datasources/proxy/:id", reqSignedIn, ProxyDataSourceRequest)
  148. // Dashboard
  149. r.Group("/dashboards", func() {
  150. r.Combo("/db/:slug").Get(GetDashboard).Delete(DeleteDashboard)
  151. r.Post("/db", reqEditorRole, bind(m.SaveDashboardCommand{}), PostDashboard)
  152. r.Get("/file/:file", GetDashboardFromJsonFile)
  153. r.Get("/home", GetHomeDashboard)
  154. r.Get("/tags", GetDashboardTags)
  155. })
  156. // Playlist
  157. r.Group("/playlists", func() {
  158. r.Get("/", wrap(SearchPlaylists))
  159. r.Get("/:id", ValidateOrgPlaylist, wrap(GetPlaylist))
  160. r.Get("/:id/items", ValidateOrgPlaylist, wrap(GetPlaylistItems))
  161. r.Get("/:id/dashboards", ValidateOrgPlaylist, wrap(GetPlaylistDashboards))
  162. r.Delete("/:id", reqEditorRole, ValidateOrgPlaylist, wrap(DeletePlaylist))
  163. r.Put("/:id", reqEditorRole, bind(m.UpdatePlaylistCommand{}), ValidateOrgPlaylist, wrap(UpdatePlaylist))
  164. r.Post("/", reqEditorRole, bind(m.CreatePlaylistCommand{}), wrap(CreatePlaylist))
  165. })
  166. // Search
  167. r.Get("/search/", Search)
  168. // metrics
  169. r.Get("/metrics/test", GetTestMetrics)
  170. }, reqSignedIn)
  171. // admin api
  172. r.Group("/api/admin", func() {
  173. r.Get("/settings", AdminGetSettings)
  174. r.Post("/users", bind(dtos.AdminCreateUserForm{}), AdminCreateUser)
  175. r.Put("/users/:id/password", bind(dtos.AdminUpdateUserPasswordForm{}), AdminUpdateUserPassword)
  176. r.Put("/users/:id/permissions", bind(dtos.AdminUpdateUserPermissionsForm{}), AdminUpdateUserPermissions)
  177. r.Delete("/users/:id", AdminDeleteUser)
  178. r.Get("/users/:id/quotas", wrap(GetUserQuotas))
  179. r.Put("/users/:id/quotas/:target", bind(m.UpdateUserQuotaCmd{}), wrap(UpdateUserQuota))
  180. r.Get("/stats", AdminGetStats)
  181. }, reqGrafanaAdmin)
  182. // rendering
  183. r.Get("/render/*", reqSignedIn, RenderToPng)
  184. InitApiPluginRoutes(r)
  185. r.NotFound(NotFoundHandler)
  186. }