API Reference

https://your-server.cmdop.dev/api/v1

# Include the API key as a Bearer token in the Authorization header
curl https://your-server.cmdop.dev/api/v1/sessions \
  -H "Authorization: Bearer cmdop_apikey_..."

{
  "data": { ... },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-02-14T10:30:00Z"
  }
}

{
  "data": {
    "session_id": "sess_abc123",
    "status": "CONNECTED"
  }
}

{
  "error": {
    "code": "session_not_found",
    "message": "Session not found",
    "details": {
      "session_id": "sess_invalid"
    }
  }
}

X-RateLimit-Limit: 1000        # Max requests per window
X-RateLimit-Remaining: 999     # Requests remaining
X-RateLimit-Reset: 1707903600  # Unix timestamp when limit resets

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded",
    "details": {
      "retry_after": 60
    }
  }
}

# Paginate with limit (page size) and offset (skip count)
curl "https://your-server.cmdop.dev/api/v1/sessions?limit=10&offset=0"

{
  "data": [...],
  "meta": {
    "total": 45,
    "limit": 10,
    "offset": 0,
    "has_more": true
  }
}

# Filter by status
curl "https://your-server.cmdop.dev/api/v1/sessions?status=CONNECTED"
 
# Filter by machine
curl "https://your-server.cmdop.dev/api/v1/sessions?machine_hostname=prod-server"
 
# Multiple filters
curl "https://your-server.cmdop.dev/api/v1/sessions?status=CONNECTED&machine_hostname=prod-server"

# Sort by created date (descending)
curl "https://your-server.cmdop.dev/api/v1/sessions?sort=-created_at"
 
# Sort by hostname (ascending)
curl "https://your-server.cmdop.dev/api/v1/machines?sort=hostname"