Skip to content

Create a review on a rule (comment, request_review, etc.)

POST
/rules/{ruleId}/reviews

Posts a new comment or review action on the specified rule. Requires viewer role or above on the component.

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
{
  
"review": {
  
  
"action": "comment",
  
  
"comment": "The fix text should reference the container runtime configuration file.",
  
  
"section": "fixtext",
  
  
"responding_to_review_id": 43
  
}
}

Responses

Review created

application/json
JSON
{
  
"toast": {
  
  
"title": "User updated.",
  
  
"message": [
  
  
  
[
  
  
  
  
"Successfully updated user."
  
  
  
]
  
  
],
  
  
"variant": "success"
  
}
}

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)