Search across all resource types

GET

/api/search/global

Searches projects, components, rules, SRGs, and STIGs by name or title. Results are grouped by type and limited per group. Project results cover everything the caller can discover (memberships plus discoverable projects); component and rule content is served only from the caller's memberships and released components; SRG/STIG results and the srg_rules requirement catalog are instance-global. The rules group covers both document kinds — stig rules and authored SRG requirements — and can be scoped to a specific component via the component_id parameter. Requires authentication — returns 401 if not signed in.

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*

Search query string (minimum 2 characters).

Type

string

Required

Example"container platform"

Min Length

2

limit

Maximum results per resource type.

Type

integer

Example5

Minimum

1

Maximum

20

Default

5

component_id

Scope rule search to a specific component.

Type

integer

Example29

Responses

Search results grouped by type

Content-Type

application/json

{

  

"projects": [

  

  

{

  

  

  

"id": 4,

  

  

  

"name": "Container Platform"

  

  

}

  

],

  

"components": [

  

  

{

  

  

  

"id": 29,

  

  

  

"name": "Container SRG"

  

  

}

  

],

  

"rules": [

  

],

  

"stig_rules": [

  

],

  

"srg_rules": [

  

],

  

"srgs": [

  

  

{

  

  

  

"id": 1,

  

  

  

"title": "Container Platform Security Requirements Guide"

  

  

}

  

],

  

"stigs": [

  

]

}

GET

/api/search/global

Playground

Server

Authorization

tokenAuth

Variables

Key

Value

q*

limit

component_id

Samples

Powered by VitePress OpenAPI