api

package
Version: v5.4.5+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 19, 2019 License: Apache-2.0 Imports: 61 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ViewIndex = "index"
)

Variables

View Source
var (
	NotFound = func() Response {
		return Error(404, "Not found", nil)
	}
	ServerError = func(err error) Response {
		return Error(500, "Server error", err)
	}
)

Functions

func AdminCreateUser

func AdminCreateUser(c *m.ReqContext, form dtos.AdminCreateUserForm)

func AdminDeleteUser

func AdminDeleteUser(c *m.ReqContext)

func AdminGetSettings

func AdminGetSettings(c *m.ReqContext)

func AdminGetStats

func AdminGetStats(c *m.ReqContext)

func AdminUpdateUserPassword

func AdminUpdateUserPassword(c *m.ReqContext, form dtos.AdminUpdateUserPasswordForm)

func AdminUpdateUserPermissions

func AdminUpdateUserPermissions(c *m.ReqContext, form dtos.AdminUpdateUserPermissionsForm)

func AppPluginRoute

func AppPluginRoute(route *plugins.AppPluginRoute, appID string) macaron.Handler

func BasicAuthenticatedRequest

func BasicAuthenticatedRequest(req macaron.Request, expectedUser, expectedPass string) bool

BasicAuthenticatedRequest parses the provided HTTP request for basic authentication credentials and returns true if the provided credentials match the expected username and password. Returns false if the request is unauthenticated. Uses constant-time comparison in order to mitigate timing attacks.

func CreateDashboardSnapshot

func CreateDashboardSnapshot(c *m.ReqContext, cmd m.CreateDashboardSnapshotCommand)

func GenStateString

func GenStateString() string

func GetDashboardSnapshot

func GetDashboardSnapshot(c *m.ReqContext)

GET /api/snapshots/:key

func GetDashboardTags

func GetDashboardTags(c *m.ReqContext)

func GetSharingOptions

func GetSharingOptions(c *m.ReqContext)

func LoadPlaylistDashboards

func LoadPlaylistDashboards(orgID int64, signedInUser *m.SignedInUser, playlistID int64) (dtos.PlaylistDashboardsSlice, error)

func LoadPlaylistItemDTOs

func LoadPlaylistItemDTOs(id int64) ([]m.PlaylistItemDTO, error)

func LoadPlaylistItems

func LoadPlaylistItems(id int64) ([]m.PlaylistItem, error)

func LoginAPIPing

func LoginAPIPing(c *m.ReqContext)

func Logout

func Logout(c *m.ReqContext)

func OAuthLogin

func OAuthLogin(ctx *m.ReqContext)

func ProxyGnetRequest

func ProxyGnetRequest(c *m.ReqContext)

func ReverseProxyGnetReq

func ReverseProxyGnetReq(proxyPath string) *httputil.ReverseProxy
func Search(c *m.ReqContext)

func ValidateOrgAlert

func ValidateOrgAlert(c *m.ReqContext)

func ValidateOrgPlaylist

func ValidateOrgPlaylist(c *m.ReqContext)

func Wrap

func Wrap(action interface{}) macaron.Handler

Types

type CreateAnnotationError

type CreateAnnotationError struct {
	// contains filtered or unexported fields
}

func (*CreateAnnotationError) Error

func (e *CreateAnnotationError) Error() string

type HTTPServer

type HTTPServer struct {
	RouteRegister   routing.RouteRegister    `inject:""`
	Bus             bus.Bus                  `inject:""`
	RenderService   rendering.Service        `inject:""`
	Cfg             *setting.Cfg             `inject:""`
	HooksService    *hooks.HooksService      `inject:""`
	CacheService    *cache.CacheService      `inject:""`
	DatasourceCache datasources.CacheService `inject:""`
	// contains filtered or unexported fields
}

func (*HTTPServer) ChangeActiveOrgAndRedirectToHome

func (hs *HTTPServer) ChangeActiveOrgAndRedirectToHome(c *m.ReqContext)

GET /profile/switch-org/:id

func (*HTTPServer) GetFrontendSettings

func (hs *HTTPServer) GetFrontendSettings(c *m.ReqContext)

func (*HTTPServer) GetPluginList

func (hs *HTTPServer) GetPluginList(c *m.ReqContext) Response

func (*HTTPServer) Index

func (hs *HTTPServer) Index(c *m.ReqContext)

func (*HTTPServer) Init

func (hs *HTTPServer) Init() error

func (*HTTPServer) LoginView

func (hs *HTTPServer) LoginView(c *m.ReqContext)

