Update Cloud Security Policy

patch /public_api/v1/policy/{policy_id}

Modify an existing cloud security policy by ID.

Path parameters

policy_id UUID required

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

CLIENT REQUEST

          curl -X 'PATCH'

        -H
        'Accept: application/json'
      

        -H
        'Content-Type: application/json'
      

      'http://localhost/public_api/v1/policy/{policy_id}'
    

      -d
      '{
  "associated_cloud_account_ids" : [ "", "" ],
  "name" : "",
  "description" : "",
  "associated_rule_ids" : [ "", "", "", "", "" ],
  "associated_rule_filter" : {
    "AND" : [ null, null ]
  },
  "associated_asset_group_ids" : [ "", "", "", "", "" ],
  "enabled" : "",
  "labels" : [ "", "" ]
}'
    


      

import http.client

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

payload = "{\"name\":\"string\",\"description\":\"string\",\"labels\":[\"string\"],\"rule_matching_type\":\"RULE_FILTER\",\"associated_rule_filter\":{\"AND\":[{\"AND\":[{}]}]},\"associated_rule_ids\":[\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"],\"asset_matching_type\":\"ASSET_GROUPS\",\"associated_asset_group_ids\":[0],\"associated_cloud_account_ids\":[\"string\"],\"enabled\":true}"

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

conn.request("PATCH", "//public_api/v1/policy/%7Bpolicy_id%7D", 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/%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::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\"name\":\"string\",\"description\":\"string\",\"labels\":[\"string\"],\"rule_matching_type\":\"RULE_FILTER\",\"associated_rule_filter\":{\"AND\":[{\"AND\":[{}]}]},\"associated_rule_ids\":[\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"],\"asset_matching_type\":\"ASSET_GROUPS\",\"associated_asset_group_ids\":[0],\"associated_cloud_account_ids\":[\"string\"],\"enabled\":true}"

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

const data = JSON.stringify({
  "name": "string",
  "description": "string",
  "labels": [
    "string"
  ],
  "rule_matching_type": "RULE_FILTER",
  "associated_rule_filter": {
    "AND": [
      {
        "AND": [
          {}
        ]
      }
    ]
  },
  "associated_rule_ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "asset_matching_type": "ASSET_GROUPS",
  "associated_asset_group_ids": [
    0
  ],
  "associated_cloud_account_ids": [
    "string"
  ],
  "enabled": true
});

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

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

xhr.open("PATCH", "https://example.com//public_api/v1/policy/%7Bpolicy_id%7D");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

HttpResponse<String> response = Unirest.patch("https://example.com//public_api/v1/policy/%7Bpolicy_id%7D")
  .header("content-type", "application/json")
  .body("{\"name\":\"string\",\"description\":\"string\",\"labels\":[\"string\"],\"rule_matching_type\":\"RULE_FILTER\",\"associated_rule_filter\":{\"AND\":[{\"AND\":[{}]}]},\"associated_rule_ids\":[\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"],\"asset_matching_type\":\"ASSET_GROUPS\",\"associated_asset_group_ids\":[0],\"associated_cloud_account_ids\":[\"string\"],\"enabled\":true}")
  .asString();

import Foundation

