HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. ipObjects

Create or update an ACL service group

post
http://127.0.0.1:8080/ipObjects/serviceGroup

Creates a new service group or updates an existing one if the name matches. Service groups define protocol and port combinations for use in ACL security policies. Supports TCP, UDP, ICMP, and ICMPV6 protocols with port ranges and nested group references.

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

Service group object to create or update. If a group with the same name exists, it will be updated.

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 created or updated successfully. No content returned.

Updated about 12 hours ago

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

Updated about 12 hours ago

Did this page help you?