Public API
Documentation for public API endpoints and usage
Public API Documentation
Welcome to the Jimster API documentation. This API provides access to various services and health monitoring endpoints.
Base URL: https://api.jimster.dev
All endpoints are public and do not require authentication.
Quick Start
Make your first request
Try the welcome endpoint to verify connectivity:
curl https://api.jimster.dev/Check API health
Monitor the overall health of the API:
curl https://api.jimster.dev/healthExplore V1 endpoints
Access version 1 specific features:
curl https://api.jimster.dev/v1/API Endpoints
Root Endpoint
GET /
Welcome message and API information
Returns a welcome message with basic API information.
Request:
curl https://api.jimster.dev/const response = await fetch('https://api.jimster.dev/');
const data = await response.json();
console.log(data);import requests
response = requests.get('https://api.jimster.dev/')
data = response.json()
print(data)Response:
{
"status": "ok",
"message": "Welcome to the API, please refer to the documentation for usage details. (or just chill here)"
}Health Check
GET /health
General API health status
Returns the general health status of the API. For detailed service-level health information, use the V1 health endpoint.
Request:
curl https://api.jimster.dev/healthconst response = await fetch('https://api.jimster.dev/health');
const data = await response.json();
console.log(data);import requests
response = requests.get('https://api.jimster.dev/health')
data = response.json()
print(data)Response:
{
"status": "ok",
"message": "API is healthy, for individual service status, please check the /{version}/health endpoint."
}For detailed service-level monitoring, use the /v1/health endpoint.
Version 1 API
V1 Root Endpoint
GET /v1/
Welcome message for V1 API
Returns a welcome message specific to the V1 API.
Request:
curl https://api.jimster.dev/v1/const response = await fetch('https://api.jimster.dev/v1/');
const data = await response.json();
console.log(data);import requests
response = requests.get('https://api.jimster.dev/v1/')
data = response.json()
print(data)Response:
{
"status": "ok",
"message": "Welcome to the API (V1), please refer to the documentation for usage details. (or just chill here)"
}V1 Health Check
GET /v1/health
Detailed health status with service monitoring
Returns comprehensive health information including the status of all monitored services.
Request:
curl https://api.jimster.dev/v1/healthconst response = await fetch('https://api.jimster.dev/v1/health');
const data = await response.json();
console.log(data);import requests
response = requests.get('https://api.jimster.dev/v1/health')
data = response.json()
print(data)Response:
{
"status": "ok",
"message": "API V1 is healthy.",
"services": [
{
"name": "main-site",
"status": "UP",
"uptime": "100"
},
{
"name": "public-api",
"status": "UP",
"uptime": "100"
},
{
"name": "time-keeper",
"status": "UP",
"uptime": "100"
},
{
"name": "invoice-manager",
"status": "UP",
"uptime": "100"
},
{
"name": "system-monitor",
"status": "UP",
"uptime": "100"
},
{
"name": "git-repos",
"status": "UP",
"uptime": "100"
},
{
"name": "docuseal",
"status": "UP",
"uptime": "100"
},
{
"name": "coolify",
"status": "UP",
"uptime": "100"
}
],
"last_updated": "2026-01-30T11:29:04.409288Z"
}Response Fields:
status- Overall API health statusmessage- Human-readable status messageservices- Array of monitored servicesname- Service identifierstatus- Current service status (UPorDOWN)uptime- Service uptime percentage
last_updated- ISO 8601 timestamp of last health check
All services are currently operational with 100% uptime!
Monitored Services
main-site
Primary website hosting
public-api
Public API service
time-keeper
Time tracking service
invoice-manager
Invoice management system
system-monitor
Infrastructure monitoring
git-repos
Git repository hosting
docuseal
Document signing service
coolify
Deployment platform
Response Format
All API responses follow a consistent JSON format:
- Success responses include a
statusfield set to"ok" - Error responses include appropriate HTTP status codes and error messages
- All timestamps are in ISO 8601 format
This API does not require authentication for the documented endpoints. Future versions may introduce authenticated endpoints.