Category / Section
How to get the list of site setting details for the specific site using REST API
Published:
This article provides comprehensive guidance on how to retrieve the list of site setting details for a specific site using the REST API in Bold BI. Administrative rights are required to access site settings.
Authorization
To execute this action, please ensure that an access token is included in your request header. For details on obtaining the access token, please refer to the relevant documentation here.
Authorization: bearer <token>
Self-Hosted Server
For self-hosted instances, use the following endpoint:
https://{yourdomain}/bi/api/site/<site_identifier>/v5.0/settings/site
Bold BI Cloud Server
For Bold BI Cloud instances, the endpoint is:
https://{yourdomain}/bi/api/v5.0/settings/site
Request Type
- GET: This request type is used to retrieve the list of site setting details.
Example Request
Here is an example of how to structure your GET request:
For more information on Settings, please refer to this documentation.
Responses
- 200: Site setting details have been retrieved successfully.
- 401: Access denied.
- 405: Request type was not GET.
- 417: Failed to retrieve site settings details.