StatusShield API Docs

# You can also configure Telegram via API
curl -X POST https://api.statusshield.app/v1/alerts/telegram \
  -H "Authorization: Bearer ss_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{ "chat_id": "123456789", "events": ["monitor.down", "monitor.up"] }'

# Configure Slack via API
curl -X POST https://api.statusshield.app/v1/alerts/slack \
  -H "Authorization: Bearer ss_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "webhook_url": "https://hooks.slack.com/services/T00/B00/xxxx",
    "channel": "#ops-alerts",
    "events": ["monitor.down", "monitor.up", "incident.created"]
  }'

# In Claude Code, ask it to check your monitors:
# "Check if my production API is healthy"

# Claude Code can run this for you:
curl -s https://api.statusshield.app/v1/monitors \
  -H "Authorization: Bearer $STATUSSHIELD_API_KEY" | jq '.data[] | {name, status, uptime_7d}'

# Or create an incident after a failed deployment:
curl -X POST https://api.statusshield.app/v1/incidents \
  -H "Authorization: Bearer $STATUSSHIELD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Deployment rollback - v2.3.1",
    "status": "investigating",
    "impact": "minor",
    "message": "Rolling back due to elevated error rates."
  }'

# .github/workflows/deploy.yml
name: Deploy & Verify

on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Deploy to production
        run: ./deploy.sh

      - name: Wait for deployment
        run: sleep 30

      - name: Check StatusShield monitors
        env:
          SS_API_KEY: ${{ secrets.STATUSSHIELD_API_KEY }}
        run: |
          STATUS=$(curl -sf \
            -H "Authorization: Bearer $SS_API_KEY" \
            https://api.statusshield.app/v1/monitors/mon_abc123 \
            | jq -r '.data.status')

          if [ "$STATUS" != "up" ]; then
            echo "Monitor is $STATUS - deployment may have issues"
            exit 1
          fi
          echo "Monitor is UP - deployment verified"

      - name: Create incident on failure
        if: failure()
        env:
          SS_API_KEY: ${{ secrets.STATUSSHIELD_API_KEY }}
        run: |
          curl -X POST \
            -H "Authorization: Bearer $SS_API_KEY" \
            -H "Content-Type: application/json" \
            https://api.statusshield.app/v1/incidents \
            -d '{
              "title": "Deployment issue - COMMIT_SHA",
              "status": "investigating",
              "impact": "major",
              "message": "Automated: Post-deploy health check failed."
            }'

# List all monitors
curl -s https://api.statusshield.app/v1/monitors \
  -H "Authorization: Bearer ss_live_your_api_key" | jq .

# Create a monitor
curl -X POST https://api.statusshield.app/v1/monitors \
  -H "Authorization: Bearer ss_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name":"My API","url":"https://api.example.com","type":"https","interval":60}'

# Get public status (no auth)
curl -s https://api.statusshield.app/v1/status/acme | jq .

# Create an incident
curl -X POST https://api.statusshield.app/v1/incidents \
  -H "Authorization: Bearer ss_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"title":"API Issue","status":"investigating","impact":"major","message":"Looking into it."}'

# Resolve an incident
curl -X PATCH https://api.statusshield.app/v1/incidents/inc_001 \
  -H "Authorization: Bearer ss_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"status":"resolved","message":"All clear."}'

# Pause a monitor
curl -X PATCH https://api.statusshield.app/v1/monitors/mon_abc123/pause \
  -H "Authorization: Bearer ss_live_your_api_key"

# Resume a monitor
curl -X PATCH https://api.statusshield.app/v1/monitors/mon_abc123/resume \
  -H "Authorization: Bearer ss_live_your_api_key"

import requests

API_KEY = "ss_live_your_api_key"
BASE = "https://api.statusshield.app/v1"
headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json",
}

# List all monitors
monitors = requests.get(f"{BASE}/monitors", headers=headers).json()
for m in monitors["data"]:
    print(f"{m['name']}: {m['status']} ({m['uptime_7d']}% uptime)")

# Create a new monitor
new_monitor = requests.post(f"{BASE}/monitors", headers=headers, json={
    "name": "Checkout Service",
    "url": "https://checkout.example.com/health",
    "type": "https",
    "interval": 60,
    "regions": ["us-east", "eu-west"],
}).json()
print(f"Created monitor: {new_monitor['data']['id']}")

# Create an incident
incident = requests.post(f"{BASE}/incidents", headers=headers, json={
    "title": "Payment Gateway Degraded",
    "status": "investigating",
    "impact": "major",
    "message": "Stripe webhook delivery is delayed.",
    "affected_monitors": ["mon_abc123"],
}).json()
print(f"Incident: {incident['data']['id']}")

# Resolve the incident
requests.patch(f"{BASE}/incidents/{incident['data']['id']}", headers=headers, json={
    "status": "resolved",
    "message": "Stripe confirmed resolution. All payments processing normally.",
})

# Get public status (no auth needed)
status = requests.get(f"{BASE}/status/acme").json()
print(f"Overall: {status['data']['overall_status']}")

const API_KEY = "ss_live_your_api_key";
const BASE = "https://api.statusshield.app/v1";

const headers = {
  Authorization: `Bearer ${API_KEY}`,
  "Content-Type": "application/json",
};

// List all monitors
const monitors = await fetch(`${BASE}/monitors`, { headers }).then(r => r.json());
monitors.data.forEach(m => {
  console.log(`${m.name}: ${m.status} (${m.uptime_7d}% uptime)`);
});

// Create a new monitor
const newMonitor = await fetch(`${BASE}/monitors`, {
  method: "POST",
  headers,
  body: JSON.stringify({
    name: "Checkout Service",
    url: "https://checkout.example.com/health",
    type: "https",
    interval: 60,
    regions: ["us-east", "eu-west"],
  }),
}).then(r => r.json());

console.log(`Created: ${newMonitor.data.id}`);

// Create an incident
const incident = await fetch(`${BASE}/incidents`, {
  method: "POST",
  headers,
  body: JSON.stringify({
    title: "CDN Cache Purge Issue",
    status: "investigating",
    impact: "minor",
    message: "Cache invalidation is taking longer than expected.",
    affected_monitors: ["mon_def456"],
  }),
}).then(r => r.json());

// Update incident to resolved
await fetch(`${BASE}/incidents/${incident.data.id}`, {
  method: "PATCH",
  headers,
  body: JSON.stringify({
    status: "resolved",
    message: "CDN cache purge completed successfully.",
  }),
});

// Get public status page data (no auth required)
const status = await fetch(`${BASE}/status/acme`).then(r => r.json());
console.log(`Status: ${status.data.overall_status}`);