Get Policy Remediation

GET 
https://api.prismacloud.io/policy/api/v1/fetch/remediation/:policyId

Fetch AI-Assisted remediation and recommendation content for a given policy. If AI-Assisted Remediation is not available, fetch the recommendation content instead. The remediation typically includes actionable steps to mitigate or remediate the identified alert on the asset.

Request

Path Parameters

policyId stringrequired

Query Parameters

unifiedAssetId stringrequired
alertId stringrequired

Responses

200

success

application/json

Schema

Schema

value object[]
Array [
policyIdstring
policyNamestring
policyTypestring
cloudTypestring
Possible values: [all, aws, azure, gcp, alibaba_cloud, oci, other, ibm]
findingTypesstring[]
aiRemediation object
manualRemediation object
The manual remediation steps to be taken
titlestring
A title for the manual remediation steps
descriptionstring
A description of the remediation content
instructionsstring
Detailed instructions to manually remediate the issue
impactstring
The potential impact of applying the remediation
cli object[]
The suggested CLI-based remediation steps
Array [
titlestring
A title for the remediation script to be executed
descriptionstring
A description of the remediation content
codeBlockstring
The suggested code block to be executed for remediation
impactstring
The potential impact of applying the remediation
automatedboolean
can be executed automatically without manual intervention
]
tf object[]
The suggested Terraform-based remediation steps
Array [
titlestring
A title for the remediation script to be executed
descriptionstring
A description of the remediation content
codeBlockstring
The suggested code block to be executed for remediation
impactstring
The potential impact of applying the remediation
automatedboolean
can be executed automatically without manual intervention
]
recommendationstring
Recommended set of steps to remediate the issue.
hasSearchExecutionSupportboolean
(Internal Use) Indicates whether the policy is searchable on the RQL Investigate page.
savedSearchIdstring
]

Example (auto)

{
  "value": [
    {
      "policyId": "string",
      "policyName": "string",
      "policyType": "string",
      "cloudType": "all",
      "findingTypes": [
        "string"
      ],
      "aiRemediation": {
        "manualRemediation": {
          "title": "string",
          "description": "string",
          "instructions": "string",
          "impact": "string"
        },
        "cli": [
          {
            "title": "string",
            "description": "string",
            "codeBlock": "string",
            "impact": "string",
            "automated": true
          }
        ],
        "tf": [
          {
            "title": "string",
            "description": "string",
            "codeBlock": "string",
            "impact": "string",
            "automated": true
          }
        ]
      },
      "recommendation": "string",
      "hasSearchExecutionSupport": true,
      "savedSearchId": "string"
    }
  ]
}

400

bad_request

401

unauthorized_access

403

permission_error

429

too_many_requests

Authorization: x-redlock-auth

name: x-redlock-authtype: apiKeydescription: The x-redlock-auth value is a JSON Web Token (JWT).in: header

• curl
• python
• go
• nodejs
• csharp
• php

• CURL

curl -L 'https://pan.dev/policy/api/v1/fetch/remediation/:policyId' \
-H 'Accept: application/json' \
-H 'x-redlock-auth: <x-redlock-auth>'

Request Collapse all

Base URL

https://api.prismacloud.io

Auth

x-redlock-auth

Parameters

policyId — pathrequired

unifiedAssetId — queryrequired

alertId — queryrequired