Get rule counts and component usage for an SRG

GET

/api/srgs/{id}/stats

Returns the SRG's rule count, severity breakdown, and which components are based on it. Usage is scoped to components the caller can see (member projects or released) — the count and list use the same scope, so hidden usage is never revealed. Requires authentication.

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

Path Parameters

id*

Numeric ID of the SRG.

Type

integer

Required

Example3

Responses

SRG stats with caller-scoped usage

Content-Type

application/json

{

  

"rule_count": 250,

  

"severity_counts": {

  

  

"high": 30,

  

  

"medium": 200,

  

  

"low": 20

  

},

  

"usage": {

  

  

"count": 2,

  

  

"components": [

  

  

  

{

  

  

  

  

"id": 38,

  

  

  

  

"name": "RHEL 9 Hardened Baseline",

  

  

  

  

"project_id": 7,

  

  

  

  

"project_name": "RHEL Hardening"

  

  

  

},

  

  

  

{

  

  

  

  

"id": 41,

  

  

  

  

"name": "Photon OS 5 Baseline",

  

  

  

  

"project_id": 9,

  

  

  

  

"project_name": "Photon OS 5 Hardening"

  

  

  

}

  

  

]

  

}

}

GET

/api/srgs/{id}/stats

Playground

Server

Authorization

tokenAuth

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI