Preview changes from a spreadsheet import
POST
/components/{componentId}/preview_spreadsheet_update
Parses an uploaded spreadsheet (CSV/XLSX) and returns a diff of what would change if applied, without modifying any data. Returns four arrays: updated (rules with changes), unchanged (no diff), skipped_locked (locked rules or inherited rules), and warnings (SRG IDs not found). Requires author 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
multipart/form-data
CSV or XLSX spreadsheet file containing rule updates.
Format
"binary"Responses
Preview of changes grouped by outcome
application/json
JSON "updated": [ { "rule_id": "000050", "srg_id": "SRG-APP-000014-CTR-000035", "changes": { "fixtext": [ "Old fix text", "Updated fix text" ] } } ], "unchanged": [ { "rule_id": "000051", "srg_id": "SRG-APP-000023-CTR-000040", "reason": "no changes" } ], "skipped_locked": [ { "rule_id": "000001", "srg_id": "SRG-APP-000001-CTR-000001", "reason": "locked" } ], "warnings": [ ]
{
}