Update Policy

PUT 
/policy/:id

Updates the existing policy that has the specified policy ID.

Although multiple body parameters are marked as required, to update a policy, you need to provide only the body parameters that you want to update. All body parameters that you don't update will default to the values of the existing policy.

Request

Path Parameters

id stringrequired

Policy ID

application/json; charset=UTF-8

Body

required

Model for Policy

cloudType string

Possible values: [ALL, AWS, AZURE, GCP, ALIBABA_CLOUD, OCI, IBM]

Cloud type (Required for config policies). Not case-sensitive. Default is ALL.

complianceMetadata object[]
List of compliance data. Each item has compliance standard, requirement, and/or section information.
Array [
complianceId string
Compliance Section UUID
customAssigned boolean
policyId string
Policy ID
requirementDescription string
Requirement description
requirementId string
Requirement ID
requirementName string
Requirement name
sectionDescription string
Section name
sectionId string
Section Id
sectionLabel string
Section Label
standardDescription string
Compliance standard description
standardId string
standardName string
Compliance standard name
]
description string

Policy description

enabled boolean

true=enabled. false=disabled.

findingTypes string[]

Finding Type

labels string[]

Labels

name stringrequired

Policy name

policyType objectrequired

Policy type. Policy type anomaly is read-only.

recommendation string

Remediation recommendation

remediation object

Model for Remediation

actions object[]

Policy Action

Array [

operation string

payload string

]

cliScriptTemplate string

CLI Script Template

description string

Description

rule objectrequired

Model for Rule

criteria stringrequired

Saved search ID that defines the rule criteria.

dataCriteria object

Criteria for Rule

classificationResult string

Data policy. Required for DLP rule criteria.

exposure string

Possible values: [private, public, conditional]

File exposure

extension string[]

File extensions

name stringrequired

Name

parameters objectrequired

Parameters (e.g. {"savedSearch": "true"})

property name* string

type stringrequired

Possible values: [Config, Network, AuditEvent, DLP, IAM, NetworkConfig]

Type of rule or RQL query

severity stringrequired

Possible values: [high, medium, low]

Severity

Responses

200

successful operation

application/json; charset=UTF-8

Schema

Schema

cloudType string

Possible values: [ALL, AWS, AZURE, GCP, ALIBABA_CLOUD, OCI, IBM]

Cloud type (Required for config policies). Not case-sensitive. Default is ALL.

complianceMetadata object[]
List of compliance data. Each item has compliance standard, requirement, and/or section information.
Array [
complianceId string
Compliance Section UUID
customAssigned boolean
policyId string
Policy ID
requirementDescription string
Requirement description
requirementId string
Requirement ID
requirementName string
Requirement name
sectionDescription string
Section name
sectionId string
Section Id
sectionLabel string
Section Label
standardDescription string
Compliance standard description
standardId string
standardName string
Compliance standard name
]
createdBy string

Created by

createdOn int64

Created on this timestamp

deleted boolean

Deleted

description string

Policy description

enabled boolean

true=enabled. false=disabled.

findingTypes string[]

Finding Type

labels string[]

Labels

lastModifiedBy string

Last modified by

lastModifiedOn int64

Last modified on this timestamp

name stringrequired

Policy name

overridden boolean

Overridden

policyId string

Policy ID

policySubTypes object[]

Policy subtype

policyType objectrequired

Policy type. Policy type anomaly is read-only.

policyUpi string

Policy UPI

readOnly boolean

Read Only

recommendation string

Remediation recommendation

remediable boolean

isRemediable

remediation object

Model for Remediation

actions object[]

Policy Action

Array [

operation string

payload string

]

cliScriptTemplate string

CLI Script Template

description string

Description

restrictAlertDismissal boolean

Restrict alert dismissal

rule objectrequired

Model for Rule

apiName string

API name

cloudAccount string

Cloud account

cloudType string

Cloud type

criteria stringrequired

Saved search ID that defines the rule criteria.

dataCriteria object

Criteria for Rule

classificationResult string

Data policy. Required for DLP rule criteria.

exposure string

Possible values: [private, public, conditional]

File exposure

extension string[]

File extensions

name stringrequired

Name

parameters objectrequired

Parameters (e.g. {"savedSearch": "true"})

property name* string

resourceIdPath string

Resource ID path

resourceType string

Resource type

type stringrequired

Possible values: [Config, Network, AuditEvent, DLP, IAM, NetworkConfig]

Type of rule or RQL query

ruleLastModifiedOn int64

Rule last modified on

severity stringrequired

Possible values: [high, medium, low]

Severity

systemDefault boolean

true = Policy is a Prisma Cloud system default policy

Example (from schema)

{
  "cloudType": "ALL",
  "complianceMetadata": [
    {
      "complianceId": "string",
      "customAssigned": true,
      "policyId": "string",
      "requirementDescription": "string",
      "requirementId": "string",
      "requirementName": "string",
      "sectionDescription": "string",
      "sectionId": "string",
      "sectionLabel": "string",
      "standardDescription": "string",
      "standardId": "string",
      "standardName": "string"
    }
  ],
  "createdBy": "string",
  "createdOn": 0,
  "deleted": true,
  "description": "string",
  "enabled": true,
  "findingTypes": [
    "string"
  ],
  "labels": [
    "string"
  ],
  "lastModifiedBy": "string",
  "lastModifiedOn": 0,
  "name": "string",
  "overridden": true,
  "policyId": "string",
  "policySubTypes": [
    {}
  ],
  "policyType": {},
  "policyUpi": "string",
  "readOnly": true,
  "recommendation": "string",
  "remediable": true,
  "remediation": {
    "actions": [
      {
        "operation": "string",
        "payload": "string"
      }
    ],
    "cliScriptTemplate": "string",
    "description": "string"
  },
  "restrictAlertDismissal": true,
  "rule": {
    "apiName": "string",
    "cloudAccount": "string",
    "cloudType": "string",
    "criteria": "string",
    "dataCriteria": {
      "classificationResult": "string",
      "exposure": "private",
      "extension": [
        "string"
      ]
    },
    "name": "string",
    "parameters": {},
    "resourceIdPath": "string",
    "resourceType": "string",
    "type": "Config"
  },
  "ruleLastModifiedOn": 0,
  "severity": "high",
  "systemDefault": true
}

400

missing_required_parameter / invalid_parameter_value / policy_id_cannot_be_changed /type_cannot_be_changed / create_update_disallowed_for_json_schema_type_policy / duplicate_name / remediation_allowed_only_for_config_policies / policy_remediation_disallowed_for_non_sys_admins / unable_to_determine_sub_types / unauthorized_access / compliance_mapping_update_disallowed_for_policy_type/policy_enable_failed_due_to_not_enough_wait

403

not_system_admin_user / not_owner_or_same_role

404

not_found

Loading...