updateCustomSastRules

Replaces the organization custom SAST rules configuration. A successful update removes active findings for deleted or disabled rules and requests an organization scan.

Examples

GraphQL

mutation UpdateCustomSastRules($input: UpdateCustomSastRulesInput!) {
  updateCustomSastRules(input: $input) {
    success
    reasonFailed
  }
}

Variables

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

{
  "input": {
    "enabled": true,
    "rules": [
      {
        "name": "Disallow eval",
        "issueName": "Unsafe use of eval",
        "severity": "high",
        "customRule": "rules:
  - id: javascript-eval
    languages:
      - javascript
    severity: WARNING
    message: Detect use of eval
    pattern: eval(...)",
        "customIssueDescription": "The code uses eval, which can execute arbitrary code.",
        "issueRecommendation": "Replace eval with safer parsing alternatives."
      }
    ]
  }
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "mutation UpdateCustomSastRules($input: UpdateCustomSastRulesInput!) { updateCustomSastRules(input: $input) { success reasonFailed } }",
 "variables": {
    "input": {
      "enabled": true,
      "rules": [
        {
          "name": "Disallow eval",
          "issueName": "Unsafe use of eval",
          "severity": "high",
          "customRule": "rules:
  - id: javascript-eval
    languages:
      - javascript
    severity: WARNING
    message: Detect use of eval
    pattern: eval(...)",
          "customIssueDescription": "The code uses eval, which can execute arbitrary code.",
          "issueRecommendation": "Replace eval with safer parsing alternatives."
        }
      ]
    }
  }
}'

Node.js

const query = 'mutation UpdateCustomSastRules($input: UpdateCustomSastRulesInput!) { updateCustomSastRules(input: $input) { success reasonFailed } }';

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: {
      input: {
        enabled: true,
        rules: [
          {
            name: "Disallow eval",
            issueName: "Unsafe use of eval",
            severity: "high",
            customRule: "rules:
  - id: javascript-eval
    languages:
      - javascript
    severity: WARNING
    message: Detect use of eval
    pattern: eval(...)",
            customIssueDescription: "The code uses eval, which can execute arbitrary code.",
            issueRecommendation: "Replace eval with safer parsing alternatives."
          }
        ]
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'mutation UpdateCustomSastRules($input: UpdateCustomSastRulesInput!) { updateCustomSastRules(input: $input) { success reasonFailed } }'

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": {
      "input": {
        "enabled": true,
        "rules": [
          {
            "name": "Disallow eval",
            "issueName": "Unsafe use of eval",
            "severity": "high",
            "customRule": "rules:
  - id: javascript-eval
    languages:
      - javascript
    severity: WARNING
    message: Detect use of eval
    pattern: eval(...)",
            "customIssueDescription": "The code uses eval, which can execute arbitrary code.",
            "issueRecommendation": "Replace eval with safer parsing alternatives."
          }
        ]
      }
    }
  }
)

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 updateCustomSastRules mutation.

Argument	Description	Supported fields
input UpdateCustomSastRulesInput! required	Custom SAST rules configuration to apply. Replaces the full rule list for the organization.	enabled Boolean! rules [CustomSastRuleInput!]!

Fields

Return type: UpdateCustomSastRulesResponse!

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

Field	Description	Supported fields
success Boolean!	Whether the custom SAST rules were saved successfully.
reasonFailed String	Validation or persistence failure reason when success is false.