API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Create or update a policy

put
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/policies/

A firewall policy identified by a unique name. Each policy
contains an ordered set of rules that match traffic and
apply actions. ACL-type rules (RULE_ACL_IP, RULE_ACL_IPV6,
RULE_ACL_MAC) are only permitted in POLICY_NETWORK_ACL
policies.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

Unique name of the policy. This is a required key field.
Maximum 145 characters. On AOS-CX, space (' ') and
question mark ('?') characters are not supported in
policy names.

Query Params
string

LOCAL - To create local objects. SHARED - To create shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be created. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be created. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

policybody object

Grouping for security policy configuration within a policy.
Contains the rule list, policy-level metadata, and optional
features like CALEA and URL redirection.

security-policy
object

Security policy configuration for this policy. Contains the
policy type, ordered list of rules, and optional features
such as CALEA lawful intercept and URL redirection.

string
enum
Defaults to ASSOCIATION_ROLE

Specifies how this policy is associated with clients or
interfaces. Defaults to ASSOCIATION_ROLE (role-based
policy assignment).

Show Details
ASSOCIATION_INTERFACEInterface-based policy.
ASSOCIATION_ROLERole-based policy.
Allowed:
string
length between 1 and 256

A user-defined description or comment for this policy.
Maximum 256 characters.

boolean
Defaults to false

Enable distributed services firewall (DSF) for this policy.
When enabled, the policy type must be POLICY_TYPE_SECURITY.
Applicable to AOS-CX switches only. Defaults to false.

string
length between 1 and 145

Unique name of the policy. This is a required key field.
Maximum 145 characters. On AOS-CX, space (' ') and
question mark ('?') characters are not supported in
policy names.

string
enum

Type of policy. Determines the rule structure and actions
available. If dsf-enable is true, the type must be
POLICY_TYPE_SECURITY.

Show Details
POLICY_MIRRORMirror policy type.
POLICY_NETWORK_ACLNetwork Access Control List policy type.
POLICY_PBRPolicy Based Routing type.
POLICY_QOSQuality of Service policy type.
POLICY_TYPE_SECURITYSecurity policy type
Allowed:
Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?