Servers
Create Firewall Rule
Creates a new firewall rule on the server. Synchronous — runs InstallFirewall over SSH inline and returns the new row at 201. Idempotent on (name, port, ip_address). Requires the write:servers…
Delete Firewall Rule
Disables the rule on the server (DisableFirewall over SSH) then deletes the row. Synchronous. Requires the write:servers scope.
Enable Firewall Rule
Marks the rule active and runs InstallFirewall over SSH. Synchronous. Requires the write:servers scope.
Disable Firewall Rule
Marks the rule inactive and runs DisableFirewall over SSH. Synchronous. Requires the write:servers scope.
Whitelist xCloud Infrastructure IPs
Adds (or extends) the "xCloud Infrastructure" rule so xCloud jumpbox, API, backup, and monitoring IPs can reach the server's SSH port. Safe to call repeatedly — already-present IPs are not…
Whitelist Caller IP
Whitelists the API caller's current IP address on the server's SSH firewall. Useful before tightening SSH access rules so the caller does not lock themselves out. Requires the write:servers scope.
Get SSH Restriction Status
Returns whether xCloud infrastructure IPs are whitelisted and whether the API caller's IP is whitelisted on the server's SSH firewall. Use before any rule-tightening operation to check for lockout risk.…
List Banned IP Addresses
Returns IP addresses currently banned by fail2ban on the server. Runs synchronously over SSH. Requires the read:servers scope and the server:manage-fail2ban permission.
Ban IP Addresses
Bans one or more IP addresses via fail2ban. Runs synchronously over SSH. Up to 100 IPs per call. Requires the write:servers scope and the server:manage-fail2ban permission.
Unban IP Address
Unbans a single IP address via fail2ban. Runs synchronously over SSH. Requires the write:servers scope and the server:manage-fail2ban permission.
