HomeGuidesAPI Reference
API Reference

Replace an existing ACL service group

Replaces an existing ACL service group with new configuration. The service group must already exist; use POST to create new groups. Validates group name (max 64 chars, alphanumeric with dots/underscores/hyphens), protocol settings, port formats, and nesting rules (max 2 levels).

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

Complete service group object to replace the existing one. The name field must match an existing group.

ACL service group object that defines protocol and port combinations for use in access control policies.

string
required
length ≥ 1

Unique identifier for the service group. Used to reference this group in ACL rules.

string
enum
required
Defaults to SG

Type identifier for this ACL group object. Must be 'SG' for service groups.

Allowed:
rules
array of objects
required
length ≥ 1

Array of service group rules defining protocol, port, and group configurations.

rules*

Defines protocol and port combinations for a service group rule. Supports TCP, UDP, ICMP, and ICMPV6 protocols.

string
enum
required
Defaults to TCP

Network protocol type. Determines which fields are applicable.

Allowed:
includedPorts
array of strings
Defaults to []

Ports to include in this rule. Supports single ports (e.g., '80') and ranges (e.g., '8080-8090'). Ignored for ICMP/ICMPV6.

includedPorts
excludedPorts
array of strings
Defaults to []

Ports to exclude from this rule. Supports single ports and ranges. Ignored for ICMP/ICMPV6.

excludedPorts
includedGroups
array of strings
Defaults to []

Other service group names to include in this rule. Enables nested group definitions. Ignored for ICMP/ICMPV6.

includedGroups
excludedGroups
array of strings
Defaults to []

Service group names to exclude from this rule. Ignored for ICMP/ICMPV6.

excludedGroups
icmpTypes
array of strings
Defaults to []

ICMP type codes to include. Only used when protocol is ICMP or ICMPV6. Common types: 0 (Echo Reply), 8 (Echo Request).

icmpTypes
icmpCodes
array of strings
Defaults to []

ICMP codes for a specific ICMP type. Only used when protocol is ICMP/ICMPV6. Specify only one ICMP type when using codes.

icmpCodes
string
required

User-defined description explaining the purpose of this rule.

Responses
204

Service group updated successfully. No content returned.

404

Service group not found. The group must exist to be updated via PUT.

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