All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| GetInstanceMetrics | Get /health/metrics | Show instance metrics (experimental) |
| GetInstanceStatus | Get /health/status | Check health status of this instance |
GetInstanceMetrics()
Show instance metrics (experimental)
This endpoint returns an instance's metrics, such as average response time, status code distribution, hits per second and so on. The return values are currently not documented as this endpoint is still experimental. The subject making the request needs to be assigned to a policy containing: { \"resources\": [\"rn:hydra:health:stats\"], \"actions\": [\"get\"], \"effect\": \"allow\" }
This endpoint does not need any parameter.
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse200 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.
This endpoint does not need any parameter.
No authorization required
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]