Skip to content

Full replacement of rule attributes

PUT
/rules/{ruleId}

Full replacement — all fields required. Updates rule fields. Requires author or admin role 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
{
  
"rule": {
  
  
"status": "Applicable - Configurable",
  
  
"title": "The container platform must enforce approved authorizations.",
  
  
"fixtext": "Configure the container platform to enforce approved authorizations.",
  
  
"vendor_comments": "Met by the recommended runtime configuration."
  
}
}

Responses

Rule updated

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)