> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/xpanse-api/xpanse-public-api/remediation-path-rules.md).
# Remediation Path Rules
APIs for managing remediation path rules
## Get remediation path rules
> Get the list of the remediation path rules associated with an attack surface rule. \
Required License: Cortex Xpanse Expander + Active Response Module Add-On
```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Remediation Path Rules","description":"APIs for managing remediation path rules"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/xpanse_remediation_rules/rules/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRemediationRulesResponse"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRemediationRulesRequest"}}},"description":""},"summary":"Get remediation path rules","description":"Get the list of the remediation path rules associated with an attack surface rule.
Required License: Cortex Xpanse Expander + Active Response Module Add-On\n","tags":["Remediation Path Rules"]}}},"components":{"schemas":{"GetRemediationRulesResponse":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/RemediationRulesPageResponse"}},"required":["reply"],"additionalProperties":true},"RemediationRulesPageResponse":{"type":"object","properties":{"result_count":{"type":"integer"},"remediation_rules":{"type":"array","items":{"$ref":"#/components/schemas/RemediationRule"}}},"required":["remediation_rules","result_count"],"additionalProperties":true},"RemediationRule":{"type":"object","properties":{"rule_id":{"type":"string"},"description":{"type":"string"},"attack_surface_rule_id":{"type":"string"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/RemediationRuleCriteria"}},"criteria_conjunction":{"type":"string"},"action":{"type":"string"},"created_by":{"type":"string"},"created_by_pretty":{"type":"string"},"created_at":{"type":"integer"},"details":{"type":"string"}},"required":["action","attack_surface_rule_id","created_at","created_by","created_by_pretty","criteria","criteria_conjunction","description","details","rule_id"],"additionalProperties":true},"RemediationRuleCriteria":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"},"operator":{"type":"string"}},"required":["field","operator","value"],"additionalProperties":true},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"GetRemediationRulesRequest":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetRemediationRulesFilters"}},"required":["request_data"],"additionalProperties":true},"GetRemediationRulesFilters":{"type":"object","properties":{"filters":{"type":"array","description":"Array of filter fields. Each JSON object must contain the following:\n - field\n - operator\n - value\n","items":{"$ref":"#/components/schemas/RemediationRulesFilterCondition"}},"sort":{"description":"Identifies the sort order for the result set. By default, the sort is defined as `created_at`, `DESC`.","allOf":[{"$ref":"#/components/schemas/RemediationRulesSort"}]},"search_from":{"type":"integer","default":0,"minimum":0},"search_to":{"type":"integer","default":500,"minimum":0}},"additionalProperties":true,"description":"A dictionary containing the API request fields."},"RemediationRulesFilterCondition":{"type":"object","properties":{"field":{"type":"string","enum":["attack_surface_rule_id"],"description":"String that identifies the attack surface rule field for filtering.\n"},"operator":{"type":"string","enum":["neq","eq"],"description":"Identifies the comparison operator to use for this filter. Valid keywords are\n - `eq`\n - `neq`\n"},"value":{"type":"string","description":"Value that the filter must match. Value must be the following:\n - `{attack_surface_rule_id}`: String of the attack surface rule to filter on\n"}},"required":["field","operator","value"],"additionalProperties":true},"RemediationRulesSort":{"type":"object","properties":{"field":{"type":"string","default":"created_at","enum":["created_at"],"description":"Sorting based on the `created_at` field is supported."},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"],"description":"Sort order can be one of the following values:\n - `ASC`: ascending order\n - `DESC`: descending order\n"}},"additionalProperties":true}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://cortex-docs.paloaltonetworks.com/xpanse-api/xpanse-public-api/remediation-path-rules.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.