List Public Policies

post /public_api/v1/policy/search

Public API to get all policies.

CLIENT REQUEST

          curl -X 'POST'

        -H
        'Accept: application/json'
      

        -H
        'Content-Type: application/json'
      

      'http://localhost/public_api/v1/policy/search'
    

      -d
      '{
  "filter" : {
    "AND" : [ null, null ]
  },
  "search_from" : "",
  "sort" : [ {
    "FIELD" : ""
  }, {
    "FIELD" : ""
  } ],
  "search_to" : ""
}'
    


      

import http.client

conn = http.client.HTTPSConnection("example.com")

payload = "{\"filter\":{\"AND\":[{\"AND\":[{}]}]},\"search_from\":0,\"search_to\":50,\"sort\":[{\"FIELD\":\"string\",\"ORDER\":\"ASC\"}]}"

headers = { 'content-type': "application/json" }

conn.request("POST", "//public_api/v1/policy/search", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://example.com//public_api/v1/policy/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\"filter\":{\"AND\":[{\"AND\":[{}]}]},\"search_from\":0,\"search_to\":50,\"sort\":[{\"FIELD\":\"string\",\"ORDER\":\"ASC\"}]}"

response = http.request(request)
puts response.read_body

const data = JSON.stringify({
  "filter": {
    "AND": [
      {
        "AND": [
          {}
        ]
      }
    ]
  },
  "search_from": 0,
  "search_to": 50,
  "sort": [
    {
      "FIELD": "string",
      "ORDER": "ASC"
    }
  ]
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://example.com//public_api/v1/policy/search");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

HttpResponse<String> response = Unirest.post("https://example.com//public_api/v1/policy/search")
  .header("content-type", "application/json")
  .body("{\"filter\":{\"AND\":[{\"AND\":[{}]}]},\"search_from\":0,\"search_to\":50,\"sort\":[{\"FIELD\":\"string\",\"ORDER\":\"ASC\"}]}")
  .asString();

import Foundation

let headers = ["content-type": "application/json"]
let parameters = [
  "filter": ["AND": [["AND": [[]]]]],
  "search_from": 0,
  "search_to": 50,
  "sort": [
    [
      "FIELD": "string",
      "ORDER": "ASC"
    ]
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://example.com//public_api/v1/policy/search")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://example.com//public_api/v1/policy/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"filter\":{\"AND\":[{\"AND\":[{}]}]},\"search_from\":0,\"search_to\":50,\"sort\":[{\"FIELD\":\"string\",\"ORDER\":\"ASC\"}]}",
  CURLOPT_HTTPHEADER => [
    "content-type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://example.com//public_api/v1/policy/search");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"filter\":{\"AND\":[{\"AND\":[{}]}]},\"search_from\":0,\"search_to\":50,\"sort\":[{\"FIELD\":\"string\",\"ORDER\":\"ASC\"}]}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://example.com//public_api/v1/policy/search");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"filter\":{\"AND\":[{\"AND\":[{}]}]},\"search_from\":0,\"search_to\":50,\"sort\":[{\"FIELD\":\"string\",\"ORDER\":\"ASC\"}]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Body parameters

required

application/json

filterobject

Filter for policies

Any of

ANDarray

[

Any of

ANDarray

[

Any of

ORarray

[

Any of

ORarray

[

Any of

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

Allowed values:"CONTAINS""NCONTAINS""CONTAINS_IN_LIST""NOT_CONTAINS_IN_LIST""WILDCARD""WILDCARD_NOT""EQ""NEQ""IS_EMPTY""NIS_EMPTY""RANGE""IN""NIN""RELATIVE_TIMESTAMP""JSON_WILDCARD""JSON_WILDCARD_NOT""ARRAY_CONTAINS""ARRAY_NOT_CONTAINS"

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

ORarray

[

Any of

ANDarray

[

Any of

ORarray

[

Any of

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

ORarray

[

Any of

ANDarray

[

Any of

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

ORarray

[

Any of

ANDarray

[

Any of

ANDarray

[

Any of

ORarray

[

Any of

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

ORarray

[

Any of

ANDarray

[

Any of

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

ORarray

[

Any of

ANDarray

[

Any of

ANDarray

[

Any of

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

search_frominteger

Start index for pagination

search_tointeger

End index for pagination

Default:50

sortarray

[

FIELDstring

ORDERstring (Enum)

Allowed values:"ASC""DESC"

]

REQUEST

{
  "filter": {
    "AND": [
      {
        "SEARCH_FIELD": "id",
        "SEARCH_TYPE": "CONTAINS",
        "SEARCH_VALUE": "b2b1279e-8760-44a8-8dca-bcc4508f8ce7"
      },
      {
        "SEARCH_FIELD": "name",
        "SEARCH_TYPE": "CONTAINS",
        "SEARCH_VALUE": "Cloud Posture Security"
      }
    ]
  },
  "search_from": 0,
  "search_to": 50,
  "sort": [
    {
      "FIELD": "name",
      "ORDER": "ASC"
    }
  ]
}

Responses

Successful Response

Body

application/json

dataarray

[

idstringuuid

namestring

descriptionobject

Any of

string

labelsobject

Any of

Array

rule_matching_typestring (Enum)

Allowed values:"RULE_FILTER""RULES""ALL_RULES"

associated_rule_filterobject

present if Rule Matching Type is RULE_FILTER

Any of

ANDarray

[

Any of

ANDarray

[

Any of

ORarray

[

Any of

ORarray

[

Any of

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

ORarray

[

Any of

ANDarray

[

Any of

ORarray

[

Any of

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

ORarray

[

Any of

ANDarray

[

Any of

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

ORarray

[

Any of

ANDarray

[

Any of

ANDarray

[

Any of

ORarray

[

Any of

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

ORarray

[

Any of

ANDarray

[

Any of

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

ORarray

[

Any of

ANDarray

[

Any of

ANDarray

[

Any of

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

SEARCH_FIELDstring

SEARCH_TYPEstring (Enum)

SEARCH_VALUEobject

Any of

string

boolean

integer

Array

frominteger

tointeger

keystring

valuestring

]

associated_rule_idsobject

present if Rule Matching Type is RULES

Any of

Array

asset_matching_typestring (Enum)

Allowed values:"ASSET_GROUPS""ALL_ASSETS""CLOUD_ACCOUNTS"

associated_asset_group_idsobject

present if Asset Matching Type is ASSET_GROUPS

Any of

Array

associated_cloud_account_idsobject

present if Asset Matching Type is CLOUD_ACCOUNTS

Any of

Array

enabledboolean

modestring (Enum)

Allowed values:"DEFAULT""CUSTOM"

creation_timeinteger

in Unix epoch milliseconds

created_bystring

modification_timeinteger

in Unix epoch milliseconds

modified_bystring

]

metadataobject

Any of

total_countinteger

filter_countinteger

RESPONSE

{
  "data": [
    {
      "id": "b2b1279e-8760-44a8-8dca-bcc4508f8ce7",
      "name": "Default Cloud Posture Security Policy",
      "description": "Comprehensive default security policy that identifies risks across you entire cloud security estate. It leverages best practices to scan and detect attack paths, misconfigurations, vulnerabilities, identity risks, data risks, network exposures, and other security gaps across your cloud infrastructure and applications, enabling proactive management and mitigation of cloud security risks.",
      "labels": [
        "prisma_cloud"
      ],
      "rule_matching_type": "RULE_FILTER",
      "associated_rule_filter": {
        "OR": [
          {
            "AND": [
              {
                "SEARCH_FIELD": "severity",
                "SEARCH_TYPE": "EQ",
                "SEARCH_VALUE": "critical"
              }
            ]
          },
          {
            "AND": [
              {
                "SEARCH_FIELD": "severity",
                "SEARCH_TYPE": "EQ",
                "SEARCH_VALUE": "high"
              }
            ]
          }
        ]
      },
      "asset_matching_type": "ALL_ASSETS",
      "enabled": true,
      "mode": "DEFAULT",
      "creation_time": 1732557301240,
      "created_by": "Palo Alto Networks",
      "modification_time": 1732557301240,
      "modified_by": "Palo Alto Networks"
    }
  ],
  "metadata": {
    "total_count": 5,
    "filter_count": 1
  }
}

Unprocessable Content

Too Many Requests

Bad Request

Body

application/json

err_msgstring

metadataobject

Any of

err_extraobject

Any of

[

fieldstring

messagestring

]

RESPONSE

{
  "err_msg": "The request contains invalid parameters",
  "metadata": {
    "err_extra": [
      {
        "field": "SEARCH_TYPE",
        "message": "SEARCH_TYPE 'EBQ' is not supported. Allowed values: EQ, CONTAINS, NCONTAINS, NEQ"
      }
    ]
  }
}

Unauthorized

Forbidden

Not Found

Internal Server Error

Body

application/json

err_msgstring

metadataobject

Any of

err_extraobject

Any of

[

fieldstring

messagestring

]

RESPONSE

{
  "err_msg": "Internal Server Error",
  "metadata": {
    "err_extra": [
      {
        "message": "Internal Server Error"
      }
    ]
  }
}

Bad Gateway

Service Unavailable