Skip to main content

getCapabilities

ArrayArrayWrapper getCapabilities()

GET /api/2.0/files/thirdparty/capabilities

Get third-party provider 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.

Parameters​

This endpoint does not need any parameter.

Responses​

Status codeDescriptionTypeResponse headers
200The provider keys, each with the OAuth client ID and redirect URL where the service uses OAuthArrayArrayWrapperX-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
401UnauthorizedErrorApiResponse-
429Too Many Requests.ErrorApiResponseRetry-After
500Internal Server Error.ErrorApiResponse-
502Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON.--
503Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON.--

Return type​

ArrayArrayWrapper

Authorization​

Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json