Category / Section
How to Get the License Information of a Bold BI deployment using Rest API
Published:
This article provides instructions on how to retrieve the license details of your Bold BI On-Premise through a REST API call. The API requires client credentials (client ID and secret) for authentication.
Retrieving the License
To obtain the license for Bold BI On-Premise Server, utilize the following API.
Method | URL |
---|---|
GET | /v2.0/administration/license |
Authentication
To acquire the authentication token, 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> |
Sample Request
Sample Response
{
"api_status": true,
"data": {
"is_common_login": false,
"product": [
{
"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": "11/01/2024 01:02 PM",
"license_version": "6.15.11"
}
]
},
"status": true,
"status_message": "License returned successfully."
}
Response Codes
HTTP Status Code | Description | Message |
---|---|---|
401 | Unauthorized | - |
400 | Bad Request | License not yet activated. |
200 | OK | License returned successfully. |