Update Policy Rule (v3.1)
Update policy rule of a tenant.
Path Parameters
The tenant ID.
The policy set ID.
ID of the network policy rule.
Request Body
Details of the policy to be created
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
The app definition ID that have applied policy rules. The number of applications for a policy rule is limited to 256.
The description of the policy rule. Max size = 256.
The policy rule ID.
The name of the policy rule. Max size = 128.
The network context applied to the policy rule. Network context segments network traffic for the purpose of applying different policy rules for the same application.
paths_allowed PathsAllowed required
The paths allowed for the application.
active_paths WANPath[] required
The configured active path for the rule.
The label to identify the path.
Possible values: [vpn
, direct
, servicelink
]
The path type.
backup_paths WANPath[]
The configured backup path for the rule.
The label to identify the path.
Possible values: [vpn
, direct
, servicelink
]
The path type.
l3_failure_paths WANPath[]
The configured l3 failure path for the rule.
The label to identify the path.
Possible values: [vpn
, direct
, servicelink
]
The path type.
The priority number.
service_context ServiceContext[]
Information on the service context.
The configured active service label ID.
Possible values: [CG_TRANSIT
, NON_CG_TRANSIT
, SASE
]
The configured active service label type.
The configured backup service label ID.
Possible values: [CG_TRANSIT
, NON_CG_TRANSIT
, SASE
]
The configured backup service label type.
Possible values: [ALLOWED_TRANSIT
, REQUIRED_TRANSIT
]
The type of service context.
- 200
- 400
Successful Operation
Schema
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
The app definition ID that have applied policy rules. The number of applications for a policy rule is limited to 256.
The app definition name.
The default policy rule.
The policy rule description. Max size = 256.
Lists if the policy rule is disabled.
Reason the policy rule is disabled.
The policy rule ID.
Lists if the policy rule is inactive.
Reason the policy rule is inactive.
The LAN network IDs.
The name of the policy rule. Max size = 128.
The network context applied to the policy rule. Network context segments network traffic for the purpose of applying different policy rules for the same application.
paths_allowed PathsAllowed required
The paths allowed for the application.
active_paths WANPath[] required
The configured active path for the rule.
The label to identify the path.
Possible values: [vpn
, direct
, servicelink
]
The path type.
backup_paths WANPath[]
The configured backup path for the rule.
The label to identify the path.
Possible values: [vpn
, direct
, servicelink
]
The path type.
l3_failure_paths WANPath[]
The configured l3 failure path for the rule.
The label to identify the path.
Possible values: [vpn
, direct
, servicelink
]
The path type.
Policy Set Id
The priority number.
The region of the site.
service_context ServiceContext[]
Information on the service context.
The configured active service label ID.
Possible values: [CG_TRANSIT
, NON_CG_TRANSIT
, SASE
]
The configured active service label type.
The configured backup service label ID.
Possible values: [CG_TRANSIT
, NON_CG_TRANSIT
, SASE
]
The configured backup service label type.
Possible values: [ALLOWED_TRANSIT
, REQUIRED_TRANSIT
]
The type of service context.
site_paths_allowed SiteWanPath[]
The paths allowed for a site.
Wn Name
Possible values: [DIRECT_PUBLIC_WAN
, DIRECT_PRIVATE_WAN
, VPN_ON_PUBLIC_WAN
, VPN_ON_PRIVATE_WAN
]
Wp Type
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
{
"app_def_id": "string",
"app_def_name": "string",
"default_rule": true,
"disabled": true,
"disabled_reason": "string",
"id": "string",
"inactive": true,
"inactive_reason": "string",
"lan_network_ids": [
"string"
],
"name": "string",
"network_context_id": "string",
"paths_allowed": {
"active_paths": [
{
"label": "string",
"path_type": "vpn"
}
],
"backup_paths": [
{
"label": "string",
"path_type": "vpn"
}
],
"l3_failure_paths": [
{
"label": "string",
"path_type": "vpn"
}
]
},
"policy_set_id": "string",
"priority_num": 0,
"region": "string",
"service_context": [
{
"active_service_label_id": "string",
"active_service_label_type": "CG_TRANSIT",
"backup_service_label_id": "string",
"backup_service_label_type": "CG_TRANSIT",
"type": "ALLOWED_TRANSIT"
}
],
"site_paths_allowed": [
{
"wn_name": "string",
"wp_type": "DIRECT_PUBLIC_WAN"
}
],
"tenant_id": "string"
}
Bad Request
Schema
- Array [
- ]
_error ErrorResponse[]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_LAN_SEGMENTID"
}
]
}
}