Skip to content

Lock or unlock sections on every unlocked rule

PATCH
/components/{componentId}/lock_sections

Locks (or unlocks) the named content sections across all unlocked requirement rows in the component — both document kinds. Section names come from the lockable-section vocabulary (Title, Severity, Status, Fix, Check, ...). Locked sections cannot be edited until unlocked. Requires reviewer role or higher on the component. Returns 422 when any section name is not in the vocabulary.

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)

Request Body

application/json
JSON
{
  
"sections": [
  
  
"Fix",
  
  
"Check"
  
],
  
"locked": true,
  
"comment": "Content freeze for the review window."
}

Responses

Section lock applied across all unlocked rules

application/json
JSON
{
  
"toast": {
  
  
"title": "Section lock applied",
  
  
"message": [
  
  
  
"Locked 2 section(s) on 264 rule(s)"
  
  
],
  
  
"variant": "success"
  
}
}

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)