Skip to main content
POST
/
core
/
device
/
checkin
curl -X POST https://acusight.io/api/device/checkin \
  -H "X-Device-Key: adk_x9y8z7w6v5u4..." \
  -H "Content-Type: application/json" \
  -d '{
    "status": "healthy",
    "metrics": {
      "cpu_usage": 45.2,
      "memory_usage": 62.1,
      "disk_usage": 34.5,
      "temperature": 52.0,
      "uptime": 86400
    }
  }'

{
  "success": true,
  "data": {
    "actions": [
      {
        "id": "act_123456",
        "type": "deploy",
        "payload": {
          "stack_id": "my-stack",
          "compose_file": "..."
        },
        "created_at": "2024-01-15T10:30:00Z"
      }
    ]
  }
}
Reports device health status and receives any pending actions. Edge agents should call this periodically (e.g., every 30 seconds) to maintain heartbeat and receive commands.
This endpoint uses Device API Key authentication via the X-Device-Key header, not bearer token authentication.

​
Authentication

Include the device API key in the X-Device-Key header: 
X-Device-Key: adk_<your-api-key>

​
Request Body

​
status
string
Device health status (e.g., “healthy”, “degraded”, “error”)
​
metrics
object
Key-value pairs of device metrics

​
Response

​
actions
array
Array of pending actions for the device to execute
curl -X POST https://acusight.io/api/device/checkin \
  -H "X-Device-Key: adk_x9y8z7w6v5u4..." \
  -H "Content-Type: application/json" \
  -d '{
    "status": "healthy",
    "metrics": {
      "cpu_usage": 45.2,
      "memory_usage": 62.1,
      "disk_usage": 34.5,
      "temperature": 52.0,
      "uptime": 86400
    }
  }'

{
  "success": true,
  "data": {
    "actions": [
      {
        "id": "act_123456",
        "type": "deploy",
        "payload": {
          "stack_id": "my-stack",
          "compose_file": "..."
        },
        "created_at": "2024-01-15T10:30:00Z"
      }
    ]
  }
}