Skip to content

Update the section field on a review

PATCH
/reviews/{reviewId}/section

Changes which requirement section (fixtext, check_content, vuln_discussion, etc.) a comment addresses. Idempotent — re-saving the same section returns the review with an idempotent: true flag. Requires author role or higher. An audit trail entry is created for non-idempotent changes.

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
{
  
"section": "vuln_discussion",
  
"audit_comment": "Re-categorized after author clarification."
}

Responses

Section updated (or idempotent no-op)

application/json
JSON
{
  
"review": {
  
  
"id": 44,
  
  
"action": "comment",
  
  
"comment": "This requirement needs clarification...",
  
  
"rule_id": 812,
  
  
"section": "vuln_discussion",
  
  
"triage_status": "pending",
  
  
"created_at": "2026-05-19T16:15:00Z",
  
  
"reactions": {
  
  
  
"up": 1,
  
  
  
"down": 0
  
  
}
  
}
}

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)