getCustomSastRules

Returns whether custom SAST rules are enabled and the configured rule list for the organization.

Examples

GraphQL

query GetCustomSastRules {
  getCustomSastRules {
    enabled
    rules {
      name
      issueName
      severity
      customRule
      customIssueDescription
      issueRecommendation
    }
  }
}

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 GetCustomSastRules { getCustomSastRules { enabled rules { name issueName severity customRule customIssueDescription issueRecommendation } } }"
}'

Node.js

const query = 'query GetCustomSastRules { getCustomSastRules { enabled rules { name issueName severity customRule customIssueDescription issueRecommendation } } }';

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
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'query GetCustomSastRules { getCustomSastRules { enabled rules { name issueName severity customRule customIssueDescription issueRecommendation } } }'

response = requests.post(
  "https://api.cloud.ox.security/api/apollo-gateway",
  headers={
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  json={
    "query": query
  }
)

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

Fields

Return type: GetCustomSastRulesResponse!

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

Field	Description	Supported fields
enabled Boolean!	Whether custom SAST rules are evaluated during code security scans.
rules [CustomSastRule!]!	Configured custom SAST rules for the organization.	name String! issueName String! severity CustomSastSeverity! customRule String! customIssueDescription String issueRecommendation String