Skip to content

Component detail with rules

GET
/components/{componentId}

Returns full component details including all rules with their content fields, for either document kind. Members (any role) receive the editor view; a non-member receives the read-only show view for a RELEASED component (released components are never concealed, whatever the project's visibility). An unreleased component answers a non-member per the disclosure policy: 403 with the project admins to ask when the project is discoverable, or the concealment 404 when it is hidden.

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

Component with rules — the editor view for members, the read-only show view otherwise. A null effective_permissions marks the show branch. The two shapes share their core fields, so they are documented as anyOf.

application/json
JSON
{
  
"id": 1,
  
"name": "Photon OS 3",
  
"prefix": "PHOS-03",
  
"title": "Photon OS 3 STIG Readiness Guide",
  
"rules_count": 203,
  
"comment_phase": "open",
  
"version": 1,
  
"release": 1,
  
"released": false
}

Playground

Server
Authorization

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)