System heartbeat

POST /systems/heartbeat
Basic auth

System heartbeat endpoint to track system liveness (every 10 minutes)

application/json

Body Required

  • system_id string Required

    System ID sending the heartbeat

Responses

  • 200 application/json

    Heartbeat acknowledged

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object
      Hide data attributes Show data attributes object
      • system_id string

        System ID

      • acknowledged boolean

        Whether heartbeat was acknowledged

      • last_heartbeat string(date-time)

        Timestamp of this heartbeat
  • 400 application/json

    Bad request - validation error

    Hide response attributes Show response attributes object
    • code integer

      HTTP error code

    • message string

      Error message

    • data object
      Hide data attributes Show data attributes object
      • type string

        Type of error

        Values are validation_error or external_api_error.

      • errors array[object]
        Hide errors attributes Show errors attributes object
        • key string

          Field name that failed validation

        • message string

          Error code or message

        • value string

          Value that failed validation

      • details

        Additional error details
  • 401 application/json

    Unauthorized - invalid or missing token

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 403 application/json

    Forbidden - insufficient permissions

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 500 application/json

    Internal server error

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
POST /systems/heartbeat 
curl \
 --request POST 'https://collect.your-domain.com/api/systems/heartbeat' \
 --user "username:password" \
 --header "Content-Type: application/json" \
 --data '{"system_id":"4cf3053f-d0d5-4b10-b752-ff8f7b63c2f7"}'
Request examples 
{
  "system_id": "4cf3053f-d0d5-4b10-b752-ff8f7b63c2f7"
}
Response examples (200) 
{
  "code": 200,
  "message": "heartbeat acknowledged",
  "data": {
    "system_id": "4cf3053f-d0d5-4b10-b752-ff8f7b63c2f7",
    "acknowledged": true,
    "last_heartbeat": "2025-07-21T10:25:00Z"
  }
}
Response examples (400) 
{
  "code": 400,
  "message": "validation failed",
  "data": {
    "type": "validation_error",
    "errors": [
      {
        "key": "username",
        "message": "required",
        "value": "string"
      }
    ]
  }
}
Response examples (401) 
{
  "code": 401,
  "message": "invalid token",
  "data": {}
}
Response examples (403) 
{
  "code": 403,
  "message": "insufficient permissions",
  "data": {}
}
Response examples (500) 
{
  "code": 500,
  "message": "internal server error",
  "data": {}
}