IP Camera API Reference PRO

https://<device-ip>:8443

curl -k https://192.168.1.100:8443/status

Authorization: Bearer <token>

curl -k -X POST https://192.168.1.100:8443/auth \
  -H "Content-Type: application/json" \
  -d '{"password": "your_password"}'

{
  "success": true,
  "token": "a1b2c3d4e5f6...",
  "csrfToken": "g7h8i9j0k1l2..."
}

{
  "success": false,
  "error": "Invalid password"
}

{
  "success": false,
  "error": "Too many attempts",
  "lockout": true,
  "lockoutRemaining": 30
}

{
  "enabled": true,
  "configured": true
}

{
  "success": true
}

{
  "subject": "CN=IP Camera, O=Local Network, C=US",
  "issuer": "CN=IP Camera, O=Local Network, C=US",
  "notBefore": 1707000000000,
  "notAfter": 1738536000000,
  "serialNumber": "a1b2c3d4e5f6",
  "status": "valid",
  "downloadUrl": "/cert"
}

curl -k -X POST -H "Authorization: Bearer YOUR_TOKEN" \
  https://192.168.1.100:8443/cert/regenerate

{
  "success": true
}

{
  "success": true,
  "token": "a1b2c3d4e5f6...",
  "csrfToken": "g7h8i9j0k1l2..."
}

X-CSRF-Token: g7h8i9j0k1l2...

curl -X POST https://192.168.1.100:8443/settings \
  -H "Cookie: session=..." \
  -H "X-CSRF-Token: your_csrf_token" \
  -H "Content-Type: application/json" \
  -d '{"frameRate": 30}'

{
  "error": "Invalid CSRF token"
}

{
  "error": "HTTPS required",
  "httpsPort": 8443
}

location /ipcamera/ {
    proxy_pass https://192.168.1.100:8443/;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header Host $host;
    proxy_ssl_verify off;
}

<img src="https://192.168.1.100:8443/stream?token=YOUR_TOKEN" />

curl -k "https://192.168.1.100:8443/snapshot?token=YOUR_TOKEN" -o snapshot.jpg

curl -k -H "Authorization: Bearer YOUR_TOKEN" https://192.168.1.100:8443/settings

{
  "resolution": "1280x720",
  "frameRate": 30,
  "jpegQuality": 85,
  "cameraId": "0",
  "torchEnabled": false,
  "audioEnabled": true,
  "rotation": 0,
  "keepScreenOn": true,
  "showPreview": true,
  "motionEnabled": true,
  "motionSensitivity": 5,
  "soundEnabled": false,
  "rtspEnabled": false,
  "mqttEnabled": false,
  "license": {
    "isPro": true,
    "state": "ACTIVE"
  }
}

curl -k -X POST https://192.168.1.100:8443/settings \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"resolution": "1920x1080", "frameRate": 20}'

{
  "license": {
    "isPro": true,
    "state": "ACTIVE",
    "source": "REAL_PURCHASE",
    "billing": {
      "available": true,
      "status": "CONNECTED"
    }
  }
}

{
  "clients": 2,
  "wsClients": 1,
  "streaming": true,
  "cameraRunning": true,
  "settings": { ... }
}

{
  "cameraIds": ["0", "1"],
  "resolutions": ["1280x720", "1920x1080"],
  "frameRates": [15, 20, 30, 60],
  "maxFrameRate": 60
}

curl -k -X POST -H "Authorization: Bearer YOUR_TOKEN" \
  "https://192.168.1.100:8443/torch"

{
  "torchEnabled": true
}

{
  "enabled": true,
  "running": true,
  "port": 8554,
  "path": "/stream",
  "clients": 2
}

{
  "rtspPort": 8554,
  "rtspPath": "/stream",
  "rtspUsername": "admin",
  "rtspPassword": "secret"
}

{
  "rtspPort": 8554,
  "rtspPath": "/stream",
  "rtspUsername": "admin",
  "rtspPassword": "secret"
}

{
  "success": true
}

ffmpeg -rtsp_transport tcp -i rtsp://192.168.1.100:8554/stream -f null -

vlc rtsp://192.168.1.100:8554/stream

{
  "enabled": true,
  "connected": true,
  "brokerUrl": "192.168.1.100",
  "port": 1883,
  "topicPrefix": "ipcamera"
}

{
  "mqttEnabled": true,
  "mqttBrokerUrl": "192.168.1.100",
  "mqttPort": 1883,
  "mqttTopicPrefix": "ipcamera"
}

