All URIs are relative to https://your-docspace.onlyoffice.com
| Method | HTTP request | Description |
|---|---|---|
| delete_third_party | DELETE /api/2.0/files/thirdparty/{providerId} | Remove a third-party account |
| get_all_providers | GET /api/2.0/files/thirdparty/providers | Get all third-party providers |
| get_backup_third_party_account | GET /api/2.0/files/thirdparty/backup | Get the third-party backup folder |
| get_capabilities | GET /api/2.0/files/thirdparty/capabilities | Get third-party provider capabilities |
| get_common_third_party_folders | GET /api/2.0/files/thirdparty/common | Get common third-party folders |
| get_third_party_accounts | GET /api/2.0/files/thirdparty | Get the third-party accounts |
| save_third_party | POST /api/2.0/files/thirdparty | Connect a third-party account |
| save_third_party_backup | POST /api/2.0/files/thirdparty/backup | Connect the third-party backup storage |
StringWrapper delete_third_party(provider_id)
Disconnects a third-party storage account from the portal and returns the ID of the folder that stood for it,
in the provider-accountId form the Files operations use for third-party entries. Take providerId from
GET api/2.0/files/thirdparty: it is the numeric account ID, not that composed folder ID. The member who
connected the account can remove it; another member's request is refused unless they hold delete rights on the
folder it stands for. Nothing is deleted at the storage service: the files stay with the provider, and what
goes away is the portal's link to them together with the stored credentials, the sharing records and the tags
kept for its entries. An account a room was created on is refused with 403 while the room exists: delete the
room instead, which disconnects the account along with it. When the account being
removed is the one connected for backups by POST api/2.0/files/thirdparty/backup, its backup schedule is
deleted as well. The removal cannot be repeated: once the account is gone the same ID is refused rather than
confirmed, so treat the first successful answer as the record of it.
For more information, see api.onlyoffice.com.
| Name | Type | Description | Notes |
|---|---|---|---|
| provider_id | int | The ID of the connected third-party storage account, as providerId of GET api/2.0/files/thirdparty. |
Basic, OAuth2, ApiKeyBearer, asc_auth_key, Bearer, OpenId
import docspace_api_sdk
from docspace_api_sdk.models.string_wrapper import StringWrapper
from docspace_api_sdk.rest import ApiException
from pprint import pprint
configuration = docspace_api_sdk.Configuration(
host = "https://your-docspace.onlyoffice.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): Bearer
configuration = docspace_api_sdk.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with docspace_api_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = docspace_api_sdk.ThirdPartyIntegrationApi(api_client)
provider_id = 12 # int | The ID of the connected third-party storage account, as `providerId` of `GET api/2.0/files/thirdparty`.
try:
# Remove a third-party account
api_response = api_instance.delete_third_party(provider_id)
print("The response of ThirdPartyIntegrationApi->delete_third_party:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ThirdPartyIntegrationApi->delete_third_party: %s\n" % e)- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The ID of the folder that stood for the removed account | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset - |
| 403 | The caller neither connected the account nor has the right to delete the folder it stands for | - |
| 404 | No third-party account with this ID exists on the portal | - |
| 401 | Unauthorized | - |
| 429 | Too Many Requests. | * Retry-After - |
| 500 | Internal Server Error. | - |
| 400 | Bad Request. | - |
| 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. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProviderArrayWrapper get_all_providers(excludewebdav=excludewebdav)
Lists the third-party storage services this portal can connect, with everything a connection form needs: the
display name, the key to send as providerKey, whether the service authenticates through OAuth 2.0, the OAuth
client ID and redirect URL where it does, and whether the caller has to supply the server address. Several
WebDAV presets share the key WebDav and are told apart by their names, so keep the name the caller chose
next to the key when building the request. Pass excludewebdav=true to drop the whole WebDAV family,
including the kDrive and Yandex presets, and keep only the OAuth services. The call is read-only. An empty
array is a normal answer: it is what a guest gets, and what everyone gets while the portal-wide third-party
switch is off (PUT api/2.0/files/thirdparty). The connected flag of an element says the service is
available on this portal, not that an account of it exists - the caller's own accounts are listed by
GET api/2.0/files/thirdparty.
For more information, see api.onlyoffice.com.
| Name | Type | Description | Notes |
|---|---|---|---|
| excludewebdav | bool | Set to true to leave out the whole WebDAV family, the kDrive and Yandex presets included, and keep only the services that authenticate through OAuth 2.0; false lists all of them. | [optional] |
Basic, OAuth2, ApiKeyBearer, asc_auth_key, Bearer, OpenId
import docspace_api_sdk
from docspace_api_sdk.models.provider_array_wrapper import ProviderArrayWrapper
from docspace_api_sdk.rest import ApiException
from pprint import pprint
configuration = docspace_api_sdk.Configuration(
host = "https://your-docspace.onlyoffice.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): Bearer
configuration = docspace_api_sdk.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with docspace_api_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = docspace_api_sdk.ThirdPartyIntegrationApi(api_client)
excludewebdav = false # bool | Set to true to leave out the whole WebDAV family, the kDrive and Yandex presets included, and keep only the services that authenticate through OAuth 2.0; false lists all of them. (optional)
try:
# Get all third-party providers
api_response = api_instance.get_all_providers(excludewebdav=excludewebdav)
print("The response of ThirdPartyIntegrationApi->get_all_providers:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ThirdPartyIntegrationApi->get_all_providers: %s\n" % e)- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The storage services this portal can connect | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset - |
| 401 | Unauthorized | - |
| 429 | Too Many Requests. | * Retry-After - |
| 500 | Internal Server Error. | - |
| 400 | Bad Request. | - |
| 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. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ThirdPartyFolderWrapper get_backup_third_party_account()
Returns the folder of the third-party storage account the portal keeps for backups, so a caller can check
where scheduled and manual backups are written. There is at most one such account per portal, connected by an
administrator through POST api/2.0/files/thirdparty/backup, and it is deliberately kept out of the personal
list of GET api/2.0/files/thirdparty. Any authenticated member may ask, and the call is read-only. The body
is null, with a successful status, in two situations the answer does not distinguish: no backup account has
been connected, and the caller has no read access to the folder of the one that is. When a folder does come
back, its id is the string ID of a third-party folder and can be used with the folder operations that accept
one, and its title is the title the account was saved under. Connecting a different account through the
backup operation replaces this one rather than adding a second, and
DELETE api/2.0/files/thirdparty/{providerId} removes it.
For more information, see api.onlyoffice.com.
This endpoint does not need any parameter.
Basic, OAuth2, ApiKeyBearer, asc_auth_key, Bearer, OpenId
import docspace_api_sdk
from docspace_api_sdk.models.third_party_folder_wrapper import ThirdPartyFolderWrapper
from docspace_api_sdk.rest import ApiException
from pprint import pprint
configuration = docspace_api_sdk.Configuration(
host = "https://your-docspace.onlyoffice.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): Bearer
configuration = docspace_api_sdk.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with docspace_api_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = docspace_api_sdk.ThirdPartyIntegrationApi(api_client)
try:
# Get the third-party backup folder
api_response = api_instance.get_backup_third_party_account()
print("The response of ThirdPartyIntegrationApi->get_backup_third_party_account:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ThirdPartyIntegrationApi->get_backup_third_party_account: %s\n" % e)- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The root folder of the backup storage account, or null when none is connected | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset - |
| 401 | Unauthorized | - |
| 429 | Too Many Requests. | * Retry-After - |
| 500 | Internal Server Error. | - |
| 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. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ArrayArrayWrapper get_capabilities()
Lists the third-party storage services this portal is able to connect, in the compact form a connection dialog
needs. Every element is itself an array whose first item is the provider key accepted as providerKey by
POST api/2.0/files/thirdparty. For the services that authenticate through OAuth 2.0 (Box, DropboxV2,
GoogleDrive, OneDrive) the second and third items are the OAuth client ID and the redirect URL this portal
is registered with, so the caller can build the consent screen URL itself; the services that authenticate by
login and password (SharePoint, WebDav, kDrive, Yandex) contribute a single-item array. Only the
services enabled in the portal configuration are listed, and an OAuth service whose application is not
configured is left out. The call is read-only. An empty array is a normal answer rather than a failure: it is
what a guest gets, and what everyone gets while the portal-wide third-party switch is off
(PUT api/2.0/files/thirdparty). For display names, the WebDAV presets and the flags a connection form needs,
use GET api/2.0/files/thirdparty/providers instead.
For more information, see api.onlyoffice.com.
This endpoint does not need any parameter.
Basic, OAuth2, ApiKeyBearer, asc_auth_key, Bearer, OpenId
import docspace_api_sdk
from docspace_api_sdk.models.array_array_wrapper import ArrayArrayWrapper
from docspace_api_sdk.rest import ApiException
from pprint import pprint
configuration = docspace_api_sdk.Configuration(
host = "https://your-docspace.onlyoffice.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): Bearer
configuration = docspace_api_sdk.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with docspace_api_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = docspace_api_sdk.ThirdPartyIntegrationApi(api_client)
try:
# Get third-party provider capabilities
api_response = api_instance.get_capabilities()
print("The response of ThirdPartyIntegrationApi->get_capabilities:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ThirdPartyIntegrationApi->get_capabilities: %s\n" % e)- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The provider keys, each with the OAuth client ID and redirect URL where the service uses OAuth | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset - |
| 401 | Unauthorized | - |
| 429 | Too Many Requests. | * Retry-After - |
| 500 | Internal Server Error. | - |
| 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. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ThirdPartyFolderArrayWrapper get_common_third_party_folders()
Lists the third-party storage accounts attached to the legacy Common section, as folder entries that can be
browsed with the usual folder operations. Each entry stands for a whole connected account: its title is the
account title, and providerId and providerKey identify the account behind it. Only accounts whose owner
the caller may read are included, so the answer differs from one member to another. The call is read-only and
returns a plain array with no paging. An empty array is the expected answer in most portals and does not mean
an error: accounts connected by POST api/2.0/files/thirdparty are attached to the Rooms section, not to
Common, so only accounts inherited from an older portal appear here. The list is also empty while the
portal-wide third-party switch is off (PUT api/2.0/files/thirdparty) and when no storage service is
configured. For the accounts the caller owns, regardless of where they are attached, use
GET api/2.0/files/thirdparty.
For more information, see api.onlyoffice.com.
This endpoint does not need any parameter.
Basic, OAuth2, ApiKeyBearer, asc_auth_key, Bearer, OpenId
import docspace_api_sdk
from docspace_api_sdk.models.third_party_folder_array_wrapper import ThirdPartyFolderArrayWrapper
from docspace_api_sdk.rest import ApiException
from pprint import pprint
configuration = docspace_api_sdk.Configuration(
host = "https://your-docspace.onlyoffice.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): Bearer
configuration = docspace_api_sdk.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with docspace_api_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = docspace_api_sdk.ThirdPartyIntegrationApi(api_client)
try:
# Get common third-party folders
api_response = api_instance.get_common_third_party_folders()
print("The response of ThirdPartyIntegrationApi->get_common_third_party_folders:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ThirdPartyIntegrationApi->get_common_third_party_folders: %s\n" % e)- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The third-party accounts attached to the Common section, as folder entries | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset - |
| 401 | Unauthorized | - |
| 429 | Too Many Requests. | * Retry-After - |
| 500 | Internal Server Error. | - |
| 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. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ThirdPartyAccountArrayWrapper get_third_party_accounts()
Lists the third-party storage accounts the caller has connected, one element per account, with the title it
was saved under, the storage service behind it and the portal section it is attached to. Accounts connected by
other members are not included, and neither is the portal backup account of
GET api/2.0/files/thirdparty/backup, even for an administrator. The providerId of an element is the value
to send to DELETE api/2.0/files/thirdparty/{providerId} and, as providerId in
POST api/2.0/files/thirdparty, the way to re-authenticate that same account instead of connecting a new one.
Credentials are never disclosed: auth_data comes back empty for every element. An element with
roomsStorage set is available as storage for a room, while corporate marks an account inherited from the
legacy Common section. The call is read-only, returns a plain array with no paging and no contractual
ordering, and answers with an empty array when the caller has connected nothing. To browse the content of an
account, take the folder ID from the answer of the operation that connected it or from
GET api/2.0/files/@root.
For more information, see api.onlyoffice.com.
This endpoint does not need any parameter.
Basic, OAuth2, ApiKeyBearer, asc_auth_key, Bearer, OpenId
import docspace_api_sdk
from docspace_api_sdk.models.third_party_account_array_wrapper import ThirdPartyAccountArrayWrapper
from docspace_api_sdk.rest import ApiException
from pprint import pprint
configuration = docspace_api_sdk.Configuration(
host = "https://your-docspace.onlyoffice.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): Bearer
configuration = docspace_api_sdk.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with docspace_api_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = docspace_api_sdk.ThirdPartyIntegrationApi(api_client)
try:
# Get the third-party accounts
api_response = api_instance.get_third_party_accounts()
print("The response of ThirdPartyIntegrationApi->get_third_party_accounts:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ThirdPartyIntegrationApi->get_third_party_accounts: %s\n" % e)- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The third-party accounts the caller has connected | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset - |
| 401 | Unauthorized | - |
| 429 | Too Many Requests. | * Retry-After - |
| 500 | Internal Server Error. | - |
| 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. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ThirdPartyFolderWrapper save_third_party(third_party_request_dto=third_party_request_dto)
Connects an account at a third-party storage service to the portal, or re-authenticates one that is already
connected, and returns the folder that now stands for its root. Send providerId to update an existing
account and omit it to connect a new one; the accepted providerKey values come from
GET api/2.0/files/thirdparty/providers. The credentials to send depend on the service: the OAuth services
take token, which is the authorization code from their consent screen and not an access token, while the
WebDAV family and SharePoint take login with password, plus url where the server address is not fixed.
Credentials are verified against the service before anything is stored, so a wrong password is refused and
nothing is saved. The caller needs the rights to create rooms, and the portal-wide third-party switch has to
be on, otherwise the call is refused. A new account is attached to the Rooms section and becomes available as
room storage for POST api/2.0/files/rooms/thirdparty/{id}. Connecting twice with the same title creates two
separate accounts.
For more information, see api.onlyoffice.com.
| Name | Type | Description | Notes |
|---|---|---|---|
| third_party_request_dto | ThirdPartyRequestDto | [optional] |
Basic, OAuth2, ApiKeyBearer, asc_auth_key, Bearer, OpenId
import docspace_api_sdk
from docspace_api_sdk.models.third_party_folder_wrapper import ThirdPartyFolderWrapper
from docspace_api_sdk.models.third_party_request_dto import ThirdPartyRequestDto
from docspace_api_sdk.rest import ApiException
from pprint import pprint
configuration = docspace_api_sdk.Configuration(
host = "https://your-docspace.onlyoffice.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): Bearer
configuration = docspace_api_sdk.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with docspace_api_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = docspace_api_sdk.ThirdPartyIntegrationApi(api_client)
third_party_request_dto = docspace_api_sdk.ThirdPartyRequestDto() # ThirdPartyRequestDto | (optional)
try:
# Connect a third-party account
api_response = api_instance.save_third_party(third_party_request_dto=third_party_request_dto)
print("The response of ThirdPartyIntegrationApi->save_third_party:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ThirdPartyIntegrationApi->save_third_party: %s\n" % e)- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The root folder of the connected account | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset - |
| 400 | The request body cannot be read or has no customerTitle or providerKey, providerId is neither a number nor a numeric string, or, for a new account, providerKey names no known storage service or the token or password the service needs is missing |
- |
| 403 | The caller cannot create rooms, the portal-wide third-party switch is off or no storage service is enabled, the title of a new account is empty once invalid characters are removed, the service rejects the credentials, or providerId names an account connected by another member |
- |
| 404 | providerId names no third-party account on the portal |
- |
| 500 | The storage service cannot be reached or fails while the credentials are checked | - |
| 401 | Unauthorized | - |
| 429 | Too Many Requests. | * Retry-After - |
| 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. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ThirdPartyFolderWrapper save_third_party_backup(third_party_backup_request_dto=third_party_backup_request_dto)
Connects the third-party storage account the portal writes its backups to, and returns the folder that stands
for its root. Only a portal administrator may call it, and the portal-wide third-party switch has to be on;
other callers are refused. The account is portal-wide and single: a second call does not add another one but
re-authenticates and retitles the existing one, which makes the operation safe to repeat with the same body.
The credentials follow the same rules as in POST api/2.0/files/thirdparty - an authorization code in token
for the OAuth services, login with password and, where the server address is not fixed, url for the
WebDAV family and SharePoint - and are verified against the service before anything is stored, so a wrong
password leaves the previous account untouched. The account is deliberately absent from
GET api/2.0/files/thirdparty; read it back with GET api/2.0/files/thirdparty/backup and remove it with
DELETE api/2.0/files/thirdparty/{providerId}.
For more information, see api.onlyoffice.com.
| Name | Type | Description | Notes |
|---|---|---|---|
| third_party_backup_request_dto | ThirdPartyBackupRequestDto | [optional] |
Basic, OAuth2, ApiKeyBearer, asc_auth_key, Bearer, OpenId
import docspace_api_sdk
from docspace_api_sdk.models.third_party_backup_request_dto import ThirdPartyBackupRequestDto
from docspace_api_sdk.models.third_party_folder_wrapper import ThirdPartyFolderWrapper
from docspace_api_sdk.rest import ApiException
from pprint import pprint
configuration = docspace_api_sdk.Configuration(
host = "https://your-docspace.onlyoffice.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): Bearer
configuration = docspace_api_sdk.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with docspace_api_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = docspace_api_sdk.ThirdPartyIntegrationApi(api_client)
third_party_backup_request_dto = docspace_api_sdk.ThirdPartyBackupRequestDto() # ThirdPartyBackupRequestDto | (optional)
try:
# Connect the third-party backup storage
api_response = api_instance.save_third_party_backup(third_party_backup_request_dto=third_party_backup_request_dto)
print("The response of ThirdPartyIntegrationApi->save_third_party_backup:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ThirdPartyIntegrationApi->save_third_party_backup: %s\n" % e)- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The root folder of the backup storage account | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-RateLimit-Reset - |
| 400 | The request body cannot be read, providerKey names no known storage service, or, while no backup account is connected yet, the token or password the service needs is missing |
- |
| 403 | The caller is not a DocSpace administrator, the portal-wide third-party switch is off or no storage service is enabled, the service rejects the credentials, or, while no backup account is connected yet, the title is empty once invalid characters are removed | - |
| 500 | The storage service cannot be reached or fails while the credentials are checked | - |
| 401 | Unauthorized | - |
| 429 | Too Many Requests. | * Retry-After - |
| 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. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]