Skip to main content

Query Prefix Set (v3.1)

POST 

https://api.sase.paloaltonetworks.com/sdwan/v3.1/api/prefixes/query

Query the prefix set.

Request

Body

Query Details for prefixes

    aggregate Aggregate

    The aggregate number of prefix sets that match the query parameters.

    data AggregateData[]

    The details of the aggregate data.

  • Array [
  • valuenumber

    Value of the aggregate data.

    viewobject

    View the aggregate date.

  • ]
  • fieldstring

    The field value.

    namestring

    The name of the query response.

    operatorstring

    The operator values.

    Possible values: [max, count, min, avg, sum]

    statisticstring

    The aggregate statistics.

    unitstring

    The unit.

    dest_pageint32

    The destination page.

    geinteger
    getDeletedboolean

    The number prefix sets deleted for a time frame.

    group_bystring[]

    Group the prefix sets for the query.

    idstring

    List the prefix sets by ID.

    ipv4_prefixstring

    Ipv4 Prefix

    ipv6_prefixstring

    Ipv6 Prefix

    last_query_tsint64

    Return the ID of a specified query in the current session.

    leinteger
    limitint32

    The query limit.

    next_queryobject

    The limit.

    query_paramsobject

    Query using query parameters.

    retrieved_fieldsstring[]

    Retrieve information from a field.

    retrieved_fields_maskboolean

    List the fields to query.

    sort_paramsobject

    Specify the order in which you want the search criteria to display.

    total_countint64

    The total number of query parameters.

Responses

Successful Operation

Schema
    countint32

    The actual count.

    deleted_countint64

    The deleted number.

    deleted_idsstring[]

    The deleted IDs.

    description

    Description of the query. Max size = 256.

    idstring

    The ID.

    next_queryobject

    Details of the next query.

    total_countint64

    Total number.

    items PrefixQueryFilterV3N1[]
  • Array [
  • element_idstring

    The element ID.

    ipv4_prefixstring

    The IPv4 address prefix.

    ipv6_prefixstring

    The IPv6 address prefix.

    resource_idstring

    The resource ID.

    resource_typestring

    The resource type.

    Possible values: [static_route, interface, lan_network, BGP]

    scopestring

    The prefix scope.

    Possible values: [GLOBAL, LOCAL]

    site_idstringrequired

    The site ID.

  • ]
curl -L 'https://api.sase.paloaltonetworks.com/sdwan/v3.1/api/prefixes/query' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"aggregate": {
"data": [
{
"value": 0,
"view": {}
}
],
"field": "string",
"name": "string",
"operator": "max",
"statistic": "string",
"unit": "string"
},
"dest_page": 0,
"ge": 0,
"getDeleted": true,
"group_by": [
"string"
],
"id": "string",
"ipv4_prefix": "string",
"ipv6_prefix": "string",
"last_query_ts": 0,
"le": 0,
"limit": 0,
"next_query": {},
"query_params": {},
"retrieved_fields": [
"string"
],
"retrieved_fields_mask": true,
"sort_params": {},
"total_count": 0
}'
Request Collapse all
Base URL
https://api.sase.paloaltonetworks.com
Body
{
  "aggregate": {
    "data": [
      {
        "value": 0,
        "view": {}
      }
    ],
    "field": "string",
    "name": "string",
    "operator": "max",
    "statistic": "string",
    "unit": "string"
  },
  "dest_page": 0,
  "ge": 0,
  "getDeleted": true,
  "group_by": [
    "string"
  ],
  "id": "string",
  "ipv4_prefix": "string",
  "ipv6_prefix": "string",
  "last_query_ts": 0,
  "le": 0,
  "limit": 0,
  "next_query": {},
  "query_params": {},
  "retrieved_fields": [
    "string"
  ],
  "retrieved_fields_mask": true,
  "sort_params": {},
  "total_count": 0
}
ResponseClear

Click the Send API Request button above and see the response here!