Get Cloud Security Policy

get /public_api/v1/policy/{policy_id}

Get a cloud security policy by ID.

Path parameters

policy_id UUID required

Example: 38400000-8cf0-11bd-b23e-10b96e4ef00d

CLIENT REQUEST

          curl -X 'GET'

        -H
        'Accept: application/json'
      
      'http://localhost/public_api/v1/policy/{policy_id}'

import http.client

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

conn.request("GET", "//public_api/v1/policy/%7Bpolicy_id%7D")

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/%7Bpolicy_id%7D")

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

request = Net::HTTP::Get.new(url)

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

const data = null;

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

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

xhr.open("GET", "https://example.com//public_api/v1/policy/%7Bpolicy_id%7D");

xhr.send(data);

HttpResponse<String> response = Unirest.get("https://example.com//public_api/v1/policy/%7Bpolicy_id%7D")
  .asString();

import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://example.com//public_api/v1/policy/%7Bpolicy_id%7D")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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/%7Bpolicy_id%7D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://example.com//public_api/v1/policy/%7Bpolicy_id%7D");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://example.com//public_api/v1/policy/%7Bpolicy_id%7D");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);

Responses

Successful Response

Body

application/json

idstringrequireduuid

namestringrequired

descriptionobject

Any of

string

labelsobject

Any of

Array

rule_matching_typestring (Enum)required

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

associated_rule_filterobject

present if Rule Matching Type is RULE_FILTER

Any of

ANDarrayrequired

[

Any of

ANDarrayrequired

[

Any of

ORarrayrequired

[

Any of

ORarrayrequired

[

Any of

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

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_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

ORarrayrequired

[

Any of

ANDarrayrequired

[

Any of

ORarrayrequired

[

Any of

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

ORarrayrequired

[

Any of

ANDarrayrequired

[

Any of

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

ORarrayrequired

[

Any of

ANDarrayrequired

[

Any of

ANDarrayrequired

[

Any of

ORarrayrequired

[

Any of

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

ORarrayrequired

[

Any of

ANDarrayrequired

[

Any of

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

ORarrayrequired

[

Any of

ANDarrayrequired

[

Any of

ANDarrayrequired

[

Any of

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

SEARCH_FIELDstringrequired

SEARCH_TYPEstring (Enum)required

SEARCH_VALUEobjectrequired

Any of

string

boolean

integer

Array

fromintegerrequired

tointegerrequired

keystringrequired

valuestringrequired

]

associated_rule_idsobject

present if Rule Matching Type is RULES

Any of

Array

asset_matching_typestring (Enum)required

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

enabledbooleanrequired

modestring (Enum)required

Allowed values:"DEFAULT""CUSTOM"

creation_timeintegerrequired

in Unix epoch milliseconds

created_bystringrequired

modification_timeintegerrequired

in Unix epoch milliseconds

modified_bystringrequired

RESPONSEAPI response with rule_matching_type RULE_FILTER
{
  "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"
}

Unprocessable Content

Too Many Requests

Unauthorized

Forbidden

Not Found

Body

application/json

err_msgstringrequired

metadataobject

Any of

err_extraobject

Any of

[

fieldstringrequired

messagestringrequired

]

RESPONSEPolicy not found with id
{
  "err_msg": "Policy not found",
  "metadata": {
    "err_extra": [
      {
        "field": "id",
        "message": "No policy found with the specified ID"
      }
    ]
  }
}

Internal Server Error

Body

application/json

err_msgstringrequired

metadataobject

Any of

err_extraobject

Any of

[

fieldstringrequired

messagestringrequired

]

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

Bad Gateway

Service Unavailable