Queue a backup or restore after accepting its content keys

POST

/api/admin/tenant-backups/{operationId}/start

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/tenant-backups/example/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "challengeId": "example", "revision": 1 }'

Requires admin:backups:read, admin:backups:manage, the operation-specific admin:backups:export or admin:backups:import permission, and a human Admin session with MFA authenticated within five minutes. Sensitive selections also require admin:backups:sensitive. Export operations supply one challengeId. Import operations supply one inputId/challengeId pair for every pinned input in request order. Every challenge must be accepted, unexpired, and bound to that input. Import starts also require the destination tenant to be in the unpublished provisioning lifecycle state. The canonical issuer and running product version must still match the fixed request. Queues preparation atomically; does not indicate artifact completion. Repeated, stale, or active-destination starts return 409.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

operationId

required

string

Request Body ^required

Media type application/json

One of:

object

object

challengeId

required

string

/^[A-Za-z0-9_.:-]{1,256}$/

revision

required

integer

key

additional properties

object

object

challenges

required

Array<object>

>= 1 items <= 32 items

object

inputId

required

string

/^[A-Za-z0-9_.:-]{1,256}$/

challengeId

required

string

/^[A-Za-z0-9_.:-]{1,256}$/

key

additional properties

revision

required

integer

key

additional properties

Example ^generated

{
  "challengeId": "example",
  "revision": 1
}

Responses

202

Preparation is queued.

Media type application/json

object

id

required

string

state

required

string

Allowed value: queued

phase

required

string

Allowed value: prepare

revision

required

integer

>= 1

key

additional properties

Example

{
  "state": "queued",
  "phase": "prepare"
}

400

The request was rejected.

Media type application/json

object

error

required

string

key

additional properties

Example ^generated

{
  "error": "example"
}

403

The request was rejected.

Media type application/json

object

error

required

string

key

additional properties

Example ^generated

{
  "error": "example"
}

404

The request was rejected.

Media type application/json

object

error

required

string

key

additional properties

Example ^generated

{
  "error": "example"
}

409

The request was rejected.

Media type application/json

object

error

required

string

key

additional properties

Example ^generated

{
  "error": "example"
}

413

Request body exceeds 4096 bytes.

503

Required backup storage, key service, or audit service is unavailable. Missing artifact storage returns backup_storage_unavailable.

Media type application/json

object

error

required

string

key

additional properties

Example ^generated

{
  "error": "example"
}