getIsDefaultGreetingSettings
BooleanWrapper getIsDefaultGreetingSettings()
GET /api/2.0/settings/greetingsettings/isdefault
Check the default greeting settings
Reports whether the current portal still shows the built-in greeting caption instead of a title of its own. The check is read-only and open to any authenticated user, with no administrative right required. It answers true while no title is stored for the portal - the state after POST api/2.0/settings/greetingsettings/restore on an installation that configures no portal name, and also after saving an empty title - and false as soon as a non-empty title has been saved. Use it together with GET api/2.0/settings/greetingsettings: that operation substitutes the localized default caption for a missing title, so only these two calls together separate a default greeting from a custom one that happens to repeat the default wording. The answer covers the greeting title alone; whether the white-label logos and logo text are still the default ones is reported by GET api/2.0/settings/whitelabel/logos/isdefault and GET api/2.0/settings/whitelabel/logotext/isdefault.
Parameters
This endpoint does not need any parameter.
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | Boolean value: true if the portal has no greeting title of its own and the built-in default caption is shown | BooleanWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 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