| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
ORYHydra.API.Metadata
Description
Operations
Metadata
getVersion
getVersion :: ORYHydraRequest GetVersion MimeNoContent GetVersion200Response MimeJSON Source #
GET /version
Return Running Software Version.
This endpoint returns the version of Ory Hydra. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the version will never refer to the cluster state, only to a single instance.
data GetVersion Source #
Instances
| Produces GetVersion MimeJSON Source # | application/json |
Defined in ORYHydra.API.Metadata | |
isAlive
isAlive :: ORYHydraRequest IsAlive MimeNoContent HealthStatus MimeJSON Source #
GET /health/alive
Check HTTP Server Status
This endpoint returns a HTTP 200 status code when Ory Hydra is accepting incoming HTTP requests. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
isReady
isReady :: ORYHydraRequest IsReady MimeNoContent IsReady200Response MimeJSON Source #
GET /health/ready
Check HTTP Server and Database Status
This endpoint returns a HTTP 200 status code when Ory Hydra is up running and the environment dependencies (e.g. the database) are responsive as well. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be 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.