HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/acl_object_groups/{ACL_Object_Group.name},{ACL_Object_Group.object_type}

Path Params
string
required

Reference Resource: ACL_Object_Group
Name of the ACL Object Group.

string
enum
required

Reference Resource: ACL_Object_Group
Type of ACL Object Group indicating which kind of entries it contains. If the type is 'ipv4' or 'ipv6', the port attributes are ignored. If the type is 'l4port', the address attributes are ignored.

Allowed:
Body Params
cfg_addresses
object

List of IP addresses configured by the user: IPv4 format (A.B.C.D/W.X.Y.Z) IPv6 format (A:B::C:D/W:X::Y:Z) If an invalid format is used via REST, it will be accepted. Verify configurations are valid by checking for error log messages and configuration warnings in CLI. An empty column value indicates that no match criteria is specified for this list.

cfg_ports
object

List of ports that are currently programmed in the data path. The sequence number is used for indexing but does not affect packet handling behavior. An empty column value indicates that no match criteria is specified for this list.

int64
-9007199254740991 to 9007199254740991

The version of 'cfg_addresses' or 'cfg_ports' which should be changed to a random value each time 'cfg_addresses' or 'cfg_ports' are modified. An empty column value will indicate that the user does not want the system to process this configuration yet.

vsx_sync
array of strings
length ≤ 9223372036854776000

Controls which attributes should be synchronized between VSX peers. 'all_attributes_and_dependents': the entire address group should be synchronized. This column value should be empty when system should not synchronize attributes between VSX peers.

vsx_sync
Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language
Response
Click Try It! to start a request and see the response here!