> For the complete documentation index, see [llms.txt](https://docs.ox.security/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ox.security/api-documentation/api-reference/api--issue/types/objects/recommended-exclusions.md).

# recommendedExclusions

Details about recommended exclusions for issues, including reasons, scope, and flags.

### Examples

```graphql
type RecommendedExclusions {
  label: String
  recommended: Boolean
  tooltip: String
  type: String
  id: String
  oxRuleId: String
  level: String
  excludeBy: [String]
  uidOnly: Boolean
  isDefault: Boolean
  ffKey: String
  exclusionScope: String
}
```

### Fields

| Field                   | Description                                                           | Supported fields |
| ----------------------- | --------------------------------------------------------------------- | ---------------- |
| label `String`          | Label or name of the exclusion                                        |                  |
| recommended `Boolean`   | Indicates if the exclusion is recommended                             |                  |
| tooltip `String`        | Tooltip description for the exclusion                                 |                  |
| type `String`           | Type or category of the exclusion                                     |                  |
| id `String`             | Unique identifier of the exclusion                                    |                  |
| oxRuleId `String`       | Rule ID associated with the exclusion                                 |                  |
| level `String`          | Level of exclusion severity or priority                               |                  |
| excludeBy `[String]`    | List of identifiers that exclude this exclusion                       |                  |
| uidOnly `Boolean`       | Indicates if the exclusion is applied only by unique identifier (UID) |                  |
| isDefault `Boolean`     | Indicates if this exclusion is the default                            |                  |
| ffKey `String`          | Feature flag key controlling this exclusion                           |                  |
| exclusionScope `String` | Scope or boundary where this exclusion applies                        |                  |

### References

#### Fields with this object:

* [{} Issue.exclusions](https://docs.ox.security/api-documentation/api-reference/api--issue/types/objects/issue.md)
* [{} Issue.cveExclusions](https://docs.ox.security/api-documentation/api-reference/api--issue/types/objects/issue.md)


---

# 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://docs.ox.security/api-documentation/api-reference/api--issue/types/objects/recommended-exclusions.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.
