Docs for api endpoints

[8ball030]

Hi i was just wondering if there are any docs for the endpoints exposed

[TwiN]

There's this from the README https://github.com/TwiN/gatus#api, but the rest is only available through the code.

All endpoints are defined here:

gatus/controller/handler/handler.go

Lines 34 to 48 in f6e7e34

	// Endpoints
	unprotected.Handle("/v1/config", ConfigHandler{securityConfig: cfg.Security}).Methods("GET")
	protected.HandleFunc("/v1/endpoints/statuses", EndpointStatuses(cfg)).Methods("GET")
	protected.HandleFunc("/v1/endpoints/{key}/statuses", EndpointStatus).Methods("GET")
	unprotected.HandleFunc("/v1/endpoints/{key}/health/badge.svg", HealthBadge).Methods("GET")
	unprotected.HandleFunc("/v1/endpoints/{key}/uptimes/{duration}/badge.svg", UptimeBadge).Methods("GET")
	unprotected.HandleFunc("/v1/endpoints/{key}/response-times/{duration}/badge.svg", ResponseTimeBadge(cfg)).Methods("GET")
	unprotected.HandleFunc("/v1/endpoints/{key}/response-times/{duration}/chart.svg", ResponseTimeChart).Methods("GET")
	// Misc
	router.Handle("/health", health.Handler().WithJSON(true)).Methods("GET")
	// SPA
	router.HandleFunc("/endpoints/{name}", SinglePageApplication(cfg.UI)).Methods("GET")
	router.HandleFunc("/", SinglePageApplication(cfg.UI)).Methods("GET")
	// Everything else falls back on static content
	staticFileSystem, err := fs.Sub(static.FileSystem, static.RootPath)

But I assume the one you're interested in is the /api/v1/endpoints/statuses endpoint, which returns a slice (array) of EndpointStatus structs, whose definition can be found at

gatus/core/endpoint_status.go

Lines 6 to 28 in f6e7e34

	type EndpointStatus struct {
	// Name of the endpoint
	Name string `json:"name,omitempty"`
	// Group the endpoint is a part of. Used for grouping multiple endpoints together on the front end.
	Group string `json:"group,omitempty"`
	// Key is the key representing the EndpointStatus
	Key string `json:"key"`
	// Results is the list of endpoint evaluation results
	Results []*Result `json:"results"`
	// Events is a list of events
	Events []*Event `json:"events,omitempty"`
	// Uptime information on the endpoint's uptime
	//
	// Used by the memory store.
	//
	// To retrieve the uptime between two time, use store.GetUptimeByKey.
	Uptime *Uptime `json:"-"`
	}

If you want an actual example of the body, see https://status.twin.sh/api/v1/endpoints/statuses

[8ball030]

Yo,
That was exactly what I needed. Thanks so much for your help.

This is an amazing project btw. Super light and snappy and love the config language.

I'm working with a dynamic config map, how would you usually trigger a refresh of the container in this case?

[TwiN]

Gatus should automatically pick up the change after 30ish seconds by default.

See https://github.com/TwiN/gatus#reloading-configuration-on-the-fly

It doesn't work on every platform though. Where are you deploying Gatus?

[8ball030]

It however does work on mine!

[8ball030]

running typhoon on aws ec2 boxes