api

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Oct 1, 2026 License: Apache-2.0 Imports: 30 Imported by: 0

Documentation

Overview

Package api implements the API used by the UI: edges, targets, results, traceroutes, data lifecycle, accounts and alerting.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Allowed 

func Allowed(role store.Role, procedure string) bool

Allowed is the role policy of AdminService and AlertService.

func ExportHandler 

func ExportHandler(st *store.Store, authSvc interface {
	Authenticate(ctx context.Context, h http.Header) (auth.Principal, error)
}) http.Handler

ExportHandler serves GET /export/{checks,traces}.csv?from=&to=[&edge_id=][&target_id=] to any signed in user. Times are RFC 3339.

func HealthHandler 

func HealthHandler(st *store.Store) http.Handler

HealthHandler answers 200 when the database answers, 503 otherwise. No session needed: it says nothing but "ok".

Types

type Admin 

type Admin struct {
	Store     *store.Store
	CA        *pki.CA
	Hub       *fleet.Hub
	Assigner  *fleet.Assigner
	PublicURL string // gateway URL as edges reach it, for the enroll command
}

Admin serves AdminService (operators only).

func (*Admin) CreateEnrollmentToken 

func (a *Admin) CreateEnrollmentToken(ctx context.Context, req *connect.Request[netprobev1.CreateEnrollmentTokenRequest]) (*connect.Response[netprobev1.CreateEnrollmentTokenResponse], error)

func (*Admin) CreateUser 

func (a *Admin) CreateUser(ctx context.Context, req *connect.Request[netprobev1.CreateUserRequest]) (*connect.Response[netprobev1.CreateUserResponse], error)

func (*Admin) DataStats 

func (a *Admin) DataStats(ctx context.Context, _ *connect.Request[netprobev1.DataStatsRequest]) (*connect.Response[netprobev1.DataStatsResponse], error)

func (*Admin) DeleteData 

func (a *Admin) DeleteData(ctx context.Context, req *connect.Request[netprobev1.DeleteDataRequest]) (*connect.Response[netprobev1.DeleteDataResponse], error)

func (*Admin) DeleteTarget 

func (a *Admin) DeleteTarget(ctx context.Context, req *connect.Request[netprobev1.DeleteTargetRequest]) (*connect.Response[netprobev1.DeleteTargetResponse], error)

func (*Admin) DeleteUser 

func (a *Admin) DeleteUser(ctx context.Context, req *connect.Request[netprobev1.DeleteUserRequest]) (*connect.Response[netprobev1.DeleteUserResponse], error)

func (*Admin) GetEdge 

func (a *Admin) GetEdge(ctx context.Context, req *connect.Request[netprobev1.GetEdgeRequest]) (*connect.Response[netprobev1.GetEdgeResponse], error)

func (*Admin) GetTrace 

func (a *Admin) GetTrace(ctx context.Context, req *connect.Request[netprobev1.GetTraceRequest]) (*connect.Response[netprobev1.GetTraceResponse], error)

func (*Admin) LatestResults 

func (a *Admin) LatestResults(ctx context.Context, req *connect.Request[netprobev1.LatestResultsRequest]) (*connect.Response[netprobev1.LatestResultsResponse], error)

func (*Admin) ListAudit 

func (a *Admin) ListAudit(ctx context.Context, req *connect.Request[netprobev1.ListAuditRequest]) (*connect.Response[netprobev1.ListAuditResponse], error)

func (*Admin) ListEdges 

func (a *Admin) ListEdges(ctx context.Context, _ *connect.Request[netprobev1.ListEdgesRequest]) (*connect.Response[netprobev1.ListEdgesResponse], error)

func (*Admin) ListPathChanges 

func (a *Admin) ListPathChanges(ctx context.Context, req *connect.Request[netprobev1.ListPathChangesRequest]) (*connect.Response[netprobev1.ListPathChangesResponse], error)

func (*Admin) ListTargets 

