Documentation

OpsDeck Docs

Everything you need to set up monitoring, configure alerts, and run load tests.

Quick Start

OpsDeck is a fully managed synthetic monitoring platform. You add your endpoints through our dashboard or API, and we handle the rest — no SDK to install, no agent to deploy.

1. Create an account

Sign up at opsdeck.pages.dev/login. Free tier includes 3 endpoints and 1 region.

2. Add your first check

Use the dashboard or API to add an endpoint. Specify the URL, HTTP method, optional request body, and which regions to test from.

terminal
curl -X POST https://api.opsdeck.io/v1/checks \
  -H "Authorization: Bearer opsdeck_sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://api.yourapp.com/health",
    "method": "GET",
    "regions": ["SIN", "CGK"],
    "user_agent": "mobile",
    "frequency": "*/1 * * * *"
  }'

3. View results

Results are available immediately. Check response times, uptime percentage, and status codes from the dashboard or API.

terminal
curl https://api.opsdeck.io/v1/checks/chk_abc123/results?period=24h \
  -H "Authorization: Bearer opsdeck_sk_..."

Load Testing

Load tests are available on Pro and Enterprise plans. They let you simulate traffic spikes and find your API's breaking point before your users do.

terminal
curl -X POST https://api.opsdeck.io/v1/load-tests \
  -H "Authorization: Bearer opsdeck_sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://api.yourapp.com/login",
    "method": "POST",
    "body": {"phone": "08123456789"},
    "concurrent": 100,
    "duration": 60,
    "ramp_up": 10
  }'

Authentication

All API requests require a Bearer token. Generate API keys from your dashboard under Settings → API Keys.

terminal
# All requests require this header:
-H "Authorization: Bearer opsdeck_sk_..."

# Your API key starts with "opsdeck_sk_"
# Keep it secret. Never expose it in client-side code.