func (*HTTPServer) NotFoundHandler

func (hs *HTTPServer) NotFoundHandler(c *m.ReqContext)

func (*HTTPServer) ProxyDataSourceRequest

func (hs *HTTPServer) ProxyDataSourceRequest(c *m.ReqContext)

func (*HTTPServer) QueryMetrics

func (hs *HTTPServer) QueryMetrics(c *m.ReqContext, reqDto dtos.MetricRequest) Response

POST /api/tsdb/query

func (*HTTPServer) RenderToPng

func (hs *HTTPServer) RenderToPng(c *m.ReqContext)

func (*HTTPServer) Run

func (hs *HTTPServer) Run(ctx context.Context) error

type NormalResponse

type NormalResponse struct {
	// contains filtered or unexported fields
}

func Empty

func Empty(status int) *NormalResponse

Empty create an empty response

func Error

func Error(status int, message string, err error) *NormalResponse

Error create a erroneous response

func JSON

func JSON(status int, body interface{}) *NormalResponse

JSON create a JSON response

func Respond

func Respond(status int, body interface{}) *NormalResponse

Respond create a response

func Success

func Success(message string) *NormalResponse

Success create a successful response

func (*NormalResponse) Cache

func (r *NormalResponse) Cache(ttl string) *NormalResponse

func (*NormalResponse) Header

func (r *NormalResponse) Header(key, value string) *NormalResponse

func (*NormalResponse) WriteTo

func (r *NormalResponse) WriteTo(ctx *m.ReqContext)

type Response

type Response interface {
	WriteTo(ctx *m.ReqContext)
}

func AddAPIKey

func AddAPIKey(c *m.ReqContext, cmd m.AddApiKeyCommand) Response

func AddDataSource

func AddDataSource(c *m.ReqContext, cmd m.AddDataSourceCommand) Response

func AddOrgInvite

func AddOrgInvite(c *m.ReqContext, inviteDto dtos.AddInviteForm) Response

func AddOrgUser

func AddOrgUser(c *m.ReqContext, cmd m.AddOrgUserCommand) Response

POST /api/orgs/:orgId/users

func AddOrgUserToCurrentOrg

func AddOrgUserToCurrentOrg(c *m.ReqContext, cmd m.AddOrgUserCommand) Response

POST /api/org/users

func AddTeamMember

func AddTeamMember(c *m.ReqContext, cmd m.AddTeamMemberCommand) Response

POST /api/teams/:teamId/members

func AlertTest

func AlertTest(c *m.ReqContext, dto dtos.AlertTestCommand) Response

POST /api/alerts/test

func CalculateDashboardDiff

func CalculateDashboardDiff(c *m.ReqContext, apiOptions dtos.CalculateDiffOptions) Response

POST /api/dashboards/calculate-diff performs diffs on two dashboards

func ChangeUserPassword

func ChangeUserPassword(c *m.ReqContext, cmd m.ChangeUserPasswordCommand) Response

func ClearHelpFlags

func ClearHelpFlags(c *m.ReqContext) Response

func CompleteInvite

func CompleteInvite(c *m.ReqContext, completeInvite dtos.CompleteInviteForm) Response

func CreateAlertNotification

func CreateAlertNotification(c *m.ReqContext, cmd m.CreateAlertNotificationCommand) Response

func CreateFolder

func CreateFolder(c *m.ReqContext, cmd m.CreateFolderCommand) Response

func CreateOrg

func CreateOrg(c *m.ReqContext, cmd m.CreateOrgCommand) Response

POST /api/orgs

func CreatePlaylist

func CreatePlaylist(c *m.ReqContext, cmd m.CreatePlaylistCommand) Response

func CreateTeam

func CreateTeam(c *m.ReqContext, cmd m.CreateTeamCommand) Response

POST /api/teams

func DeleteAPIKey

func DeleteAPIKey(c *m.ReqContext) Response

func DeleteAlertNotification

func DeleteAlertNotification(c *m.ReqContext) Response

func DeleteAnnotationByID

func DeleteAnnotationByID(c *m.ReqContext) Response

func DeleteAnnotationRegion

func DeleteAnnotationRegion(c *m.ReqContext) Response

func DeleteAnnotations

func DeleteAnnotations(c *m.ReqContext, cmd dtos.DeleteAnnotationsCmd) Response

func DeleteDashboard

func DeleteDashboard(c *m.ReqContext) Response

func DeleteDashboardByUID

func DeleteDashboardByUID(c *m.ReqContext) Response

func DeleteDashboardSnapshot

