Skip to content

Update component attributes

PUT
/components/{componentId}

Updates component metadata (name, prefix, version, release, description). Requires admin role on the parent project. Does not modify rules — use the rule endpoints for rule content 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
{
  
"component": {
  
  
"version": 2,
  
  
"release": 1
  
}
}

Responses

Component updated

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

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)