api

package

v1.10.0 Latest Latest Go to latest Published: Apr 18, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Package api hosts the HTTP control-plane for watchtower (token auth, /v1/update, /v1/metrics).

This section is empty.

This section is empty.

This section is empty.

type API struct {
	Token string
	// contains filtered or unexported fields
}

API is the http server responsible for serving the HTTP API endpoints

func New(token string) *API

New is a factory function creating a new API instance

func (api *API) RegisterFunc(path string, fn http.HandlerFunc)

RegisterFunc is a wrapper around http.HandleFunc that also sets the flag used to determine whether to launch the API

func (api *API) RegisterHandler(path string, handler http.Handler)

RegisterHandler is a wrapper around http.Handler that also sets the flag used to determine whether to launch the API

func (api *API) RequireToken(fn http.HandlerFunc) http.HandlerFunc

RequireToken is wrapper around http.HandleFunc that checks token validity

func (api *API) Start(block bool) error

Start the API and serve over HTTP. Requires an API Token to be set.

Path	Synopsis
metrics Package metrics exposes the Prometheus /v1/metrics HTTP handler.	Package metrics exposes the Prometheus /v1/metrics HTTP handler.
update Package update exposes the HTTP handler for the /v1/update API endpoint.	Package update exposes the HTTP handler for the /v1/update API endpoint.