Create Security Policy Rules under Policy Set (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/ngfwsecuritypolicysets/:policy_set_id/ngfwsecuritypolicyrules

Create a security policy V2 rule under a policy set.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

policy_set_id stringrequired

ID of the security policy v2 set.

application/json

Body

action stringrequired

The action taken for traffic matching this rule. It determine how the traffic from the specified source zone to the specified destination zone should respond.

app_def_ids string[]

The number of app definition IDs that have applied security policy rules. Maximum 16 applications can be specified in a rule.

description

The description of the security policy rule. Max size = 256.

destination_prefix_ids string[]

The destination prefix IDs. Max list of prefix IDs is 16.

destination_zone_ids string[]

The destination zone IDs. Max list of zone IDs is 16.

enabled booleanrequired

The security policy rules based on rules that are enabled.

id string

The security policy rule ID.

name stringrequired

The name of the security policy rule. Max size = 128.

services Service[]
The details of the source and destination ports along with the protocol used..
Array [
destination_ports PortRange[]
The start and end port for Port Ranges. A maximum of 16 port ranges is allowed, and port ranges can only be added for TCP or UDP protocols.
Array [
from integer
The start port of the destination/source port range.
to integer
The end port of the destination/source port range.
]
protocol int32
The protocol type (TCP, or UDP, or TLS).
source_ports PortRange[]
The start value of the port range. A maximum of 16 port ranges are allowed, and port ranges can only be added for TCP or UDP protocols.
Array [
from integer
The start port of the destination/source port range.
to integer
The end port of the destination/source port range.
]
]
source_prefix_ids string[]

The source prefix IDs. Max list of IDs is 16.

source_zone_ids string[]

The source zone IDs. Max list of IDs is 16.

tags string[]

A information field that can be added to identify the security policy rule. Maximum 10 unique tags of length 1024 each are allowed.

Responses

200

Successful Operation

application/json

Schema

Schema

action stringrequired

The action taken for traffic matching this rule. It determine how the traffic from the specified source zone to the specified destination zone should respond.

app_def_ids string[]

The number of app definition IDs that have applied security policy rules. Maximum 16 applications can be specified in a rule.

description

The description of the security policy rule. Max size = 256.

destination_prefix_ids string[]

The destination prefix IDs. Max list of prefix IDs is 16.

destination_zone_ids string[]

The destination zone IDs. Max list of zone IDs is 16.

enabled booleanrequired

The security policy rules based on rules that are enabled.

id string

The security policy rule ID.

name stringrequired

The name of the security policy rule. Max size = 128.

services Service[]
The details of the source and destination ports along with the protocol used..
Array [
destination_ports PortRange[]
The start and end port for Port Ranges. A maximum of 16 port ranges is allowed, and port ranges can only be added for TCP or UDP protocols.
Array [
from integer
The start port of the destination/source port range.
to integer
The end port of the destination/source port range.
]
protocol int32
The protocol type (TCP, or UDP, or TLS).
source_ports PortRange[]
The start value of the port range. A maximum of 16 port ranges are allowed, and port ranges can only be added for TCP or UDP protocols.
Array [
from integer
The start port of the destination/source port range.
to integer
The end port of the destination/source port range.
]
]
source_prefix_ids string[]

The source prefix IDs. Max list of IDs is 16.

source_zone_ids string[]

The source zone IDs. Max list of IDs is 16.

tags string[]

A information field that can be added to identify the security policy rule. Maximum 10 unique tags of length 1024 each are allowed.

Example (from schema)

{
  "action": "string",
  "app_def_ids": [
    "string"
  ],
  "destination_prefix_ids": [
    "string"
  ],
  "destination_zone_ids": [
    "string"
  ],
  "enabled": true,
  "id": "string",
  "name": "string",
  "services": [
    {
      "destination_ports": [
        {
          "from": 0,
          "to": 0
        }
      ],
      "protocol": 0,
      "source_ports": [
        {
          "from": 0,
          "to": 0
        }
      ]
    }
  ],
  "source_prefix_ids": [
    "string"
  ],
  "source_zone_ids": [
    "string"
  ],
  "tags": [
    "string"
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_JSON_INPUT"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      }
    ]
  }
}

Loading...