Start the backup

POST /api/2.0/backup/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 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 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.

storageParamsobject

Storage parameters

dumpboolean

Specifies if a dump will be created or not

Examples

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

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

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

Responses

200

Backup progress: completed or not, progress percentage, error, tenant ID, backup progress item (Backup, Restore, Transfer), link

isCompletedboolean

progressintegerformat: int32

errorstring

linkstring

tenantIdintegerformat: int32

backupProgressEnumone of

.enum of string

[Backup - Backup, Restore - Restore, Transfer - Transfer]

Can be one of: Backup, Restore, Transfer.

.enum of integer

[0 - Backup, 1 - Restore, 2 - Transfer]

Can be one of: 0, 1, 2.

taskIdstring

401

Unauthorized

403

Forbidden