Start the restoring process

POST /api/2.0/backup/startrestore

Request

Starts the data restoring process 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

Restoring parameters

backupIdstring

Backup ID

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

notifyboolean

Notifies users about portal restoring process or not

Examples

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

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

curl --request POST \
  --url https://example.com/api/2.0/backup/startrestore \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "backupId": "some text",
  "storageParams": [
    {
      "value": {
        "key": {
          "int": 1234,
          "string": "some text",
          "boolean": true
        },
        "value": {
          "int": 1234,
          "string": "some text",
          "boolean": true
        }
      }
    }
  ],
  "notify": 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

400

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 file or folder was not found