Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v2

v2.0.3

Jun 3, 2026

v2.0.2

May 7, 2026

v2.0.1

Apr 20, 2026

v2.0.0

Apr 20, 2026

Changes in this version

+ func MemberlistStatusHandler(httpPathPrefix string, kvs *memberlist.KVInitService) http.Handler

+ type API struct

+ func New(cfg Config, s *server.Server, grpcGatewayMux *grpcgw.ServeMux, ...) (*API, error)

+ func (a *API) RegisterAPI(statusService statusv1.StatusServiceServer) error

+ func (a *API) RegisterAdHocProfiles(ahp *adhocprofiles.AdHocProfiles)

+ func (a *API) RegisterAdmin(ad AdminService)

+ func (a *API) RegisterCatchAll() error

+ func (a *API) RegisterCompactor(c *compactor.MultitenantCompactor)

+ func (a *API) RegisterDebugInfo(svc debuginfov1alpha1connect.DebuginfoServiceHandler, ...)

+ func (a *API) RegisterDistributor(d *distributor.Distributor, limits *validation.Overrides, cfg server.Config)

+ func (a *API) RegisterFeatureFlagsServiceHandler(svc capabilitiesv1connect.FeatureFlagsServiceHandler)

+ func (a *API) RegisterFrontendForQuerierHandler(frontendSvc *frontend.Frontend)

+ func (a *API) RegisterIngester(svc *ingester.Ingester)

+ func (a *API) RegisterIngesterRing(r http.Handler)

+ func (a *API) RegisterMemberlistKV(pathPrefix string, kvs *memberlist.KVInitService)

+ func (a *API) RegisterMetastoreAdmin(adm *metastoreadmin.Admin)

+ func (a *API) RegisterOverridesExporter(oe *exporter.OverridesExporter)

+ func (a *API) RegisterPyroscopeHandlers(client querierv1connect.QuerierServiceClient)

+ func (a *API) RegisterQuerierServiceHandler(svc querierv1connect.QuerierServiceHandler)

+ func (a *API) RegisterQueryBackend(svc *querybackend.QueryBackend)

+ func (a *API) RegisterQueryDiagnosticsAdmin(adm *querydiagnostics.Admin)

+ func (a *API) RegisterQueryScheduler(s *scheduler.Scheduler)

+ func (a *API) RegisterReadyHandler(handler http.Handler)

+ func (a *API) RegisterRedirectToAdmin()

+ func (a *API) RegisterRoute(path string, handler http.Handler, registerOpts ...RegisterOption)

+ func (a *API) RegisterRuntimeConfig(runtimeConfigHandler http.HandlerFunc, userLimitsHandler http.HandlerFunc)

+ func (a *API) RegisterSegmentWriter(svc *segmentwriter.SegmentWriterService)

+ func (a *API) RegisterSegmentWriterRing(r http.Handler)

+ func (a *API) RegisterStoreGateway(svc *storegateway.StoreGateway)

+ func (a *API) RegisterTenantSettings(ts *settings.TenantSettings)

+ func (a *API) RegisterVCSServiceHandler(svc vcsv1connect.VCSServiceHandler)

+ func (a *API) RegisterVersion(svc versionv1connect.VersionHandler)

+ func (a *API) WithArtificialDelayMiddleware(limits delayhandler.Limits) RegisterOption

+ func (a *API) WithAuthMiddleware() RegisterOption

+ func (a *API) WithBodySizeLimitMiddleware(limits body.Limits) RegisterOption

+ type AdminService interface

+ BlockHandler func(w http.ResponseWriter, r *http.Request)

+ BlocksHandler func(w http.ResponseWriter, r *http.Request)

+ DatasetHandler func(w http.ResponseWriter, r *http.Request)

+ DatasetProfilesHandler func(w http.ResponseWriter, r *http.Request)

+ DatasetSymbolsHandler func(w http.ResponseWriter, r *http.Request)

+ DatasetTSDBIndexHandler func(w http.ResponseWriter, r *http.Request)

+ ProfileCallTreeHandler func(w http.ResponseWriter, r *http.Request)

+ ProfileDownloadHandler func(w http.ResponseWriter, r *http.Request)

+ TenantsHandler func(w http.ResponseWriter, r *http.Request)

+ type Config struct

+ BaseURL string

+ GrpcAuthMiddleware connect.Option

+ HTTPAuthMiddleware middleware.Interface

+ func (cfg *Config) RegisterFlags(fs *flag.FlagSet)

+ type IndexPageContent struct

+ func NewIndexPageContent() *IndexPageContent

+ func (pc *IndexPageContent) AddLinks(weight int, groupDesc string, links []IndexPageLink)

+ func (pc *IndexPageContent) GetContent() []IndexPageLinkGroup

+ type IndexPageLink struct

+ Dangerous bool

+ Desc string

+ Path string

+ type IndexPageLinkGroup struct

+ Desc string

+ Links []IndexPageLink

+ type RegisterOption func(*registerParams)

+ func WithGzipMiddleware() RegisterOption

+ func WithMethod(method string) RegisterOption

+ func WithPrefix() RegisterOption

Other modules containing this package

github.com/grafana/pyroscope