Skip to content

Legacy requirement search by SRG version

GET
/search/rules

Searches requirement rows of both document kinds — stig rules and authored SRG requirements — by version identifier. Scoped to components the user can access: project or component membership, or released components; admins are unrestricted. Returns compact tuples [id, rule_id, component_id, prefix]. Requires authentication. This is a legacy search endpoint — prefer /api/search/global for new integrations.

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)

Parameters

Query Parameters

q*

SRG version identifier to search for.

Type
string
Required
Example"SRG-OS-000001-GPOS-00001"

Responses

Matching rules as compact tuples

application/json
JSON
{
  
"rules": [
  
  
[
  
  
  
1786,
  
  
  
"000001",
  
  
  
1,
  
  
  
"PHOS-03"
  
  
],
  
  
[
  
  
  
2500,
  
  
  
"000001",
  
  
  
5,
  
  
  
"CNTR-01"
  
  
]
  
]
}

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)