getAllBackupStorages
StorageArrayWrapper getAllBackupStorages(dump)
GET /api/2.0/settings/storage/backup
Get the backup storages
Returns the storages that can hold portal backups, with the one the saved backup schedule writes to marked as current and its parameters filled in from that schedule; when no schedule is saved, or when the schedule stores backups somewhere else than a third-party provider, none of the entries is current. Each entry has the same shape as in GET api/2.0/settings/storage: identifier, title, the authentication keys the provider expects, and isSet telling whether those keys are filled in on the server. Pass dump=true to read the schedule of the whole server instead of the one of the current portal, which only makes sense on a server installation. The caller needs the permission to edit portal settings, which in practice means the portal owner or a DocSpace admin, and on an installation that is not a server one the call is also refused unless backup is available there. Nothing is written and the call is safe to repeat. This operation says nothing about where the portal data itself lives; the backup schedule is configured through the backup API, and the storage of the documents through PUT api/2.0/settings/storage.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| dump | query | Boolean | Whether the schedule of the whole server is read instead of the one of the current portal. It only changes which schedule marks an entry as current; the list of storages itself is the same either way, and the flag makes sense only on a self-hosted installation. | [optional] [example: true] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The storages that can hold portal backups, with the scheduled one marked as current | StorageArrayWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 403 | The caller may not edit portal settings, or backup is not available on this installation | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 400 | Bad Request. | ErrorApiResponse | - |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: Not defined
- Accept: application/json