Create the backup schedule

POST /api/2.0/portal/createbackupschedule

Request

Creates the backup schedule for 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

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

backupsStoredinteger

Maximum number of backup stored copies

cronParamsunknown

Cron parameters

backupMailboolean

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

Examples

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

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