RoleFilesAPI reference
Health check
Check whether the application can respond to HTTP requests.
GET /api/v1/health
Returns process availability. No authentication, query parameters, or request body are required.
curl --fail http://localhost:3000/api/v1/healthUse the origin of your running application. The documentation hostname,
docs.rolefiles.com, does not serve API requests.
Response
Status: 200 OK
Content type: application/json
{ "status": "ok" }| Field | Type | Value |
|---|---|---|
status | string | "ok" |
This endpoint does not query the database or any job source. A successful response is not a guarantee that other services are ready.