Release an SRG component to the catalog

POST

/components/{componentId}/release

Releases an SRG-kind component in one transaction: verifies every live requirement is decided (never Not Yet Determined) and locked, mints the final published identifiers, generates the published SRG XCCDF, creates the catalog SecurityRequirementsGuide entry with its columns derived from that document, copies the published requirements onto the entry, and flags the component released. The released entry behaves exactly like an uploaded SRG — new components can base on it immediately. Requires the author role on the component. STIG readiness components do not use this endpoint (their release is the released flag on component update).

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 released and attached to the catalog

Content-Type

application/json

{

  

"toast": {

  

  

"title": "Component released.",

  

  

"message": [

  

  

  

"Container Best Practice SRG - Ver 1, Rel 1 is now in the SRG catalog."

  

  

],

  

  

"variant": "success"

  

},

  

"catalog_srg": {

  

  

"id": 42,

  

  

"srg_id": "Container_Best_Practice_SRG",

  

  

"version": "V1R1",

  

  

"name": "Container Best Practice SRG - Ver 1, Rel 1"

  

},

  

"changelog": {

  

  

"version": "V1R1",

  

  

"removals": [

  

  

],

  

  

"text": "Container Best Practice SRG V1R1 — Release Changelog No requirements were removed in this release."

  

}

}

POST

/components/{componentId}/release

Playground

Server

Authorization

tokenAuth

Samples

Powered by VitePress OpenAPI