Skip to main content
POST
Restore a catalog from a zip backup

Authorizations

x-api-key
string
header
required

Optional API key for authentication (enabled via application.yaml)

Path Parameters

name
string
required

Target catalog name. Uncataloged (any case) is refused.

Pattern: ^[A-Za-z0-9_-]+$

Query Parameters

mode
enum<string>
default:new
Available options:
new,
overwrite
confirm
string

Required for mode=overwrite; must equal the catalog name.

restoreState
boolean
default:true

false skips every tap's incremental state (for a copy that should start from scratch).

Body

multipart/form-data
file
file
required

The catalog archive (zip, at most 1000 entries and 50 MB uncompressed).

Response

Every member restored

restored
object
skipped
string[]

Validation-schema objects that already existed on this install and were kept.

failed
object[]
missingSecrets
object[]

Secrets the archive's items reference that do not exist on this install. Create them before enabling the items. Only secrets the key may read are checked; the others are named in warnings as not checked.

warnings
string[]
tapsDisabled
boolean

Always true; restored taps are saved disabled.

stateRestored
boolean

True when at least one tap's incremental state was restored.