Skip to content
Open app

health

GET /api/v1/health. No authentication.

CLI 0.4.0 · MCP · API v1View as Markdown
GET /docs/reference/api/operations/health.mdtext/markdown
GET
/api/v1/health
Code sample: Shell / cURL
curl --request GET \
--url https://app.intraface.cc/api/v1/health

No authentication.

Success.

Media typeapplication/json
object
ok
required
boolean
service
required
string
Allowed values: app usercontent
version
required
string
db
required
string
Allowed values: up down
time
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/

Example

{
"ok": true,
"service": "app",
"db": "up"
}

Any error: see error.code.

Media typeapplication/json
object
error
required
object
code
required

A stable error code: see the error codes table in the API overview.

string
message
required
string
hint
string
details

Example generated

{
"error": {
"code": "example",
"message": "example",
"hint": "example",
"details": "example"
}
}