{
  "currentPassword": "existing_password",
  "settings": {
    "mqttEnabled": true,
    "mqttBrokerUrl": "192.168.1.100",
    "mqttPort": 1883,
    "mqttUsername": "newuser",
    "mqttPassword": "newpass",
    "mqttClientId": "ipcamera-001",
    "mqttTopicPrefix": "ipcamera",
    "mqttUseTls": false,
    "mqttAcceptSelfSigned": false,
    "mqttTelemetryIntervalSec": 60,
    "mqttCommandsEnabled": false
  }
}

{
  "success": true
}

{
  "error": "Current password required for credential changes"
}

curl -k -H "Authorization: Bearer YOUR_TOKEN" \
  "https://192.168.1.100:8443/events?since=0&type=MOTION"

{
  "serverNow": 1234567890000,
  "dayStart": 1234483200000,
  "events": [
    {
      "id": 1,
      "eventId": 1001,
      "timestamp": 1234567890000,
      "type": "MOTION",
      "changedPercent": 12.5,
      "width": 1280,
      "height": 720
    },
    {
      "id": 2,
      "eventId": 1002,
      "timestamp": 1234567891000,
      "type": "ANY_SOUND",
      "db": -25.5,
      "rms": 0.45
    },
    {
      "id": 3,
      "eventId": 1003,
      "timestamp": 1234567892000,
      "type": "DOG_BARK",
      "className": "Dog",
      "confidence": 92
    },
    {
      "id": 4,
      "eventId": 1004,
      "timestamp": 1234567893000,
      "type": "OBJECT_PERSON",
      "objectClass": "person",
      "confidence": 85,
      "eventType": "appeared"
    }
  ],
  "summary": [
    { "type": "MOTION", "count": 5, "lastTimestamp": 1234567890000 },
    { "type": "ANY_SOUND", "count": 3, "lastTimestamp": 1234567891000 },
    { "type": "DOG_BARK", "count": 2, "lastTimestamp": 1234567892000 },
    { "type": "OBJECT_PERSON", "count": 1, "lastTimestamp": 1234567893000 }
  ]
}

{
  "buckets": [
    {
      "timestamp": 1699200000000,
      "counts": {
        "MOTION": 5,
        "ANY_SOUND": 3,
        "DOG_BARK": 1
      }
    },
    {
      "timestamp": 1699200060000,
      "counts": {
        "MOTION": 2
      }
    }
  ],
  "bucketMs": 60000,
  "timeRange": {
    "start": 1699200000000,
    "end": 1699203600000
  }
}

curl -k -H "Authorization: Bearer YOUR_TOKEN" \
  "https://192.168.1.100:8443/events/range"

{
  "minTimestamp": 1234567000000,
  "maxTimestamp": 1234567890000,
  "totalEvents": 1523
}

curl -k -X POST -H "Authorization: Bearer YOUR_TOKEN" \
  "https://192.168.1.100:8443/events/clear?confirm=true"

{
  "success": true,
  "cleared": 1523
}

curl -k -H "Authorization: Bearer YOUR_TOKEN" \
  "https://192.168.1.100:8443/api/storage/stats"

{
  "databaseSize": "2.5 MB",
  "databaseSizeBytes": 2621440,
  "totalEvents": 1990,
  "motionEvents": 1200,
  "soundEvents": 328,
  "eventsByType": {
    "MOTION": 1200,
    "ANY_SOUND": 300,
    "DOG_BARK": 23,
    "BABY_CRY": 5,
    "OBJECT_PERSON": 450,
    "OBJECT_DOG": 12
  },
  "minTimestamp": 1234567000000,
  "maxTimestamp": 1234567890000,
  "deviceStorageTotal": "64.0 GB",
  "deviceStorageAvailable": "32.5 GB",
  "deviceStorageTotalBytes": 68719476736,
  "deviceStorageAvailableBytes": 34896609280
}

curl -k -H "Authorization: Bearer YOUR_TOKEN" \
  "https://192.168.1.100:8443/api/events/export" \
  -o ip-camera-events.csv

wss://192.168.1.100:8443/ws?token=YOUR_TOKEN

{"type": "connected", "authenticated": true, "timestamp": 1234567890000}

{"type": "auth_required", "timestamp": 1234567890000}

{"type": "auth", "token": "your_auth_token"}

{"type": "setting", "key": "resolution", "value": "1920x1080"}

{"type": "error", "message": "Authentication required"}

{"error": "Description of the error"}

{
  "error": "Pro license required",
  "feature": "rtsp_streaming",
  "hint": "Access this feature through the web dashboard or upgrade to Pro"
}

{
  "success": false,
  "errors": [
    "unknownKey: Unknown setting",
    "frameRate: Value must be between 1 and 60"
  ]
}

{
  "success": false,
  "error": "Too many attempts",
  "lockout": true,
  "lockoutRemaining": 30
}

curl -k https://192.168.1.100:8443/cert -o ipcamera.pem