Skip to content

Errors

API errors use:

json
{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Readable message",
    "detail": {}
  }
}

Common groups:

  • Auth: AUTH_REQUIRED, AUTH_SETUP_REQUIRED, AUTH_FAILED, ADMIN_PASSWORD_INVALID, INVALID_TOKEN, TOKEN_EXPIRED.
  • Source guard: PUBLIC_HOST_REJECTED, PUBLIC_ORIGIN_REJECTED.
  • Download: DOWNLOAD_TOKEN_REQUIRED, INVALID_DOWNLOAD_TOKEN, DOWNLOAD_TOKEN_SCOPE_MISMATCH.
  • Config and node: CONFIG_NOT_FOUND, CONFIG_NAME_EXISTS, NODE_NOT_FOUND, NODE_DISABLED, NODE_CONFIG_MISMATCH.
  • Mesh: INVALID_PEER_LINK, PEER_LINK_NOT_FOUND, TOPOLOGY_INVALID.
  • Quick Mesh: INVALID_QUICK_MESH_MODE, QUICK_MESH_GATEWAY_REQUIRED, QUICK_MESH_NODE_UNASSIGNED.
  • AWG: INVALID_AWG_PARAMETER, INVALID_AWG_H_RANGE, INVALID_AWG_J_RANGE.
  • MQTT: MQTT_DISABLED, MQTT_TLS_CA_NOT_READY, MQTT_CONTROL_UNAVAILABLE.
  • Snapshot: SNAPSHOT_NOT_FOUND, SNAPSHOT_INVALID_ARCHIVE, SNAPSHOT_PASSWORD_INVALID.
  • MCP: MCP_TOKEN_PERMISSION_INVALID, MCP_TOKEN_EXPIRY_INVALID, MCP_AUDIT_RANGE_INVALID.