Documentation ¶
Index ¶
Constants ¶
View Source
const (
HealthStatusPath = "/health/status"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Handler ¶
type Handler struct { Metrics *metrics.MetricsManager H *herodot.JSONWriter W firewall.Firewall ResourcePrefix string }
func (*Handler) Health ¶
func (h *Handler) Health(rw http.ResponseWriter, r *http.Request, _ httprouter.Params)
swagger:route GET /health/status health getInstanceStatus
Check health status of this instance ¶
This endpoint returns `{ "status": "ok" }`. This status let's you know that the HTTP server is up and running. This status does currently not include checks whether the database connection is up and running. This endpoint does not require the `X-Forwarded-Proto` header when TLS termination is set.
Be aware that if you are running multiple nodes of ORY Hydra, the health status will never refer to the cluster state, only to a single instance.
Responses: 200: healthStatus 500: genericError
func (*Handler) PrefixResource ¶ added in v0.10.0
func (*Handler) SetRoutes ¶
func (h *Handler) SetRoutes(r *httprouter.Router)
Click to show internal directories.
Click to hide internal directories.