Skip to content
Uplinkr

GET /settings/iam-alive

Endpoint

Section titled “Endpoint”
GET /api/v1/settings/iam-alive

Description

Section titled “Description”

Returns the current global I’m alive settings document.

Example Request

Section titled “Example Request”
Terminal window
curl -X GET http://localhost/api/v1/settings/iam-alive \
  -H "X-Uplinkr-Api-Key: replace-me-with-a-long-random-key"

Example Response

Section titled “Example Response”
{
  "data": {
    "enabled": true,
    "interval_hours": 6,
    "channels": ["mail", "webhook"]
  }
}

Status Codes

Section titled “Status Codes”
  • 200 Settings returned
  • 401 Missing or invalid API key