Cradlepoint · Schema

Cradlepoint NCM Alert

A generated alert in NetCloud Manager. Mirrors the payload pushed to alert_push_destinations and the response returned from /api/v2/alerts/.

Wireless WAN5GLTEEdgeBranch NetworkingSD-WANSASERoutersIn-VehicleIoTCellularPrivate 5GNetCloudEricsson

Properties

Name	Type	Description
id	string
account	string
router	string
group	stringnull
type	string	Alert type identifier, e.g. router_offline, signal_degraded, config_changed, subscription_expiring, threshold_breach.
message	string
severity	string
details	object	Free-form contextual payload (signal samples, config diff, threshold values).
created_at	string
acknowledged_at	stringnull
acknowledged_by	stringnull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cradlepoint/main/json-schema/cradlepoint-alert-schema.json",
  "title": "Cradlepoint NCM Alert",
  "description": "A generated alert in NetCloud Manager. Mirrors the payload pushed to alert_push_destinations and the response returned from /api/v2/alerts/.",
  "type": "object",
  "required": ["id", "account", "type", "created_at"],
  "properties": {
    "id": { "type": "string" },
    "account": { "type": "string" },
    "router": { "type": "string" },
    "group": { "type": ["string", "null"] },
    "type": {
      "type": "string",
      "description": "Alert type identifier, e.g. router_offline, signal_degraded, config_changed, subscription_expiring, threshold_breach."
    },
    "message": { "type": "string" },
    "severity": {
      "type": "string",
      "enum": ["info", "warning", "error", "critical"]
    },
    "details": {
      "type": "object",
      "additionalProperties": true,
      "description": "Free-form contextual payload (signal samples, config diff, threshold values)."
    },
    "created_at": { "type": "string", "format": "date-time" },
    "acknowledged_at": { "type": ["string", "null"], "format": "date-time" },
    "acknowledged_by": { "type": ["string", "null"] }
  }
}