getExclusions

Get paginated exclusions with advanced filtering options.

Examples

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
    }
    totalExclusions
    totalFilteredExclusions
  }
}

Variables

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

{
  "getExclusionsInput": {
    "filters": {
      "appName": ["some-repo"],
      "exclusionId": ["example"],
      "exclusionType": ["application"],
      "exclusionMode": ["fullScan"],
      "policyName": ["example"],
      "modifiedBy": ["example"],
      "issueName": ["example"],
      "status": ["example"],
      "expiredAt": {
        "gte": "example",
        "lte": "example"
      }
    },
    "limit": 100,
    "offset": 0
  }
}

cURL

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 } totalExclusions totalFilteredExclusions } }",
 "variables": {
    "getExclusionsInput": {
      "filters": {
        "appName": ["some-repo"],
        "exclusionId": ["example"],
        "exclusionType": ["application"],
        "exclusionMode": ["fullScan"],
        "policyName": ["example"],
        "modifiedBy": ["example"],
        "issueName": ["example"],
        "status": ["example"],
        "expiredAt": {
          "gte": "example",
          "lte": "example"
        }
      },
      "limit": 100,
      "offset": 0
    }
  }
}'

Node.js

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 } 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: {
            gte: "example",
            lte: "example"
          }
        },
        limit: 100,
        offset: 0
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

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 } 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": {
            "gte": "example",
            "lte": "example"
          }
        },
        "limit": 100,
        "offset": 0
      }
    }
  }
)

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

Arguments

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

Argument	Description	Supported fields
getExclusionsInput GetExclusionsInput	Input parameters for pagination and filtering exclusions	filters ExclusionsFilters limit Float offset Float

Fields

Return type: GetExclusionsRes!

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!]!	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
totalExclusions Float	Total number of exclusions in the system
totalFilteredExclusions Float	Number of exclusions matching the current filters