# getExclusions

Get paginated exclusions with advanced filtering options.

### Examples

{% tabs %}
{% tab title="GraphQL" %}

```graphql
query GetExclusions($getExclusionsInput: GetExclusionsInput) {
  getExclusions(getExclusionsInput: $getExclusionsInput) {
    exclusions {
      exclusionType
      exclusionId
      modifiedIssues
      modifiedBy
      createdAt
      exclusionAppliedOn
      exclusionTypeLabel
      exclusionMatch {
        key
        value
      }
      appName
      policyName
      appId
      policyId
      policyCategory
      appType
      comment
      exclusionScope
      oxIssueId
      issueName
      exclusionMode
      expiredAt
      isActive
      inDayExpired
      inWeekExpired
      status
      fp
      falsePositiveDetails {
        comment
        reportedBy
        reportedAt
      }
      exclusionSubType
    }
    totalExclusions
    totalFilteredExclusions
  }
}
```

**Variables**

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

```json
{
  "getExclusionsInput": {
    "filters": {
      "appName": ["some-repo"],
      "exclusionId": ["example"],
      "exclusionType": ["application"],
      "exclusionMode": ["fullScan"],
      "policyName": ["example"],
      "modifiedBy": ["example"],
      "issueName": ["example"],
      "status": ["example"],
      "expiredAt": {
        "from": 13.37,
        "to": 13.37
      },
      "aboutToExpireIn": ["example"],
      "appId": ["30966426"]
    },
    "limit": 100,
    "offset": 0,
    "search": "example"
  }
}
```

{% endtab %}

{% tab title="cURL" %}

```shell
curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "query GetExclusions($getExclusionsInput: GetExclusionsInput) { getExclusions(getExclusionsInput: $getExclusionsInput) { exclusions { exclusionType exclusionId modifiedIssues modifiedBy createdAt exclusionAppliedOn exclusionTypeLabel exclusionMatch { key value } appName policyName appId policyId policyCategory appType comment exclusionScope oxIssueId issueName exclusionMode expiredAt isActive inDayExpired inWeekExpired status fp falsePositiveDetails { comment reportedBy reportedAt } exclusionSubType } totalExclusions totalFilteredExclusions } }",
 "variables": {
    "getExclusionsInput": {
      "filters": {
        "appName": ["some-repo"],
        "exclusionId": ["example"],
        "exclusionType": ["application"],
        "exclusionMode": ["fullScan"],
        "policyName": ["example"],
        "modifiedBy": ["example"],
        "issueName": ["example"],
        "status": ["example"],
        "expiredAt": {
          "from": 13.37,
          "to": 13.37
        },
        "aboutToExpireIn": ["example"],
        "appId": ["30966426"]
      },
      "limit": 100,
      "offset": 0,
      "search": "example"
    }
  }
}'
```

{% endtab %}

{% tab title="Node.js" %}

```javascript
const query = 'query GetExclusions($getExclusionsInput: GetExclusionsInput) { getExclusions(getExclusionsInput: $getExclusionsInput) { exclusions { exclusionType exclusionId modifiedIssues modifiedBy createdAt exclusionAppliedOn exclusionTypeLabel exclusionMatch { key value } appName policyName appId policyId policyCategory appType comment exclusionScope oxIssueId issueName exclusionMode expiredAt isActive inDayExpired inWeekExpired status fp falsePositiveDetails { comment reportedBy reportedAt } exclusionSubType } totalExclusions totalFilteredExclusions } }';

fetch("https://api.cloud.ox.security/api/apollo-gateway", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  body: JSON.stringify({
    query: query,
    // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    variables: {
      getExclusionsInput: {
        filters: {
          appName: ["some-repo"],
          exclusionId: ["example"],
          exclusionType: ["application"],
          exclusionMode: ["fullScan"],
          policyName: ["example"],
          modifiedBy: ["example"],
          issueName: ["example"],
          status: ["example"],
          expiredAt: {
            from: 13.37,
            to: 13.37
          },
          aboutToExpireIn: ["example"],
          appId: ["30966426"]
        },
        limit: 100,
        offset: 0,
        search: "example"
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

query = 'query GetExclusions($getExclusionsInput: GetExclusionsInput) { getExclusions(getExclusionsInput: $getExclusionsInput) { exclusions { exclusionType exclusionId modifiedIssues modifiedBy createdAt exclusionAppliedOn exclusionTypeLabel exclusionMatch { key value } appName policyName appId policyId policyCategory appType comment exclusionScope oxIssueId issueName exclusionMode expiredAt isActive inDayExpired inWeekExpired status fp falsePositiveDetails { comment reportedBy reportedAt } exclusionSubType } totalExclusions totalFilteredExclusions } }'

response = requests.post(
  "https://api.cloud.ox.security/api/apollo-gateway",
  headers={
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  json={
    "query": query,
    # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    "variables": {
      "getExclusionsInput": {
        "filters": {
          "appName": ["some-repo"],
          "exclusionId": ["example"],
          "exclusionType": ["application"],
          "exclusionMode": ["fullScan"],
          "policyName": ["example"],
          "modifiedBy": ["example"],
          "issueName": ["example"],
          "status": ["example"],
          "expiredAt": {
            "from": 13.37,
            "to": 13.37
          },
          "aboutToExpireIn": ["example"],
          "appId": ["30966426"]
        },
        "limit": 100,
        "offset": 0,
        "search": "example"
      }
    }
  }
)

if response.status_code == 200:
    result = response.json()
    print(result)
else:
    print(f"Error: {response.status_code}")
    print(response.text)
```

