Get a lightweight component summary
GET
/api/components/{id}/summary
Returns the component header — identity, counts, SRG info, the caller's effective permissions, and the serialized comment-phase state machine — without the heavy rules/reviews/histories arrays. Access matches the component show rules: released components are readable by any authenticated user; unreleased ones require viewer permission.
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 component.
Type
Requiredinteger
Example
38Responses
Component summary with phase state
application/json
JSON "id": 38, "name": "RHEL 9 Hardened Baseline", "prefix": "RHEL-09", "document_type": "stig", "title": "Red Hat Enterprise Linux 9", "version": 2, "release": 1, "released": false, "project_id": 7, "component_id": null, "security_requirements_guide_id": 3, "based_on_title": "General Purpose Operating System Security Requirements Guide", "based_on_version": "V3R3", "rules_count": 203, "memberships_count": 4, "severity_counts": { "high": 20, "medium": 173, "low": 10 }, "pending_comment_count": 5, "effective_permissions": "viewer", "updated_at": "2026-07-10T14:07:37.142Z", "comment_phase": "open", "closed_reason": null, "comment_period_starts_at": "2026-07-01T00:00:00.000Z", "comment_period_ends_at": "2026-07-15T00:00:00.000Z", "accepting_new_comments": true, "triaging_active": true, "frozen_for_writes": false, "comment_period_days_remaining": 5
{
}