getEnableWhitelabel
BooleanWrapper getEnableWhitelabel()
GET /api/2.0/settings/enablewhitelabel
Check the white label availability
Reports whether branding may be configured for the current portal at all, which is the check to make before offering the rebranding interface or calling any of the save operations under api/2.0/settings/whitelabel. Requires a DocSpace administrator. The call is read-only and idempotent. The answer is true only when both conditions hold: the branding section is not switched off in the installation configuration, and the portal's current plan includes customization. It comes back as false on a plan without customization, which is exactly the case in which POST api/2.0/settings/whitelabel/logos/save, POST api/2.0/settings/whitelabel/logos/savefromfiles and POST api/2.0/settings/whitelabel/logotext/save are refused as payment required. The restore operations do not depend on this flag and stay available, so a portal that loses branding can still be reset to the built-in logos and wordmark. The flag says nothing about the installation-wide default branding, which additionally needs a server installation with unrestricted space access, and nothing about the company details and help links under api/2.0/settings/rebranding.
Parameters
This endpoint does not need any parameter.
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | true when branding is enabled in this installation and included in the portal's plan | BooleanWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 403 | The caller has no portal-settings right | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | 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