{% endtab %}
{% endtabs %}

### Arguments

You can use the following argument(s) to customize your `getExclusions` query.

| Argument                                                                                                                         | Description                                              | Supported fields                                                                                                                                                               |
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| getExclusionsInput [`GetExclusionsInput`](/api-documentation/api-reference/api--exclusions/types/inputs/get-exclusions-input.md) | Input parameters for pagination and filtering exclusions | <p>filters <a href="/pages/vHm9sLfzQSAJrIXjsihn"><code>ExclusionsFilters</code></a><br>limit <code>Float</code><br>offset <code>Float</code><br>search <code>String</code></p> |

### Fields

Return type: [`GetExclusionsRes!`](/api-documentation/api-reference/api--exclusions/types/objects/get-exclusions-res.md)

You can use the following field(s) to specify what information your `getExclusions` query will return. Please note that some fields may have their own subfields.

| Field                                                                                                     | Description                                       | Supported fields                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| --------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| exclusions [`[Exclusion!]!`](/api-documentation/api-reference/api--exclusions/types/objects/exclusion.md) | List of exclusions matching the query             | <p>exclusionType <a href="/pages/YxOLuYCkKHGeUsA26d8n"><code>ExclusionType!</code></a><br>exclusionId <code>String!</code><br>modifiedIssues <code>Float</code><br>modifiedBy <code>String!</code><br>createdAt <code>DateTime!</code><br>exclusionAppliedOn <code>String!</code><br>exclusionTypeLabel <code>String!</code><br>exclusionMatch <a href="/pages/pL4uh5oQg2jEdimJXxn3"><code>\[ExclusionMatch!]!</code></a><br>appName <code>String</code><br>policyName <code>String</code><br>appId <code>String</code><br>policyId <code>String</code><br>policyCategory <code>String</code><br>appType <code>String</code><br>comment <code>String</code><br>exclusionScope <a href="/pages/BzggItbUBfvW3KXKOprw"><code>ExclusionScope</code></a><br>oxIssueId <code>String</code><br>issueName <code>String</code><br>exclusionMode <a href="/pages/PoxuYItIyx7Uk1kJOH02"><code>ExclusionMode</code></a><br>expiredAt <code>DateTime</code><br>isActive <code>Boolean!</code><br>inDayExpired <code>Boolean</code><br>inWeekExpired <code>Boolean</code><br>status <a href="/pages/0QXYSSq7Dmm7KEoDqFbj"><code>StatusMode</code></a><br>fp <code>Boolean</code><br>falsePositiveDetails <a href="/pages/q6Fblj7WN8aNQ3qWvbUm"><code>ExclusionFalsePositiveDetails</code></a><br>exclusionSubType <a href="/pages/wiW5iyR7EgrNLIn9oDFE"><code>OxExclusionSubType</code></a></p> |
| totalExclusions `Float`                                                                                   | Total number of exclusions in the system          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| totalFilteredExclusions `Float`                                                                           | Number of exclusions matching the current filters |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |


---

# 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/queries/get-exclusions.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.
