Create the backup schedule

POST /api/2.0/backup/createbackupschedule

Request

Creates the backup schedule 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 cookie parameter called asc_auth_key.

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

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Backup schedule parameters

storageTypeone of

.enum of string

[Documents - Documents, ThridpartyDocuments - Thridparty documents, CustomCloud - Custom cloud, Local - Local, DataStore - Data store, ThirdPartyConsumer - Thirdparty consumer]

Can be one of: Documents, ThridpartyDocuments, CustomCloud, Local, DataStore, ThirdPartyConsumer.

.enum of integer

[0 - Documents, 1 - Thridparty documents, 2 - Custom cloud, 3 - Local, 4 - Data store, 5 - Thirdparty consumer]

Can be one of: 0, 1, 2, 3, 4, 5.

storageParamsarray of object

Storage parameters

keyunknown

valueunknown

backupsStoredintegerformat: int32

Maximum number of the stored backup copies

cronParamsobject

Cron parameters

periodone of

.enum of string

[EveryDay - Every day, EveryWeek - Every week, EveryMonth - Every month]

Can be one of: EveryDay, EveryWeek, EveryMonth.

.enum of integer

[0 - Every day, 1 - Every week, 2 - Every month]

Can be one of: 0, 1, 2.

hourintegerformat: int32

Hour

dayintegerformat: int32

Day

dumpboolean

Specifies if a dump will be created or not

Examples

POST /api/2.0/backup/createbackupschedule HTTP/1.1
Accept: application/json
Content-Length: 327
Content-Type: application/json
Host: example.com

{
  "storageParams": [
    {
      "value": {
        "key": {
          "int": 1234,
          "string": "some text",
          "boolean": true
        },
        "value": {
          "int": 1234,
          "string": "some text",
          "boolean": true
        }
      }
    }
  ],
  "backupsStored": 1234,
  "dump": true
}

curl --request POST \
  --url https://example.com/api/2.0/backup/createbackupschedule \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "storageParams": [
    {
      "value": {
        "key": {
          "int": 1234,
          "string": "some text",
          "boolean": true
        },
        "value": {
          "int": 1234,
          "string": "some text",
          "boolean": true
        }
      }
    }
  ],
  "backupsStored": 1234,
  "dump": true
}'

Responses

200

Boolean value: true if the operation is successful

400

BackupStored must be 1 - 30 or backup can not start as dump

401

Unauthorized

402

Your pricing plan does not support this option

403

You don't have enough permission to create

404

The required folder was not found