func DeleteDashboardSnapshot(c *m.ReqContext) Response

DELETE /api/snapshots/:key

func DeleteDashboardSnapshotByDeleteKey

func DeleteDashboardSnapshotByDeleteKey(c *m.ReqContext) Response

GET /api/snapshots-delete/:deleteKey

func DeleteDataSourceById

func DeleteDataSourceById(c *m.ReqContext) Response

func DeleteDataSourceByName

func DeleteDataSourceByName(c *m.ReqContext) Response

func DeleteFolder

func DeleteFolder(c *m.ReqContext) Response

func DeleteOrgByID

func DeleteOrgByID(c *m.ReqContext) Response

GET /api/orgs/:orgId

func DeletePlaylist

func DeletePlaylist(c *m.ReqContext) Response

func DeleteTeamByID

func DeleteTeamByID(c *m.ReqContext) Response

DELETE /api/teams/:teamId

func GenerateError

func GenerateError(c *m.ReqContext) Response

Generates a index out of range error

func GenerateSQLTestData

func GenerateSQLTestData(c *m.ReqContext) Response

GET /api/tsdb/testdata/gensql

func GetAPIKeys

func GetAPIKeys(c *m.ReqContext) Response

func GetAlert

func GetAlert(c *m.ReqContext) Response

GET /api/alerts/:id

func GetAlertNotificationByID

func GetAlertNotificationByID(c *m.ReqContext) Response

func GetAlertNotifications

func GetAlertNotifications(c *m.ReqContext) Response

func GetAlertNotifiers

func GetAlertNotifiers(c *m.ReqContext) Response

func GetAlertStatesForDashboard

func GetAlertStatesForDashboard(c *m.ReqContext) Response

func GetAlerts

func GetAlerts(c *m.ReqContext) Response

GET /api/alerts

func GetAnnotations

func GetAnnotations(c *m.ReqContext) Response

func GetDashboard

func GetDashboard(c *m.ReqContext) Response

func GetDashboardPermissionList

func GetDashboardPermissionList(c *m.ReqContext) Response

func GetDashboardVersion

func GetDashboardVersion(c *m.ReqContext) Response

GetDashboardVersion returns the dashboard version with the given ID.

func GetDashboardVersions

func GetDashboardVersions(c *m.ReqContext) Response

GetDashboardVersions returns all dashboard versions as JSON

func GetDataSourceById

func GetDataSourceById(c *m.ReqContext) Response

func GetDataSourceByName

func GetDataSourceByName(c *m.ReqContext) Response

Get /api/datasources/name/:name

func GetDataSourceIdByName

func GetDataSourceIdByName(c *m.ReqContext) Response

Get /api/datasources/id/:name

func GetDataSources

func GetDataSources(c *m.ReqContext) Response

func GetFolderByID

func GetFolderByID(c *m.ReqContext) Response

func GetFolderByUID

func GetFolderByUID(c *m.ReqContext) Response

func GetFolderPermissionList

func GetFolderPermissionList(c *m.ReqContext) Response

func GetFolders

func GetFolders(c *m.ReqContext) Response

func GetHomeDashboard

func GetHomeDashboard(c *m.ReqContext) Response

func GetInviteInfoByCode

func GetInviteInfoByCode(c *m.ReqContext) Response

func GetOrgByID

func GetOrgByID(c *m.ReqContext) Response

GET /api/orgs/:orgId

func GetOrgByName

func GetOrgByName(c *m.ReqContext) Response

Get /api/orgs/name/:name

func GetOrgCurrent

func GetOrgCurrent(c *m.ReqContext) Response

GET /api/org

func GetOrgPreferences

func GetOrgPreferences(c *m.ReqContext) Response

GET /api/org/preferences

func GetOrgQuotas

func GetOrgQuotas(c *m.ReqContext) Response

func GetOrgUsers

func GetOrgUsers(c *m.ReqContext) Response

GET /api/orgs/:orgId/users

func GetOrgUsersForCurrentOrg

func GetOrgUsersForCurrentOrg(c *m.ReqContext) Response

GET /api/org/users

func GetPendingOrgInvites

func GetPendingOrgInvites(c *m.ReqContext) Response

func GetPlaylist

func GetPlaylist(c *m.ReqContext) Response

func GetPlaylistDashboards

func GetPlaylistDashboards(c *m.ReqContext) Response

func GetPlaylistItems

func GetPlaylistItems(c *m.ReqContext) Response

func GetPluginDashboards

func GetPluginDashboards(c *m.ReqContext) Response

func GetPluginMarkdown

