> 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--exclusions/queries/get-exclusions.md).
# 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 | filters ExclusionsFilters
limit Float
offset Float
search String
|
### 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 | 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
|
| totalExclusions `Float` | Total number of exclusions in the system | |
| totalFilteredExclusions `Float` | Number of exclusions matching the current filters | |
---
# 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://docs.ox.security/api-documentation/api-reference/api--exclusions/queries/get-exclusions.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.