Query Network Policy Set (v2.0)

POST 
/sdwan/v2.0/api/networkpolicysets/query

Query all the network policy sets.

Request

application/json

Body

Query details for Network Policy Set

clone_from string

The existing policy from Network Policies for cloning the policy set.

defaultrule_policyset boolean

The default rule for the policy set.

description

The description of the network policy set. Max size = 256.

id string

The network policy set ID.

name stringrequired

The name of the network policy set.

tags string[]

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

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

deleted_count int64

The deleted number.

deleted_ids string[]

The deleted IDs.

description

Description of the query. Max size = 256.

id string

The ID.

next_query object

Details of the next query.

total_count int64

Total number.

items NetworkPolicySetQueryFilter[]
Array [
clone_from string
The existing policy from Network Policies for cloning the policy set.
defaultrule_policyset boolean
The default rule for the policy set.
description
The description of the network policy set. Max size = 256.
id string
The network policy set ID.
name stringrequired
The name of the network policy set.
tags string[]
A information field that can be added to identify the network policy set. Maximum 10 unique tags of length 1024 each are allowed.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "total_count": 0,
  "items": [
    {
      "clone_from": "string",
      "defaultrule_policyset": true,
      "id": "string",
      "name": "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": "BAD_REQUEST"
      }
    ]
  }
}

Loading...