> 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/xdr-api/yara-rules-and-scans/yara-papi-tables.md).

# Additional References

Reference tables for the YARA Rules and Scans APIs.

## Filter fields and operators

The `filters` array in the Get YARA rules request accepts the fields below. Each field supports only the operators listed for it. All filters in a request are combined with a logical AND.

| Field         | Type                               | Supported operators                     | Sortable |
| ------------- | ---------------------------------- | --------------------------------------- | -------- |
| `id`          | String                             | `eq`, `neq`                             | No       |
| `name`        | String                             | `eq`, `neq`, `contains`, `not_contains` | Yes      |
| `origin`      | String                             | `eq`, `neq`, `contains`, `not_contains` | Yes      |
| `description` | String                             | `contains`, `not_contains`              | No       |
| `author`      | String                             | `eq`, `neq`, `contains`, `not_contains` | Yes      |
| `created_by`  | String                             | `eq`, `neq`, `contains`, `not_contains` | Yes      |
| `first_seen`  | Integer (Unix epoch, milliseconds) | `gte`, `lte`                            | Yes      |

## Operator reference

| Operator       | Description                                          |
| -------------- | ---------------------------------------------------- |
| `eq`           | The field exactly matches the value.                 |
| `neq`          | The field does not match the value.                  |
| `contains`     | The field contains the value as a substring.         |
| `not_contains` | The field does not contain the value as a substring. |
| `gte`          | The field is greater than or equal to the value.     |
| `lte`          | The field is less than or equal to the value.        |

## Rule origin values

| Value         | Description                                             |
| ------------- | ------------------------------------------------------- |
| `public_api`  | The rule was added through the Add YARA rules endpoint. |
| `user_upload` | The rule was uploaded through the Cortex XDR console.   |

## Delete status values

| Value     | Description                                               |
| --------- | --------------------------------------------------------- |
| `SUCCESS` | Every requested rule was deleted.                         |
| `PARTIAL` | Some rules were deleted and some rule IDs were not found. |
| `FAILED`  | None of the requested rule IDs were found.                |

## Scan scope path formats

Paths in `scope_content` must use Windows format with backslashes.

| Format               | Example               |
| -------------------- | --------------------- |
| Drive path           | `C:\Windows\System32` |
| Environment variable | `%WINDIR%\System32`   |
| UNC path             | `\\server\share`      |
| Wildcard pattern     | `*.exe`               |

## Limits

| Limit                                                    | Value          |
| -------------------------------------------------------- | -------------- |
| Rules per Add YARA rules request                         | 1000           |
| Combined size of all rules in one Add YARA rules request | 500 KB         |
| Rule IDs per Delete YARA rules request                   | 1000           |
| Rules stored per tenant                                  | 10,000         |
| Rules per scan                                           | 500            |
| Endpoints per scan                                       | 2000           |
| Scope paths per scan                                     | 50             |
| Scan name length                                         | 100 characters |
| Results per Get YARA rules page                          | 100            |

## Required permissions

| Endpoint          | Required permission                  |
| ----------------- | ------------------------------------ |
| Add YARA rules    | Detections > Rules > View/Edit       |
| Get YARA rules    | Detections > Rules > View            |
| Delete YARA rules | Detections > Rules > View/Edit       |
| Start a YARA scan | Response > Action Center > View/Edit |
| Abort a YARA scan | Response > Action Center > View/Edit |


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://cortex-docs.paloaltonetworks.com/xdr-api/yara-rules-and-scans/yara-papi-tables.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
