Skip to content

Import a JSON archive backup

POST
/projects/{projectId}/import_backup

Imports components, rules, reviews, and memberships from a JSON archive (.zip) into the project, replacing or augmenting existing content. Returns 200 with a toast + summary. Requires admin role on the project. The archive must have been created by the json_archive export format.

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

JSON archive .zip file from a previous export.

Format"binary"

Responses

Backup imported (default mode) or dry-run preview completed

application/json
JSON
{
  
"toast": {
  
  
"title": "Backup restored.",
  
  
"message": [
  
  
  
"Backup restored successfully."
  
  
],
  
  
"variant": "success"
  
},
  
"summary": {
  
  
"components_imported": 2,
  
  
"rules_imported": 264,
  
  
"satisfactions_imported": 12,
  
  
"reviews_imported": 48,
  
  
"memberships_imported": 3,
  
  
"srgs_imported": 1,
  
  
"component_details": [
  
  
  
{
  
  
  
  
"name": "Photon OS 3",
  
  
  
  
"rule_count": 132,
  
  
  
  
"srg_title": "General Purpose Operating System SRG",
  
  
  
  
"srg_version": "V3R3"
  
  
  
}
  
  
]
  
},
  
"warnings": [
  
]
}

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)