Create Policy Set (v3.0)

POST 
/v3.0/api/tenants/:tenant_id/policysets

Create a new policy set.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Details of the policy set to be created

bandwidth_allocation_schemes BandwidthAllocationScheme[]required
Allocate or modify the percentage of bandwidth configured for each priority and application traffic type. Can configure up to four bandwidth allocation schemes.
Array [
bandwidth_range BandwidthRange
The details of the bandwidth range.
high double
The high range of the bandwidth allocated.
low double
The low range of the bandwidth allocated.
business_priorities BusinessPriority[]
Information on the business priorities.
Array [
bandwidth_allocation double
The bandwidth allocated.
bandwidth_split_per_type BandwidthSplit
The bandwidth split per type.
bulk double
Bulk
rt_audio double
Rt Audio
rt_video double
Rt Video
transactional double
Transactional
priority_num int32
The priority number.
]
]
business_priority_names BusinessPriorityNameMapper[]required
The list of business priority names. Max size = 4.
Array [
priority_name string
The business priority name.
priority_num int32
The business priority number.
]
clone_from string

The existing policy for cloning the policy set.

default_policy boolean

The default policy.

description

The description of the policy set.

id string

The policy set ID.

name stringrequired

The name of the policy set. Max size = 128.

policy_stance string

Possible values: [CONSERVATIVE, STANDARD, OPTIMUM]

The policy stance is pre-defined. The security policy set populates automatically with the default policy rules (self-zone, default, and intra-zone) and cannot be edited.

Responses

200

Successful Operation

application/json

Schema

Schema

bandwidth_allocation_schemes BandwidthAllocationScheme[]required
Allocate or modify the percentage of bandwidth configured for each priority and application traffic type. Can configure up to four bandwidth allocation schemes.
Array [
bandwidth_range BandwidthRange
The details of the bandwidth range.
high double
The high range of the bandwidth allocated.
low double
The low range of the bandwidth allocated.
business_priorities BusinessPriority[]
Information on the business priorities.
Array [
bandwidth_allocation double
The bandwidth allocated.
bandwidth_split_per_type BandwidthSplit
The bandwidth split per type.
bulk double
Bulk
rt_audio double
Rt Audio
rt_video double
Rt Video
transactional double
Transactional
priority_num int32
The priority number.
]
]
business_priority_names BusinessPriorityNameMapper[]required
The list of business priority names. Max size = 4.
Array [
priority_name string
The business priority name.
priority_num int32
The business priority number.
]
default_policy boolean

The default policy.

description

The description of the policy set.

id string

The policy set ID.

name stringrequired

The name of the policy set. Max size = 128.

Example (from schema)

{
  "bandwidth_allocation_schemes": [
    {
      "bandwidth_range": {
        "high": 0,
        "low": 0
      },
      "business_priorities": [
        {
          "bandwidth_allocation": 0,
          "bandwidth_split_per_type": {
            "bulk": 0,
            "rt_audio": 0,
            "rt_video": 0,
            "transactional": 0
          },
          "priority_num": 0
        }
      ]
    }
  ],
  "business_priority_names": [
    {
      "priority_name": "string",
      "priority_num": 0
    }
  ],
  "default_policy": true,
  "id": "string",
  "name": "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": "SECURITY_POLICYSET_NAME_REQUIRED"
      },
      {
        "code": "SECURITY_POLICYSET_NAME_INVALID"
      },
      {
        "code": "SECURITY_POLICYSET_DESCRIPTION_INVALID"
      },
      {
        "code": "ONLY_POLICY_STANCE_OR_CLONE_FROM_CAN_BE_SET"
      },
      {
        "code": "CLONE_FROM_POLICYSET_DOES_NOT_EXIST"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "POLICY_SET_CONFIG_STANCE_OR_CLONE_FROM"
      },
      {
        "code": "POLICY_SET_CONFIG_DEFAULT_EXIST"
      }
    ]
  }
}

Loading...