Skip to content

List all rules for a component

GET
/components/{componentId}/rules

Returns all rules in the component with full content fields (title, fixtext, check_content, vuln_discussion, etc.). Used by the component editor to populate the rule list. 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

All component rules

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

Playground

Server
Authorization

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)