HomeGuidesAPI Reference
API Reference

Create or update an ACL address group

Creates a new address group or updates an existing one if the name matches. If the group exists, performs an update; otherwise creates a new group. Address groups define IP address collections for use in ACL security policies.

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

Address group object to create or update

ACL address group object that defines a collection of IP addresses for use in security policies.

string
required
length ≥ 1

Unique identifier for the address group. Used to reference this group in ACL rules and other groups.

rules
array of objects
required
length ≥ 1

Array of address group rules defining IP inclusions, exclusions, and group references.

rules*

Defines IP address inclusions, exclusions, and group references for an address group rule.

string
required

User-defined description for this rule. Helps identify the purpose of this rule.

excludedIPs
array of strings
Defaults to []

List of IP addresses or CIDR ranges to exclude from this rule. Supports IPv4/IPv6 addresses and CIDR notation.

excludedIPs
includedGroups
array of strings
Defaults to []

List of other address group names to include in this rule. Enables nested group definitions.

includedGroups
includedIPs
array of strings
Defaults to []

List of IP addresses or CIDR ranges to include in this rule. Supports IPv4/IPv6 addresses and CIDR notation.

includedIPs
string
enum
required
Defaults to AG

Type identifier for this ACL group object. Must be set to 'AG' for address groups.

Allowed:
Responses
204

Address group created or updated successfully. No content returned.

500

Internal server error during address group creation or update.

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