MOR API v2 whitelisted ips

From Kolmisoft Wiki
Jump to navigationJump to search

Manage GUI whitelist rows (not IP-authenticated device rows from mor_ipauth_whitelist.txt) via MOR API v2. Behaviour matches Security → Monitorings → Whitelisted IPs in the GUI: the same validation rules apply (single IP, CIDR, or range; up to about 125 addresses per range). Changes take up to about one minute to apply on servers.

All endpoints require a valid Bearer token, accountant monitorings_manage (read for list, write for create/update/delete), and the matching v2_whitelisted_ips_* API method permission.

These endpoints do not enforce Restrict API access by IP on themselves (so you can configure allow rules while restriction is on). Other v2 routes still enforce client IP when restriction is enabled.



Quick start

  1. List active and pending whitelist rows

curl -s -H "Authorization: Bearer $TOKEN" \ 

 "https://your-mor.example/api/v2/whitelisted_ips?search_ip=203.0.113.&from=1&max_results=50"
  1. Whitelist a subnet and allow API access (auto-adds caller IP if needed)

curl -s -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \ 

 -d '{"ip":"198.51.100.0/24","server_id":1,"api_access_allowed":true}' \
 "https://your-mor.example/api/v2/whitelisted_ips"



Endpoints

Method Path Permission Description
GET /whitelisted_ips v2_whitelisted_ips_index List rows. Query: search_ip, search_reason (SQL LIKE), from, max_results. Response includes meta.caller_ip.
POST /whitelisted_ips v2_whitelisted_ips_create Add whitelist row(s). Body: ip (required), server_id or "all", optional reason (default MOR-WHITELIST-API), api_access_allowed (default false). All IP×server pairs must validate or nothing is saved (422 + failed[]). When api_access_allowed is true, the server may auto-create a row for the API client IPv4 with reason MOR-WHITELIST-API-AUTO (meta.caller_ip_ensured).
PATCH /whitelisted_ips/{id} v2_whitelisted_ips_update Set api_access_allowed on an active row (unblock == 3). Auto-ensure on enable matches POST.
DELETE /whitelisted_ips/{id} v2_whitelisted_ips_destroy Remove an active row (pending remove). Pending add/remove rows return 422.



JSON fields (list item)

  • id, ip, server_id, server_label, reason
  • api_access_allowed (boolean)
  • status: active, pending_add, pending_remove



Client IP behind a proxy

Auto-ensure and meta.caller_ip use the Rails client IP (request.remote_ip). If MOR sits behind a reverse proxy, ensure the proxy forwards the real client address (for example X-Forwarded-For) so auto-ensure matches the integrator’s egress IP.



See also

Retrieved from "https://wiki.kolmisoft.com/index.php?title=MOR_API_v2_whitelisted_ips&oldid=31636"