Search requirements within a component by text

POST

/components/{componentId}/find

Full-text search across requirement titles, fix text, vendor comments, status justification, artifact description, vulnerability discussion, mitigations, and check content within a single component. The same field list applies to both document kinds; results are shaped by the component's document_type. Returns matching requirements in rule_id order. Used by the in-component search feature.

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)

Request Body

application/json

{

  

"find": "container image"

}

Responses

Matching requirements in rule_id order, shaped by the component's document_type: STIG rule objects for stig components, authored SRG requirement objects for srg components.

Content-Type

application/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": [

  

  

]

  

}

]

POST

/components/{componentId}/find

Playground

Server

Authorization

tokenAuth

Body

Samples

Powered by VitePress OpenAPI