func GetPluginMarkdown(c *m.ReqContext) Response

func GetPluginSettingByID

func GetPluginSettingByID(c *m.ReqContext) Response

func GetSignUpOptions

func GetSignUpOptions(c *m.ReqContext) Response

GET /api/user/signup/options

func GetSignedInUser

func GetSignedInUser(c *m.ReqContext) Response

GET /api/user (current authenticated user)

func GetSignedInUserOrgList

func GetSignedInUserOrgList(c *m.ReqContext) Response

GET /api/user/orgs

func GetSignedInUserTeamList

func GetSignedInUserTeamList(c *m.ReqContext) Response

GET /api/user/teams

func GetTeamByID

func GetTeamByID(c *m.ReqContext) Response

GET /api/teams/:teamId

func GetTeamMembers

func GetTeamMembers(c *m.ReqContext) Response

GET /api/teams/:teamId/members

func GetTeamPreferences

func GetTeamPreferences(c *m.ReqContext) Response

GET /api/teams/:teamId/preferences

func GetTestDataRandomWalk

func GetTestDataRandomWalk(c *m.ReqContext) Response

GET /api/tsdb/testdata/random-walk

func GetTestDataScenarios

func GetTestDataScenarios(c *m.ReqContext) Response

GET /api/tsdb/testdata/scenarios

func GetUserByID

func GetUserByID(c *m.ReqContext) Response

GET /api/users/:id

func GetUserByLoginOrEmail

func GetUserByLoginOrEmail(c *m.ReqContext) Response

GET /api/users/lookup

func GetUserOrgList

func GetUserOrgList(c *m.ReqContext) Response

GET /api/users/:id/orgs

func GetUserPreferences

func GetUserPreferences(c *m.ReqContext) Response

GET /api/user/preferences

func GetUserQuotas

func GetUserQuotas(c *m.ReqContext) Response

func GetUserTeams

func GetUserTeams(c *m.ReqContext) Response

GET /api/users/:id/teams

func ImportDashboard

func ImportDashboard(c *m.ReqContext, apiCmd dtos.ImportDashboardCommand) Response

func LoginPost

func LoginPost(c *m.ReqContext, cmd dtos.LoginCommand) Response

func NotificationTest

func NotificationTest(c *m.ReqContext, dto dtos.NotificationTestCommand) Response

POST /api/alert-notifications/test

func PauseAlert

func PauseAlert(c *m.ReqContext, dto dtos.PauseAlertCommand) Response

POST /api/alerts/:alertId/pause

func PauseAllAlerts

func PauseAllAlerts(c *m.ReqContext, dto dtos.PauseAllAlertsCommand) Response

POST /api/admin/pause-all-alerts

func PostAnnotation

func PostAnnotation(c *m.ReqContext, cmd dtos.PostAnnotationsCmd) Response

func PostDashboard

func PostDashboard(c *m.ReqContext, cmd m.SaveDashboardCommand) Response

func PostGraphiteAnnotation

func PostGraphiteAnnotation(c *m.ReqContext, cmd dtos.PostGraphiteAnnotationsCmd) Response

func RemoveOrgUser

func RemoveOrgUser(c *m.ReqContext) Response

DELETE /api/orgs/:orgId/users/:userId

func RemoveOrgUserForCurrentOrg

func RemoveOrgUserForCurrentOrg(c *m.ReqContext) Response

DELETE /api/org/users/:userId

func RemoveTeamMember

func RemoveTeamMember(c *m.ReqContext) Response

DELETE /api/teams/:teamId/members/:userId

func ResetPassword

func ResetPassword(c *m.ReqContext, form dtos.ResetUserPasswordForm) Response

func RestoreDashboardVersion

func RestoreDashboardVersion(c *m.ReqContext, apiCmd dtos.RestoreDashboardVersionCommand) Response

RestoreDashboardVersion restores a dashboard to the given version.

func RevokeInvite

func RevokeInvite(c *m.ReqContext) Response

func SearchDashboardSnapshots

func SearchDashboardSnapshots(c *m.ReqContext) Response

GET /api/dashboard/snapshots

func SearchOrgs

func SearchOrgs(c *m.ReqContext) Response

func SearchPlaylists

func SearchPlaylists(c *m.ReqContext) Response

func SearchTeams

func SearchTeams(c *m.ReqContext) Response

GET /api/teams/search

func SearchUsers

func SearchUsers(c *m.ReqContext) Response

GET /api/users

func SearchUsersWithPaging

func SearchUsersWithPaging(c *m.ReqContext) Response

GET /api/users/search

