VPS_updateFirewallRuleV1
Modify a specific firewall rule on a virtual machine by updating protocol, port, and source details. Changes require manual sync for affected VMs.
Instructions
Update a specific firewall rule from a specified firewall.
Any virtual machine that has this firewall activated will lose sync with the firewall and will have to be synced again manually.
Use this endpoint to modify existing firewall rules.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| firewallId | Yes | Firewall ID | |
| port | Yes | Port or port range, ex: 1024:2048 | |
| protocol | Yes | protocol parameter | |
| ruleId | Yes | Firewall Rule ID | |
| source | Yes | source parameter | |
| source_detail | Yes | IP range, CIDR, single IP or `any` |
Input Schema (JSON Schema)
{
"properties": {
"firewallId": {
"description": "Firewall ID",
"type": "integer"
},
"port": {
"description": "Port or port range, ex: 1024:2048",
"type": "string"
},
"protocol": {
"description": "protocol parameter",
"enum": [
"TCP",
"UDP",
"ICMP",
"GRE",
"any",
"ESP",
"AH",
"ICMPv6",
"SSH",
"HTTP",
"HTTPS",
"MySQL",
"PostgreSQL"
],
"type": "string"
},
"ruleId": {
"description": "Firewall Rule ID",
"type": "integer"
},
"source": {
"description": "source parameter",
"enum": [
"any",
"custom"
],
"type": "string"
},
"source_detail": {
"description": "IP range, CIDR, single IP or `any`",
"type": "string"
}
},
"required": [
"firewallId",
"ruleId",
"protocol",
"port",
"source",
"source_detail"
],
"type": "object"
}
Implementation Reference
- types.d.ts:1475-1511 (schema)TypeScript interface definition (schema) for the 'VPS_updateFirewallRuleV1' tool in the APITools interface, detailing input parameters (firewallId, ruleId, protocol, port, source, source_detail) and generic response./** * Update a specific firewall rule from a specified firewall. Any virtual machine that has this firewall activated will lose sync with the firewall and will have to be synced again manually. Use this endpoint to modify existing firewall rules. */ "VPS_updateFirewallRuleV1": { params: { /** * Firewall ID */ firewallId: number; /** * Firewall Rule ID */ ruleId: number; /** * protocol parameter */ protocol: string; /** * Port or port range, ex: 1024:2048 */ port: string; /** * source parameter */ source: string; /** * IP range, CIDR, single IP or `any` */ source_detail: string; }; response: any; // Response structure will depend on the API };