Get
/v2.3/networks/{networkId}/policy
Required permissions: ["network:read"].
Security
HTTP
Type bearer
Path parameters
networkId
stringRequired
Responses
200
Completed successfully
object
enabled
boolean
whether the policy is enabled.
allowed
boolean
whether the policy is accept or drop.
id
ExampleZwAeo5wqiF
policyRules
Array of object (FirewallPolicyRule)
an array of policy rules.
object
id
name
string
Policy rule ID.
Min length5
Max length50
enabled
boolean
wether the rule is enabled.
allowed
boolean
wether the rule is enabled.
sources
object (SourcesAndDestinations)
OneOf
UsersAndGroups
object (UsersAndGroups)
users
Array of string (AlphanumericWithSpace)
List of IDs of users.
Min items1
Max items5
string
Any alphanumeric value with space
Min length1
Pattern^[a-zA-Z0-9 ]+$
groups
Array of string (AlphanumericWithSpace)
List of IDs of groups.
Min items1
string
Any alphanumeric value with space
Min length1
Pattern^[a-zA-Z0-9 ]+$
Addresses
object (Addresses)
addresses
Array of string (AlphanumericWithSpace)
List of IDs of address objects.
Min items1
string
Any alphanumeric value with space
Min length1
Pattern^[a-zA-Z0-9 ]+$
destinations
object (SourcesAndDestinations)
OneOf
UsersAndGroups
object (UsersAndGroups)
users
Array of string (AlphanumericWithSpace)
List of IDs of users.
Min items1
Max items5
string
Any alphanumeric value with space
Min length1
Pattern^[a-zA-Z0-9 ]+$
groups
Array of string (AlphanumericWithSpace)
List of IDs of groups.
Min items1
string
Any alphanumeric value with space
Min length1
Pattern^[a-zA-Z0-9 ]+$
Addresses
object (Addresses)
addresses
Array of string (AlphanumericWithSpace)
List of IDs of address objects.
Min items1
string
Any alphanumeric value with space
Min length1
Pattern^[a-zA-Z0-9 ]+$
services
Array of string
List of services objects IDs.
Min items1
string
Pattern^[a-zA-Z0-9_- ]+$
trace
boolean
whether the policy is traced.
401
Unauthorized
403
Forbidden
404
Network not found