Start the backup

POST /api/2.0/portal/startbackup

Request

Starts the backup of the current portal with the parameters specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

storageTypeinteger

Storage type ("Documents", "ThridpartyDocuments", "CustomCloud", "Local", "DataStore", or "ThirdPartyConsumer")

storageParamsarray of object

Storage parameters

backupMailboolean

Specifies if the mails will be included into the backup or not

Examples

POST /api/2.0/portal/startbackup HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request POST \
  --url https://example.com/api/2.0/portal/startbackup \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Backup progress

IsCompletedboolean

Progressintegerformat: int32

Errorstring

Linkstring

401

Unauthorized