Skip to main content

Policy Info

GET 
/policy/:id

Returns the policy that has the specified policy ID.

Request​

Path Parameters

    id stringrequired

    Policy ID

Responses​

successful operation

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

Loading...