func (a *Admin) ListTargets(ctx context.Context, _ *connect.Request[netprobev1.ListTargetsRequest]) (*connect.Response[netprobev1.ListTargetsResponse], error)

func (*Admin) ListUsers 

func (a *Admin) ListUsers(ctx context.Context, _ *connect.Request[netprobev1.ListUsersRequest]) (*connect.Response[netprobev1.ListUsersResponse], error)

func (*Admin) MetricsHandler 

func (a *Admin) MetricsHandler(token, version string) http.Handler

MetricsHandler serves the current state in the Prometheus text format, to scrapers presenting "Authorization: Bearer <token>". Without a token the endpoint does not exist.

func (*Admin) QuerySeries 

func (a *Admin) QuerySeries(ctx context.Context, req *connect.Request[netprobev1.QuerySeriesRequest]) (*connect.Response[netprobev1.QuerySeriesResponse], error)

func (*Admin) RevokeEdge 

func (a *Admin) RevokeEdge(ctx context.Context, req *connect.Request[netprobev1.RevokeEdgeRequest]) (*connect.Response[netprobev1.RevokeEdgeResponse], error)

func (*Admin) SaveTarget 

func (a *Admin) SaveTarget(ctx context.Context, req *connect.Request[netprobev1.SaveTargetRequest]) (*connect.Response[netprobev1.SaveTargetResponse], error)

func (*Admin) UpdateUser 

func (a *Admin) UpdateUser(ctx context.Context, req *connect.Request[netprobev1.UpdateUserRequest]) (*connect.Response[netprobev1.UpdateUserResponse], error)

type AlertAdmin 

type AlertAdmin struct {
	Store  *store.Store
	Sender *alerting.Sender
}

AlertAdmin implements AlertService.

func (*AlertAdmin) DeleteRule 

func (a *AlertAdmin) DeleteRule(ctx context.Context, req *connect.Request[netprobev1.DeleteRuleRequest]) (*connect.Response[netprobev1.DeleteRuleResponse], error)

func (*AlertAdmin) DeleteWebhook 

func (a *AlertAdmin) DeleteWebhook(ctx context.Context, req *connect.Request[netprobev1.DeleteWebhookRequest]) (*connect.Response[netprobev1.DeleteWebhookResponse], error)

func (*AlertAdmin) ListAlerts 

func (a *AlertAdmin) ListAlerts(ctx context.Context, req *connect.Request[netprobev1.ListAlertsRequest]) (*connect.Response[netprobev1.ListAlertsResponse], error)

func (*AlertAdmin) ListDeliveries 

func (a *AlertAdmin) ListDeliveries(ctx context.Context, req *connect.Request[netprobev1.ListDeliveriesRequest]) (*connect.Response[netprobev1.ListDeliveriesResponse], error)

func (*AlertAdmin) ListRules 

func (a *AlertAdmin) ListRules(ctx context.Context, _ *connect.Request[netprobev1.ListRulesRequest]) (*connect.Response[netprobev1.ListRulesResponse], error)

func (*AlertAdmin) ListWebhooks 

func (a *AlertAdmin) ListWebhooks(ctx context.Context, _ *connect.Request[netprobev1.ListWebhooksRequest]) (*connect.Response[netprobev1.ListWebhooksResponse], error)

func (*AlertAdmin) SaveRule 

func (a *AlertAdmin) SaveRule(ctx context.Context, req *connect.Request[netprobev1.SaveRuleRequest]) (*connect.Response[netprobev1.SaveRuleResponse], error)

func (*AlertAdmin) SaveWebhook 

func (a *AlertAdmin) SaveWebhook(ctx context.Context, req *connect.Request[netprobev1.SaveWebhookRequest]) (*connect.Response[netprobev1.SaveWebhookResponse], error)

func (*AlertAdmin) TestWebhook 

func (a *AlertAdmin) TestWebhook(ctx context.Context, req *connect.Request[netprobev1.TestWebhookRequest]) (*connect.Response[netprobev1.TestWebhookResponse], error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.