You are currently browsing legacy 3.0 version of documentation. Click here to switch to the newest 5.1 version.

We can help you with migration to the latest RavenDB

Contact Us Now
see on GitHub

Commands: How to start backup or restore operations?

StartBackup 

curl \
	http://{serverName}/databases/{databaseName}/admin/backup?incremental={incremental} \
	-X POST

Request

Payload Description
BackupLocation Location of backup
DatabaseDocument DatabaseDocument that will be stored with backup in 'Database.Document' file. Pass null to use the one from <system> database.
WARNING: Database configuration document may contain sensitive data which will be decrypted and stored in backup.
Query parameter Required Description
incremental No Indicates if backup is incremental.

Response

Status code Description
201 OK

Example

curl -X POST "http://localhost:8080/databases/Northwind/admin/backup?incremental=false" \
 -d "{\"BackupLocation\":\"c:\\temp\\backup\\Northwind\\\",\"DatabaseDocument\":{\"SecuredSettings\":{},\"Settings\":{},\"Disabled\":false,\"Id\":null}}"
< HTTP/1.1 201 Created

StartRestore 

curl \
	http://{serverName}/admin/restore \
	-X POST

Request

Payload
DatabaseRestoreRequest

Response

Status code Description
200 OK
Return Value Description
OperationId Operation id

Example

curl -X POST "http://localhost:8080/admin/restore" \
 -d "{\"DatabaseName\":\"NewNorthwind\",\"BackupLocation\":\"c:\\temp\\backup\\Northwind\\\",\"IndexesLocation\":null,\"RestoreStartTimeout\":null,\"DatabaseLocation\":\"~\\Databases\\NewNorthwind\\\",\"Defrag\":false,\"JournalsLocation\":null}"
< HTTP/1.1 200 OK
{"OperationId":2}