Skip to main content

​
Base URL

All API requests should be made to: 
https://kodostatus.com/api/v1

​
Authentication

Authenticate requests using the X-API-Key header: 
curl "https://kodostatus.com/api/v1/incidents" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json"

Get Your API Key

Generate an API key from your dashboard

​
Response Format

All responses are returned in JSON format: 
{
  "id": "uuid",
  "title": "Example Incident",
  "status": "investigating",
  "created_at": "2024-01-15T10:30:00Z"
}

​
Error Handling

Errors return appropriate HTTP status codes with a JSON body: 
{
  "error": "Invalid API key",
  "code": "UNAUTHORIZED"
}
Status CodeDescription
200Success
201Created
400Bad Request
401Unauthorized
404Not Found
429Rate Limited
500Server Error

​
Rate Limits

Endpoint TypeLimit
Standard1,000 requests/minute
Heartbeat10,000 requests/minute
BeaconUnlimited
Rate limit headers are included in responses: 
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1704844800

​
API Categories

Incidents

Create and manage incidents

Services

Manage status page services

Uptime Monitors

HTTP endpoint monitoring

Heartbeat

Monitor background jobs

Notifications

Configure alert channels

Webhooks

Receive real-time events