HomeGuidesAPI Reference
API Reference

Create or update Security Policies for a segment map

Creates or updates zone-based firewall security policies for a specific segment-to-segment traffic flow. Policies define rules for allowing or denying traffic between routing segments based on matching criteria. Validates that both segment IDs and all zone IDs in the policies exist. Changes trigger orchestration to all managed appliances.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+_\d+$

Segment map identifier in format 'sourceSegmentId_destinationSegmentId'. Specifies the source and destination routing segments for which to create/update security policies. Both segment IDs must reference existing segments.

string

Optional audit log comment for tracking changes. Appears in system action logs with prefix 'Audit Log Comment'.

Body Params

Security policies configuration containing firewall rules. The 'data' field is required and contains zone-to-zone policies keyed by 'map1'. Rules are prioritized by numeric key (lower = higher priority). Valid actions are 'allow' and 'deny'.

Security policies configuration for zone-based firewall rules between routing segments.

data
object
required

Required. Contains zone-to-zone security policies keyed by 'map1'.

options
object

Options controlling how policies are applied during orchestration.

settings
object

Logging settings for security policy events.

Responses
204

Successfully created or updated security policies. Changes queued for orchestration to all appliances.

401

Unauthorized. User lacks READ_WRITE permission to modify security policies.

500

Internal server error. Failed to save security policies to database.

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