let headers = ["content-type": "application/json"]
let parameters = [
  "name": "string",
  "description": "string",
  "labels": ["string"],
  "rule_matching_type": "RULE_FILTER",
  "associated_rule_filter": ["AND": [["AND": [[]]]]],
  "associated_rule_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
  "asset_matching_type": "ASSET_GROUPS",
  "associated_asset_group_ids": [0],
  "associated_cloud_account_ids": ["string"],
  "enabled": true
] as [String : Any]

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

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 = "PATCH"
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/%7Bpolicy_id%7D",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => "{\"name\":\"string\",\"description\":\"string\",\"labels\":[\"string\"],\"rule_matching_type\":\"RULE_FILTER\",\"associated_rule_filter\":{\"AND\":[{\"AND\":[{}]}]},\"associated_rule_ids\":[\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"],\"asset_matching_type\":\"ASSET_GROUPS\",\"associated_asset_group_ids\":[0],\"associated_cloud_account_ids\":[\"string\"],\"enabled\":true}",
  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, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "https://example.com//public_api/v1/policy/%7Bpolicy_id%7D");

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, "{\"name\":\"string\",\"description\":\"string\",\"labels\":[\"string\"],\"rule_matching_type\":\"RULE_FILTER\",\"associated_rule_filter\":{\"AND\":[{\"AND\":[{}]}]},\"associated_rule_ids\":[\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"],\"asset_matching_type\":\"ASSET_GROUPS\",\"associated_asset_group_ids\":[0],\"associated_cloud_account_ids\":[\"string\"],\"enabled\":true}");

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.PATCH);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\"name\":\"string\",\"description\":\"string\",\"labels\":[\"string\"],\"rule_matching_type\":\"RULE_FILTER\",\"associated_rule_filter\":{\"AND\":[{\"AND\":[{}]}]},\"associated_rule_ids\":[\"497f6eca-6276-4993-bfeb-53cbbbba6f08\"],\"asset_matching_type\":\"ASSET_GROUPS\",\"associated_asset_group_ids\":[0],\"associated_cloud_account_ids\":[\"string\"],\"enabled\":true}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Body parameters

required

application/json

nameobject

Any of

string

descriptionobject

Any of

string

labelsobject

Any of

Array

rule_matching_typeobject

method of selecting the applicable rules for this policy

Any of

string (Enum)

method of selecting the applicable rules for this policy

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

associated_rule_filterobject

required 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

required if Rule Matching Type is RULES

Any of

Array

asset_matching_typeobject

method of selecting the assets in scope for this policy

Any of

string (Enum)

method of selecting the assets in scope for this policy

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

associated_asset_group_idsobject

required if Asset Matching Type is ASSET_GROUPS

Any of

Array

associated_cloud_account_idsobject

required if Asset Matching Type is CLOUD_ACCOUNTS

Any of

Array

enabledobject

Any of

boolean

REQUESTupdate Policy Example Request Payload
{
  "name": "API Request with rule_matching_type RULES",
  "description": "API Request with rule_matching_type RULES",
  "labels": [
    "prisma_cloud"
  ],
  "rule_matching_type": "RULES",
  "associated_rule_ids": [
    "60cf2495-32a5-401f-ba56-6bbbf80fe1e2",
    "3c16e31e-1421-4a25-854e-e5870093c99f"
  ],
  "asset_matching_type": "CLOUD_ACCOUNTS",
  "associated_cloud_account_ids": [
    "hvenkatesan-2",
    "883588134481"
  ],
  "enabled": false
}

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

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 RULES
{
  "id": "b2b1279e-8760-44a8-8dca-bcc4508f8ce6",
  "name": "API Request with rule_matching_type RULES",
  "description": "API Request with rule_matching_type RULES",
  "labels": [
    "prisma_cloud"
  ],
  "rule_matching_type": "RULES",
  "associated_rule_ids": [
    "60cf2495-32a5-401f-ba56-6bbbf80fe1e2",
    "3c16e31e-1421-4a25-854e-e5870093c99f"
  ],
  "asset_matching_type": "CLOUD_ACCOUNTS",
  "associated_cloud_account_ids": [
    "hvenkatesan-2",
    "883588134481"
  ],
  "enabled": false,
  "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

Body

application/json

err_msgstringrequired

metadataobject

Any of

err_extraobject

Any of

[

fieldstringrequired

messagestringrequired

]

RESPONSE

{
  "err_msg": "The request contains invalid or missing parameters",
  "metadata": {
    "err_extra": [
      {
        "field": "name",
        "message": "Cannot modify 'name' for system default policy. Only 'labels' can be updated."
      },
      {
        "field": "description",
        "message": "Cannot modify 'description' for system default policy. Only 'labels' can be updated."
      },
      {
        "field": "rule_matching_type",
        "message": "Cannot modify 'rule_matching_type' for system default policy. Only 'labels' can be updated."
      }
    ]
  }
}

{
  "err_msg": "Cannot update system default policy",
  "metadata": {
    "err_extra": [
      {
        "field": "system_default",
        "message": "System default policy are managed by the platform and cannot be modified"
      }
    ]
  }
}

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"
      }
    ]
  }
}

Conflict

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