Category / Section
How to Update the License Key of a Bold BI deployment using Rest API
Published:
This article provides instructions on how to update the license for Bold BI On-Premise Server through a REST API call. This API requires authentication using client credentials (client ID and secret) on the Bold ID server.
Updating the License
You can update the license for Bold BI On-Premise Server by utilizing the following API.
Method | URL |
---|---|
POST | /v2.0/administration/license |
Authentication
To obtain the authentication token, please refer to this link. The access token must be included in the request header as shown below.
Header Name | Header Value |
---|---|
Authorization | Bearer <access_token> |
Request Body
Parameter Name | Type | Required | Comments |
---|---|---|---|
TenantType | Enum Type | Yes | 3 – BoldBIOnPremise , 4 - BoldReportsOnPremise |
LicenseKey | String | Yes | Offline unlock key |
Sample Request
Sample Response
{
"api_status": true,
"data": {
"product_name": "Embedded BI",
"email": "john.doe@example.com",
"subscription": "https://app.boldid.net/sites/1288ce34-e439-4526-ac8c-065464214f0d/subscription",
"plan_name": "Bold BI Standard",
"expiry_date": "2024/03/27 09:49:28 AM",
"license_version": "6.1.8"
},
"status": true,
"status_message": "The license was updated successfully."
}
Response Codes
HTTP Status Code | Description | Message |
---|---|---|
401 | Unauthorized | - |
500 | Internal server error | Failed to update the license. |
200 | OK | The license was updated successfully. |