# exclusion

Main exclusion entity containing all exclusion details and metadata.

### Examples

```graphql
type Exclusion {
  exclusionType: ExclusionType!
  exclusionId: String!
  modifiedIssues: Float
  modifiedBy: String!
  createdAt: DateTime!
  exclusionAppliedOn: String!
  exclusionTypeLabel: String!
  exclusionMatch: [ExclusionMatch!]!
  appName: String
  policyName: String
  appId: String
  policyId: String
  policyCategory: String
  appType: String
  comment: String
  exclusionScope: ExclusionScope
  oxIssueId: String
  issueName: String
  exclusionMode: ExclusionMode
  expiredAt: DateTime
  isActive: Boolean!
  inDayExpired: Boolean
  inWeekExpired: Boolean
  status: StatusMode
  fp: Boolean
  falsePositiveDetails: ExclusionFalsePositiveDetails
  exclusionSubType: OxExclusionSubType
}
```

### Fields

| Field                                                                                                                                                      | Description                                             | Supported fields                                                                                         |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| exclusionType [`ExclusionType!`](/api-documentation/api-reference/api--exclusions/types/enums/exclusion-type.md)                                           | Type of the exclusion (alert, policy, or application)   |                                                                                                          |
| exclusionId `String!`                                                                                                                                      | Unique string identifier for the exclusion              |                                                                                                          |
| modifiedIssues `Float`                                                                                                                                     | Number of issues modified by this exclusion             |                                                                                                          |
| modifiedBy `String!`                                                                                                                                       | User who last modified the exclusion                    |                                                                                                          |
| createdAt `DateTime!`                                                                                                                                      | Timestamp when the exclusion was created                |                                                                                                          |
| exclusionAppliedOn `String!`                                                                                                                               | Description of where this exclusion is applied          |                                                                                                          |
| exclusionTypeLabel `String!`                                                                                                                               | Human-readable label for the exclusion type             |                                                                                                          |
| exclusionMatch [`[ExclusionMatch!]!`](/api-documentation/api-reference/api--exclusions/types/objects/exclusion-match.md)                                   | List of matching criteria for this exclusion            | <p>key <code>String!</code><br>value <code>String!</code></p>                                            |
| appName `String`                                                                                                                                           | Name of the application this exclusion applies to       |                                                                                                          |
| policyName `String`                                                                                                                                        | Name of the policy this exclusion applies to            |                                                                                                          |
| appId `String`                                                                                                                                             | ID of the application this exclusion applies to         |                                                                                                          |
| policyId `String`                                                                                                                                          | ID of the policy this exclusion applies to              |                                                                                                          |
| policyCategory `String`                                                                                                                                    | Category of the policy this exclusion applies to        |                                                                                                          |
| appType `String`                                                                                                                                           | Type of application this exclusion applies to           |                                                                                                          |
| comment `String`                                                                                                                                           | User comment explaining the reason for this exclusion   |                                                                                                          |
| exclusionScope [`ExclusionScope`](/api-documentation/api-reference/api--exclusions/types/enums/exclusion-scope.md)                                         | Scope of application for this exclusion                 |                                                                                                          |
| oxIssueId `String`                                                                                                                                         | Ox-specific issue identifier                            |                                                                                                          |
| issueName `String`                                                                                                                                         | Name of the issue this exclusion applies to             |                                                                                                          |
| exclusionMode [`ExclusionMode`](/api-documentation/api-reference/api--exclusions/types/enums/exclusion-mode.md)                                            | Mode of operation for this exclusion                    |                                                                                                          |
| expiredAt `DateTime`                                                                                                                                       | Date when this exclusion expires                        |                                                                                                          |
| isActive `Boolean!`                                                                                                                                        | Whether this exclusion is currently active              |                                                                                                          |
| inDayExpired `Boolean`                                                                                                                                     | Whether this exclusion expires within one day           |                                                                                                          |
| inWeekExpired `Boolean`                                                                                                                                    | Whether this exclusion expires within one week          |                                                                                                          |
| status [`StatusMode`](/api-documentation/api-reference/api--exclusions/types/enums/status-mode.md)                                                         | Current status of the exclusion                         |                                                                                                          |
| fp `Boolean`                                                                                                                                               | Whether this exclusion is marked as a false positive    |                                                                                                          |
| falsePositiveDetails [`ExclusionFalsePositiveDetails`](/api-documentation/api-reference/api--exclusions/types/objects/exclusion-false-positive-details.md) | Nested false positive details (comment, reporter, date) | <p>comment <code>String</code><br>reportedBy <code>String</code><br>reportedAt <code>DateTime</code></p> |
| exclusionSubType [`OxExclusionSubType`](/api-documentation/api-reference/api--exclusions/types/enums/ox-exclusion-sub-type.md)                             | Sub type of the exclusion                               |                                                                                                          |

### References

#### Fields with this object:

* [{} GetExclusionsRes.exclusions](/api-documentation/api-reference/api--exclusions/types/objects/get-exclusions-res.md)


---

# Agent Instructions: 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:

```
GET https://docs.ox.security/api-documentation/api-reference/api--exclusions/types/objects/exclusion.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
