Developer API
Status API
Programmatically check system status, component health, and subscribe to incident notifications. Build status awareness into your applications.
Current Status
API
Core valuation API
operational
Dashboard
Web console
operational
Webhooks
Event delivery
operational
Batch Processing
Bulk operations
operational
Authentication
OAuth & API keys
operational
CDN
Edge caching
operational
API Endpoints
| Endpoint | Method | Description |
|---|---|---|
| /api/v1/status | GET | Overall system status |
| /api/v1/components | GET | All component statuses |
| /api/v1/components/:id | GET | Specific component details |
| /api/v1/incidents | GET | Recent incidents |
| /api/v1/incidents/:id | GET | Incident details with timeline |
| /api/v1/subscriptions | POST | Subscribe to status webhooks |
Examples
Get System Status
// Check overall system status
const response = await fetch('https://status.justkalm.com/api/v1/status');
const status = await response.json();
console.log(status);
// {
// "status": "operational",
// "updated_at": "2024-12-10T15:30:00Z",
// "components": [
// { "id": "api", "name": "API", "status": "operational" },
// { "id": "webhooks", "name": "Webhooks", "status": "operational" },
// ...
// ]
// }Component Status
// Check specific component status
const response = await fetch('https://status.justkalm.com/api/v1/components/api');
const component = await response.json();
// Response includes uptime metrics
// {
// "id": "api",
// "name": "API",
// "status": "operational",
// "uptime_day": 100.0,
// "uptime_week": 99.98,
// "uptime_month": 99.95,
// "response_time_ms": 145
// }Get Incidents
// Get recent incidents
const response = await fetch('https://status.justkalm.com/api/v1/incidents?limit=5');
const { incidents } = await response.json();
// Each incident includes timeline
// {
// "incidents": [
// {
// "id": "inc_abc123",
// "title": "Elevated API Latency",
// "status": "resolved",
// "impact": "minor",
// "created_at": "2024-12-09T10:00:00Z",
// "resolved_at": "2024-12-09T10:45:00Z",
// "updates": [
// { "status": "investigating", "message": "...", "timestamp": "..." },
// { "status": "identified", "message": "...", "timestamp": "..." },
// { "status": "resolved", "message": "...", "timestamp": "..." }
// ]
// }
// ]
// }Subscribe to Webhooks
// Subscribe to status webhooks
const response = await fetch('https://status.justkalm.com/api/v1/subscriptions', {
method: 'POST',
headers: {
'Authorization': 'Bearer jk_live_xxx',
'Content-Type': 'application/json',
},
body: JSON.stringify({
endpoint: 'https://your-app.com/webhooks/status',
events: [
'incident.created',
'incident.updated',
'incident.resolved',
'component.status_changed',
'maintenance.scheduled',
],
})
});Webhook Events
incident.created
New incident reported
incident.updated
Incident status or message updated
incident.resolved
Incident marked as resolved
component.status_changed
Component status changed
maintenance.scheduled
New maintenance window scheduled
maintenance.started
Scheduled maintenance began
maintenance.completed
Maintenance window ended
Use Cases
Dashboard Widgets
Display JustKalm status in your internal dashboards. Show component health alongside your own services.
Alerting Integration
Route incident webhooks to Slack, PagerDuty, or Opsgenie. Get notified before your users report issues.
Circuit Breakers
Automatically pause API calls during outages. Queue requests and retry when service is restored.
Stay Informed
Subscribe to status updates or integrate the API into your monitoring stack.