Skip to content

Lightweight rule list for picker UI

GET
/components/{componentId}/rules_picker

Returns a compact list of requirements for dropdown/picker selection (e.g., the move-to-rule admin action or duplicate-of picker). Lighter than the full rules list — omits content fields. Rows are shaped by the component's document_type: STIG rule objects carry the satisfaction relationships, authored SRG requirement objects omit them entirely. Requires project membership.

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

Requirements for picker selection

application/json
JSON
{
  
"rules": [
  
  
{
  
  
  
"id": 100,
  
  
  
"rule_id": "000050",
  
  
  
"displayed_name": "CNTR-00-000050",
  
  
  
"title": "Container images must be signed",
  
  
  
"locked": false,
  
  
  
"satisfies": [
  
  
  
],
  
  
  
"satisfied_by": [
  
  
  
]
  
  
},
  
  
{
  
  
  
"id": 101,
  
  
  
"rule_id": "000051",
  
  
  
"displayed_name": "CNTR-00-000051",
  
  
  
"title": "Container images must come from approved registries",
  
  
  
"locked": true,
  
  
  
"satisfies": [
  
  
  
],
  
  
  
"satisfied_by": [
  
  
  
]
  
  
}
  
]
}

Playground

Server
Authorization

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)