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
- API
  
  Reference documentation for the pkg.go.dev API
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

v0

v0.5.1

Oct 29, 2026

v0.5.0

Oct 28, 2026

Changes in this version

+ const ProblemWorkloadRetired

type Deps

+ Authenticator authn.Authenticator

+ type Middleware struct

+ Name string

+ Wrap func(http.Handler) http.Handler

type Problem

+ RetiredAt string

+ type Route struct

+ Handler http.HandlerFunc

+ Method string

+ Pattern string

type Server

+ func (s *Server) Surface() *Surface

+ type Surface struct

+ Console http.Handler

+ Middleware []Middleware

+ Routes []Route

+ func (sf *Surface) Handle(method, pattern string, h http.HandlerFunc)

+ func (sf *Surface) Handler() http.Handler

+ func (sf *Surface) RouteNames() []string

+ func (sf *Surface) Use(m Middleware)

v0.4.3

Oct 21, 2026

v0.4.2

Oct 20, 2026

v0.4.1

Oct 18, 2026

v0.4.0

Oct 18, 2026

v0.3.0

Oct 17, 2026

v0.2.0

Oct 16, 2026

Changes in this version

type Me

+ Version string

v0.1.0

Oct 6, 2026

Changes in this version

+ const APIPrefix

+ const ContentTypeProblem

+ const DefaultLoginAttempts

+ const DefaultLoginWindow

+ const OperatorCertFile

+ const OperatorKeyFile

+ const ProblemAgentOffline

+ const ProblemAlreadyRevoked

+ const ProblemCrossOrigin

+ const ProblemDuplicateName

+ const ProblemInUse

+ const ProblemInternal

+ const ProblemInvalidCredentials

+ const ProblemInvalidParameter

+ const ProblemInvalidRequest

+ const ProblemMatchCountMismatch

+ const ProblemMethodNotAllowed

+ const ProblemNoPassword

+ const ProblemNotFound

+ const ProblemPreconditionFailed

+ const ProblemPreconditionRequired

+ const ProblemTooManyAttempts

+ const ProblemUnauthenticated

+ const ProblemValidation

+ const SessionCookie

+ func ConsoleHandler(tree fs.FS) http.Handler

+ func CrossOriginGuard(next http.Handler) http.Handler

+ func Fingerprint(der []byte) string

+ func ListenerCertificate(certFile, keyFile, dir string, hosts []string, now time.Time, log *slog.Logger) (tls.Certificate, error)

+ func NewHTTPServer(tlsCfg *tls.Config, handler http.Handler) *http.Server

+ func PrincipalFromContext(ctx context.Context) (*operator.Principal, bool)

+ func ServerTLSConfig(cert tls.Certificate) *tls.Config

+ type Authenticator struct

+ Log *slog.Logger

+ Operators *operator.Service

+ func (a *Authenticator) EndSession(ctx context.Context, w http.ResponseWriter) error

+ func (a *Authenticator) Middleware(next http.Handler) http.Handler

+ type Deps struct

+ Authoring *policy.Authoring

+ Console fs.FS

+ Enroll *enroll.Service

+ Fleet *fleet.Service

+ GatewayAddress string

+ Log *slog.Logger

+ LoginAttempts int

+ LoginWindow time.Duration

+ Now func() time.Time

+ Operators *operator.Service

+ Reads *readmodel.Reader

+ Site string

+ type Finding struct

+ Message string

+ Path string

+ Rule string

+ type Me struct

+ DisplayName *string

+ GatewayAddress *string

+ Site string

+ type Problem struct

+ CurrentVersion string

+ Detail string

+ Errors []Finding

+ Expected *int

+ LastSeenAt *nullableInstant

+ Matched *int

+ Status int

+ Title string

+ Type string

+ type Server struct

+ func New(d Deps) *Server

+ func (s *Server) Handler() http.Handler

+ func (s *Server) Routes() []string

+ type Throttle struct

+ Limit int

+ Now func() time.Time

+ Window time.Duration

+ func (t *Throttle) Allow(key string) (ok bool, retryAfter time.Duration)

+ func (t *Throttle) Middleware(next http.Handler) http.Handler

+ func (t *Throttle) Sources() int