Find rules sharing the same SRG requirement

GET

/rules/{ruleId}/search/related_rules

Returns rules from other components and published STIGs that implement the same SRG requirement (matched by version/srg_id). Results are scoped to components the current user can access unless the user is an admin. The rules array is a mix of RuleEditorResponse (component rules) and StigRuleSummary (published STIG rules). The parents array is a mix of ComponentBlueprint :related and StigBlueprint :index for grouping. Stig rules only — the search keys off the stig rule's SRG-version linkage, so requests for an authored SRG requirement return 404 (no related-rules surface exists for that kind).

Authorizations

tokenAuth

Personal access token authentication. Send via Authorization header: Authorization: Token vulcan_xxx. Tokens are SHA-256 hashed server-side (never stored in plaintext). Scopes: read (GET), write (mutations), admin (everything). Create tokens via Settings → API Tokens in the web UI.

Type

HTTP (token)

Responses

Related rules with parent containers

Content-Type

application/json

{

  

"rules": [

  

  

{

  

  

  

"id": 200,

  

  

  

"rule_id": "SV-222387r960735_rule",

  

  

  

"title": "The application must limit logon sessions",

  

  

  

"version": "APSC-DV-000010",

  

  

  

"rule_severity": "medium"

  

  

},

  

  

{

  

  

  

"id": 1800,

  

  

  

"rule_id": "000001",

  

  

  

"title": "The operating system must provide automated mechanisms",

  

  

  

"status": "Not Yet Determined",

  

  

  

"component_id": 1

  

  

}

  

],

  

"parents": [

  

  

{

  

  

  

"id": 1,

  

  

  

"stig_id": "Application_Security_Development_STIG",

  

  

  

"name": "Application Security Development STIG - Ver 6, Rel 4",

  

  

  

"title": "Application Security and Development STIG"

  

  

},

  

  

{

  

  

  

"id": 1,

  

  

  

"name": "Photon OS 3",

  

  

  

"prefix": "PHOS-03",

  

  

  

"project": {

  

  

  

  

"id": 1,

  

  

  

  

"name": "Photon 3"

  

  

  

}

  

  

}

  

]

}

GET

/rules/{ruleId}/search/related_rules

Playground

Server

Authorization

tokenAuth

Samples

Powered by VitePress OpenAPI