func SendResetPasswordEmail

func SendResetPasswordEmail(c *m.ReqContext, form dtos.SendResetPasswordEmailForm) Response

func SetHelpFlag

func SetHelpFlag(c *m.ReqContext) Response

func SetHomeDashboard

func SetHomeDashboard(c *m.ReqContext, cmd m.SavePreferencesCommand) Response

POST /api/preferences/set-home-dash

func SignUp

func SignUp(c *m.ReqContext, form dtos.SignUpForm) Response

POST /api/user/signup

func SignUpStep2

func SignUpStep2(c *m.ReqContext, form dtos.SignUpStep2Form) Response

func StarDashboard

func StarDashboard(c *m.ReqContext) Response

func UnstarDashboard

func UnstarDashboard(c *m.ReqContext) Response

func UpdateAlertNotification

func UpdateAlertNotification(c *m.ReqContext, cmd m.UpdateAlertNotificationCommand) Response

func UpdateAnnotation

func UpdateAnnotation(c *m.ReqContext, cmd dtos.UpdateAnnotationsCmd) Response

func UpdateDashboardPermissions

func UpdateDashboardPermissions(c *m.ReqContext, apiCmd dtos.UpdateDashboardAclCommand) Response

func UpdateDataSource

func UpdateDataSource(c *m.ReqContext, cmd m.UpdateDataSourceCommand) Response

func UpdateFolder

func UpdateFolder(c *m.ReqContext, cmd m.UpdateFolderCommand) Response

func UpdateFolderPermissions

func UpdateFolderPermissions(c *m.ReqContext, apiCmd dtos.UpdateDashboardAclCommand) Response

func UpdateOrg

func UpdateOrg(c *m.ReqContext, form dtos.UpdateOrgForm) Response

PUT /api/orgs/:orgId

func UpdateOrgAddress

func UpdateOrgAddress(c *m.ReqContext, form dtos.UpdateOrgAddressForm) Response

PUT /api/orgs/:orgId/address

func UpdateOrgAddressCurrent

func UpdateOrgAddressCurrent(c *m.ReqContext, form dtos.UpdateOrgAddressForm) Response

PUT /api/org/address

func UpdateOrgCurrent

func UpdateOrgCurrent(c *m.ReqContext, form dtos.UpdateOrgForm) Response

PUT /api/org

func UpdateOrgPreferences

func UpdateOrgPreferences(c *m.ReqContext, dtoCmd dtos.UpdatePrefsCmd) Response

PUT /api/org/preferences

func UpdateOrgQuota

func UpdateOrgQuota(c *m.ReqContext, cmd m.UpdateOrgQuotaCmd) Response

func UpdateOrgUser

func UpdateOrgUser(c *m.ReqContext, cmd m.UpdateOrgUserCommand) Response

PATCH /api/orgs/:orgId/users/:userId

func UpdateOrgUserForCurrentOrg

func UpdateOrgUserForCurrentOrg(c *m.ReqContext, cmd m.UpdateOrgUserCommand) Response

PATCH /api/org/users/:userId

func UpdatePlaylist

func UpdatePlaylist(c *m.ReqContext, cmd m.UpdatePlaylistCommand) Response

func UpdatePluginSetting

func UpdatePluginSetting(c *m.ReqContext, cmd m.UpdatePluginSettingCmd) Response

func UpdateSignedInUser

func UpdateSignedInUser(c *m.ReqContext, cmd m.UpdateUserCommand) Response

POST /api/user

func UpdateTeam

func UpdateTeam(c *m.ReqContext, cmd m.UpdateTeamCommand) Response

PUT /api/teams/:teamId

func UpdateTeamPreferences

func UpdateTeamPreferences(c *m.ReqContext, dtoCmd dtos.UpdatePrefsCmd) Response

PUT /api/teams/:teamId/preferences

func UpdateUser

func UpdateUser(c *m.ReqContext, cmd m.UpdateUserCommand) Response

POST /api/users/:id

func UpdateUserActiveOrg

func UpdateUserActiveOrg(c *m.ReqContext) Response

POST /api/users/:id/using/:orgId

func UpdateUserPreferences

func UpdateUserPreferences(c *m.ReqContext, dtoCmd dtos.UpdatePrefsCmd) Response

PUT /api/user/preferences

func UpdateUserQuota

func UpdateUserQuota(c *m.ReqContext, cmd m.UpdateUserQuotaCmd) Response

func UserSetUsingOrg

func UserSetUsingOrg(c *m.ReqContext) Response

POST /api/user/using/:id

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL