ONLYOFFICE Docs v7.3 released: enhanced forms, SmartArt, new security settings, Watch Window, and more
ONLYOFFICE Docs v7.3 released

POST startbackup 500 error

Docs API
#1

Hi,

I’m having issue when trying to do a POST with API startbackup.
Here is my POST example using Basic Auth.

curl --location --request POST 'onlyoffice-myserver/api/2.0/portal/startbackup' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic xxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--data-raw '{
  "storageType": "documents",
  "storageParams": [
    {
      "Key": null,
      "Value": null
    }
  ],
  "backupMail": true
}'

The following error comes back
500 “The given key ‘folderId’ was not present in the dictionary.”
I’m not really sure what that means or what to try next.

Setup
OnlyOffice Workspaces with Docker configuration.
Version 12.0.1.1748

#2

Hello @DownRight770

Here is the instruction on how to use this API method:

  1. Obtain the authorization token https://api.onlyoffice.com/portals/auth
  2. Create a request to Backup Service https://api.onlyoffice.com/portals/method/portal/post/api/2.0/portal/startbackup

Here, make sure you enter correct ‘Value’, please see this example:

"Key": "folderId",
"Value": 3

The ‘Value’ here is the id of a folder in Documents module.
To learn the id of the specific folder you would like to make a backup to, do the following: go to your portal => Documents module => open the desired folder => look at the browser link, it will have the folder id at the end. Use it as 'Value '.

I hope that helps.

#3

@Constantine Thank you for the response the auth worked for me after testing.
I’m wondering if I’m able to do a full backup and not a selected folder.
I would use the integrations to backup but I want my stuff going out to wasabi.

#4

This method already does backup of the whole portal. The "Key" and "Value" are responsible for the backup saving destination, i.e. you are choosing the folder where to save the backup to.