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

httpapi

package

Go to main page

Versions in this module

v0

v0.9.0

Oct 19, 2026

Changes in this version

type Config

+ DevLinks []DevLink

+ type DevLink struct

+ Label string

+ URL string

v0.8.5

Oct 16, 2026

Changes in this version

type Config

+ Realtime *realtime.Hub

+ RealtimeLimits realtime.Limits

+ TriggerLimits registry.TriggerLimits

+ Triggers triggers.Admin

v0.8.4

Oct 15, 2026

Changes in this version

type Config

+ Aggregate registry.AggregateLimits

+ Expand registry.ExpandLimits

v0.8.3

Oct 15, 2026

Changes in this version

type Worker

+ func (w *Worker) ReportOrganizationless(ctx context.Context)

+ func (w *Worker) SweepTeamRolesDue(ctx context.Context)

v0.8.2

Oct 14, 2026

Changes in this version

type Config

+ OAuth *oauth.Service

+ PushSenders map[string]push.Sender

+ ReloadErrors func() []string

type Worker

+ func (w *Worker) SweepDevicesDue(ctx context.Context)

v0.8.1

Oct 8, 2026

Changes in this version

+ const DefaultRegenerateRate

type Config

+ ImageConcurrency int

+ ImageMaxPixels int64

+ ImageTimeout time.Duration

type Worker

+ func (w *Worker) CheckImageDeclarations(ctx context.Context)

+ func (w *Worker) LogImageLimits()

v0.8.0

Oct 7, 2026

Changes in this version

+ const DefaultMaxUploadBytes

type Config

+ MaxUploadBytes int64

type Worker

+ func (w *Worker) FilesDue(ctx context.Context)

v0.7.0

Oct 5, 2026

Changes in this version

type Config

+ DisableAdminAPI bool

+ UI http.Handler

v0.6.0

Oct 4, 2026

v0.5.0

Oct 4, 2026

v0.4.0

Oct 3, 2026

Changes in this version

type Config

+ BackdURL string

+ Metrics *metrics.Metrics

type Worker

+ func (w *Worker) PurgeDue(ctx context.Context)

v0.3.0

Sep 30, 2026

Changes in this version

+ const DefaultMaxBodyBytes

+ const DefaultOpTimeout

+ const DevDurationHeader

+ const DevLogsHeader

+ func NewHandler(cfg Config) http.Handler

+ func NewInternalHandler(cfg Config) http.Handler

+ func Run(ctx context.Context, srv *http.Server, ln net.Listener, ...) error

+ func ServerTimeouts(srv *http.Server, opTimeout time.Duration)

+ type Config struct

+ CallbackKey []byte

+ CallbackURL string

+ ConfigFingerprint string

+ Dev bool

+ ExecutorToken string

+ Functions FunctionRunner

+ Log *slog.Logger

+ MaxBodyBytes int64

+ Now func() time.Time

+ OpTimeout time.Duration

+ Ready func(ctx context.Context) error

+ Registry *registry.Registry

+ Store Store

+ TrustedProxies []netip.Prefix

+ Users func(realm string) *auth.Users

+ type Detail struct

+ Path string

+ Reason string

+ type FunctionRunner interface

+ Invoke func(ctx context.Context, req executor.InvokeRequest) (executor.Result, error)

+ type Store interface

+ Repository func(c *registry.Collection) storage.Repository

+ Transact func(ctx context.Context, fn func(ctx context.Context) error) error

+ type Worker struct

+ func NewWorker(cfg Config, id string) *Worker

+ func (w *Worker) EnqueueDue(ctx context.Context)

+ func (w *Worker) Run(ctx context.Context, concurrency int)

+ func (w *Worker) RunOnce(ctx context.Context) bool