PATCH /settings/iam-alive

Endpoint

PATCH /api/v1/settings/iam-alive

Description

Updates one or more I’m alive settings fields. If interval_hours or channels is sent without enabled, the API enables the feature automatically.

Request Body

Field	Type	Required	Description
enabled	boolean	No	Enable or disable I’m alive reporting
interval_hours	integer	No	Value from 1 to 24
channels	array	No	One or more of mail, log, webhook

Example Request

curl -X PATCH http://localhost/api/v1/settings/iam-alive \
  -H "Content-Type: application/json" \
  -H "X-Uplinkr-Api-Key: replace-me-with-a-long-random-key" \
  -d '{
    "enabled": true,
    "interval_hours": 6,
    "channels": ["mail", "webhook"]
  }'

Example Response

{
  "data": {
    "enabled": true,
    "interval_hours": 6,
    "channels": ["mail", "webhook"]
  }
}

Status Codes

• 200 Settings updated
• 401 Missing or invalid API key
• 422 Validation failed or no fields were provided