Quick Start

1. Create Your Status Page

https://kodostatus.com/status/your-slug

2. Add Services

Add the services and components you want to display on your status page. Navigate to Dashboard > Services and click Add Service.

{
  "name": "API Gateway",
  "description": "Main API service",
  "status": "operational"
}

3. Get Your API Key

Go to Dashboard > API to generate an API key. You’ll use this to authenticate API requests.

4. Install the CLI

Manage everything from the terminal — and treat your setup as code.

npm install -g kodo-cli
kodo login YOUR_API_KEY

kodo init      # scaffold a kodo.yaml + SDK snippet for your framework
kodo apply     # provision services / monitors / status pages from kodo.yaml
kodo diff      # preview drift vs. remote, like `terraform plan`

Watch your platform live — errors and incidents as they happen:

kodo tail                  # stream everything
kodo tail --errors -e production

Drop kodo apply into CI to keep monitoring in sync with your repo. Full reference: kodo --help.

5. Create Your First Incident

CLI
API
Dashboard

kodo incidents create \
  --title "Investigating API Issues" \
  --status investigating \
  --severity major \
  --services "API Gateway"

curl -X POST "https://kodostatus.com/api/v1/incidents" \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Investigating API Issues",
    "status": "investigating",
    "severity": "major",
    "services": ["API Gateway"]
  }'

6. Set Up Monitoring

Add uptime monitors to automatically check your endpoints:

kodo monitors create \
  --name "API Health Check" \
  --url "https://api.example.com/health" \
  --interval 300

Next Steps

Configure Notifications

Set up Slack, Discord, or email alerts

API Reference

Explore the full API

Heartbeat Monitoring

Monitor background jobs and workers

Beacon SDK

Track client-side errors

Getting Started

Status Management

Monitoring

Alerting

Automation

Notifications

Client Tracking

Integrations

1. Create Your Status Page

2. Add Services

3. Get Your API Key

4. Install the CLI

5. Create Your First Incident

6. Set Up Monitoring

Next Steps

Configure Notifications

API Reference

Heartbeat Monitoring

Beacon SDK

​1. Create Your Status Page

​2. Add Services

​3. Get Your API Key

​4. Install the CLI

​5. Create Your First Incident

​6. Set Up Monitoring

​Next Steps

Configure Notifications

API Reference

Heartbeat Monitoring

Beacon SDK

1. Create Your Status Page

2. Add Services

3. Get Your API Key

4. Install the CLI

5. Create Your First Incident

6. Set Up Monitoring

Next Steps