How to retrieve the existing embed secret key via REST API in Bold BI?

Overview

Retrieving the existing embed secret key for a Bold BI server instance can be accomplished through a REST API call. This key is essential for embedding Bold BI dashboards and widgets into other applications securely.

API Details

Request

To fetch the embed secret key, you will need to make a GET request to the following URL:

http://localhost:62062/bi/api/site/site1/v5.0/settings/embed-secret

Headers

The request must include an authorization header with a bearer token:

Authorization: Bearer <Access_Token>

The access token must be generated within the Bold BI application. For instructions on generating an access token, please refer to the Bold BI - Password Authentication API.

Response Structure

The API response will be in JSON format containing the following fields:

• ApiStatus: The status of the API call.
• Data: An object containing:
  • Enabled: Indicates if the embed feature is enabled.
  • EmbedSecret: The actual embed secret key.
• Status: The status of the request.
• StatusMessage: A message providing additional information about the request status.

Sample Response

{
    "ApiStatus": "Success",
    "Data": {
        "Enabled": "True",
        "EmbedSecret": "Your-Embed-Secret-Key"
    },
    "Status": "200",
    "StatusMessage": "Embed secret key retrieved successfully."
}

Additional References

For more detailed information on the REST API and generating access tokens, please refer to the following documentation:

• API Reference v5.0 – REST API | Bold BI for Developers

Please ensure that you have the appropriate permissions and that your Bold BI server is properly configured to handle API requests.