HomeGuidesAPI Reference
API Reference

Set the external IP/mask allow list

Replaces the entire external IP allow list with the provided array of subnet entries. Controls which external IP addresses can access this Orchestrator. Supports IPv4 (e.g., '10.0.0.0/8') and IPv6 (e.g., '2001:db8::/32') CIDR notation. In container/cloud mode, RFC1918 private addresses (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) are rejected. Pass an empty array to remove all entries.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Array of IpWhitelist objects defining allowed external subnets. Each entry requires a subnet in CIDR notation. Replaces all existing entries.

Responses
204

Successfully updated the external IP allow list. No content returned.

401

Unauthorized - User lacks READ_WRITE role permission.

403

Forbidden - Authentication required or session expired.

500

Internal Server Error - Failed to save configuration to database.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain