Create a new project from a JSON archive backup

POST

/projects/create_from_backup

Creates a new project by restoring from a JSON archive (.zip). The archive must have been created by the json_archive export. Optionally override the project name. The archived project metadata (project.json) is restored onto the new project. The creating user becomes the project admin. Requires authentication.

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"

Override project name. Uses the archived name if omitted.

Responses

Dry-run returns preview (summary + warnings + project_defaults). Real create returns redirect URL + summary + toast.

Content-Type

application/json

{

  

"summary": {

  

  

"dry_run": true,

  

  

"components_imported": 2,

  

  

"rules_imported": 264,

  

  

"component_details": [

  

  

  

{

  

  

  

  

"name": "Photon OS 3",

  

  

  

  

"rule_count": 132

  

  

  

}

  

  

]

  

},

  

"warnings": [

  

],

  

"project_defaults": {

  

  

"name": "My Original Project",

  

  

"description": "A test project",

  

  

"visibility": "discoverable"

  

}

}

POST

/projects/create_from_backup

Playground

Server

Authorization

tokenAuth

Body

file*

name

Samples

Powered by VitePress OpenAPI