Skip to main content
GET
API root endpoint
curl --request GET \
  --url https://api.example.com/
{
  "name": "Uptime Monitor API",
  "version": "1.0.0",
  "status": "running",
  "documentation": "/api",
  "health": "/health",
  "timestamp": "2024-01-10T12:00:00Z"
}

Response

200 - application/json

API information

​
name
string
Example:

"Uptime Monitor API"

​
version
string
Example:

"1.0.0"

​
status
string
Example:

"running"

​
documentation
string
Example:

"/api"

​
health
string
Example:

"/health"

​
timestamp
string
Example:

"2024-01-10T12:00:00Z"