Skip to content

Apply changes from a spreadsheet import​

PATCH
/components/{componentId}/apply_spreadsheet_update

Applies rule updates from an uploaded spreadsheet (CSV/XLSX) to the component. Requires admin role on the component. Use the preview endpoint first to review changes before applying. Creates audit trail entries for each modified rule.

Authorizations​

cookieAuth
Type
API Key (cookie: _vulcan_session)
or
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​

multipart/form-data

CSV or XLSX spreadsheet file containing rule updates.

Format"binary"

Responses​

Spreadsheet changes applied successfully

application/json
JSON
{
  
"toast": {
  
  
"title": "Spreadsheet applied.",
  
  
"message": [
  
  
  
"Successfully updated 12 rules from spreadsheet."
  
  
],
  
  
"variant": "success"
  
}
}

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)