Skip to content

Post a public comment on a component

POST
/components/{componentId}/reviews

Creates a new comment-action review on the component (component-level comment) or on a specific rule within it. The component must have an open comment period (accepting_new_comments? check). Requires project membership with at least viewer role.

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 overall approach to container isolation is sound.",
  
  
"section": null
  
}
}

Responses

Comment created

application/json
JSON
{
  
"toast": {
  
  
"title": "Comment posted.",
  
  
"message": [
  
  
  
"Your comment has been submitted for review."
  
  
],
  
  
"variant": "success"
  
}
}

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)