Misc
Authen exposes some miscellaneous APIs for verifying the health (ping) and retrieving information (info) about the system.
Ping
Returns ok if Authen is working properly. This is an endpoint that a health-check would want to monitor. Callers can either use the status code (200) or the basic response.
GET /v1/ping
- Response
- Sample Request
- Sample Response
- Errors
| name | type | desc |
|---|---|---|
ok | bool | Should always be |
curl "http://127.0.0.1:5200/v1/ping"{"ok":true}The general error section details Authen's error responses as well as detailing all errors, including global errors, such as validation and internal server errors.
Info
Returns information about the system. The information included in the response is not sensitive and should be included in any bug reports.
GET /v1/info
- Response
- Sample Request
- Sample Response
- Errors
| name | type | desc |
|---|---|---|
go | string | The version of Go used to build the system. |
commit | string | The commit hash. |
storage.type | string | The storage engine being used. |
storage.migration | int | The version of the migrations being used. |
curl "http://127.0.0.1:5200/v1/info"{
"go": "go1.19",
"commit": "ba4242b5bddacb39e4c1d9cdaa34f4a5fccbdbea",
"storage": {
"migration": 1,
"type": "postgres"
}
}The general error section details Authen's error responses as well as detailing all errors, including global errors, such as validation and internal server errors.