Backup:Create Backup

Search (SHIFT+S)



New in this release

Create Backup

POST /backupset/backup/

Limitations of the argument: 1. Maximum length is 200 characters 2. Underscore "_" is not supported 3. Any character that is not supported by Linux file name is not allowed


Query Parameters

tagThe name of backup. This parameter is optional, default is timestamp(for example 20140531193000).
forceIf true, will ignore the errors during the operation and force create backup, and return success if zk backup file and quorum db and geodb backup files create succeed, or else return failures and roolback. A probable use senario of this paramter is single node crash.

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • RESTRICTED_SYSTEM_ADMIN

Request Payload

No Request Payload


Response Body

Server response indicating if the operation succeeds.

Notes: