HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/policies

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
cfg_entries
object

Reference Resource: Policy_Entry
Policy entries as configured by the user. For a child Policy, the configured Policy entries are located in the parent Policy and this value is ignored. An empty column value indicates that no match criteria is specified for this list.

int64
-9007199254740991 to 9007199254740991

The version of 'cfg_entries' that should be changed to a random value each time 'cfg_entries' is modified. For a child Policy, the parent Policy's version of 'cfg_entries' is used and this value is ignored. An empty column value will indicate that the user does not want the system to process this configuration yet.

string
required
length between 1 and 64

Reference Resource: Policy
Name of a Classifier Policy (Policy).

string
enum

Origin of the Policy, i.e., how the Policy is provisioned: synthesized: Policy has been dynamically synthesized by the system. static : Policy is provisioned by the administrator via CLI or REST.

Allowed:
string

Reference Resource: Policy
For a child Policy, this is the reference to the configured parent Policy. The 'cfg_entries' and 'cfg_version' of the parent Policy will be used instead of the child Policy's. For a parent/standalone policy, this column should be empty.

routed_in_statistics_clear_requested
object

The number of times a request was made to clear the routed-in statistics for this Policy for each application type and VRF.

statistics_clear_requested
object

The number of times a request was made to clear the statistics for this Policy for each application type or 'all' application types.

string

Reference Resource: VRF
Indicates the specific VRF requested for the interfaces_routed_in_statistics or l3vnis_routed_in_statistics or vlans_routed_in_statistics on-demand query.

vsx_sync
array of strings
length ≤ 9223372036854776000

Controls which attributes should be synchronized between VSX peers. 'all_attributes_and_dependents': the entire policy and its entries should be synchronized. This column value should be empty when system should not synchronize attributes between VSX peers.

vsx_sync
Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!