How to Update the Tenant or Database Information Using Bold BI REST API

Published:

Bold BI REST API provides a way to update the site (also known as tenant) or database information. This process is authenticated using client credentials (client id and secret) and does not require an admin account in the Bold ID server.

API Endpoint

To update tenant details, use the following API:

METHOD	URL
PUT	/v2.0/tenants/{tenant_id}

To learn how to get the tenant ID, refer to this article.

Authorization

All REST API endpoints are protected using OAuth 2.0. To access this API, you need to get an access token. Please refer to this article to get the access token. You need to pass the authorization in the request header.

Header Name	Header Value
Authorization	Bearer <authentication_token>

Set the content type as “application/json”.

Request Body

The following parameters should be passed to update the tenant or database information:

{
  "Site": {
    "SiteName": "string",
    "SiteUrl": "string",
    "SiteIdentifier": "string"
  },
  "Database": {
    "ServerName": "string",
    "DatabaseName": "string",
    "UserName": "string",
    "Password": "string",
    "MaintenanceDatabase": "string",
    "Port": "string",
    "SslEnabled": "false",
    "AdditionalParameters": "string"
  }
}

Refer to the parameter details in the table below:

Parameter Name	Datatype	Required	Description
SiteName	String	No	Name of the site
SiteUrl	String	No	URL of the site
SiteIdentifier	String	No	Identifier the site
ServerName	String	Yes	Name of the database server
DatabaseName	String	Yes	Name of the database
UserName	String	Yes	Username of the database server
Password	String	Yes	Password of the database server
MaintenanceDatabase	String	No - Required only for PostgreSQL database server	Maintenance database of the database server
Port	String	No - Required only for PostgreSQL and MySQL database servers	Port number of the database server
SslEnabled	Boolean	Yes	Determines whether the encrypted connection to the database server is required
AdditionalParameters	String	No	Additional parameters for connecting to the database server

Sample Request and Response

Refer to the below sample request body in Postman and the corresponding response.

{
    "api_status": true,
    "data": {
        "id": "074748ec-497a-45a8-b2d7-f62926ea48a9",
        "tenant_name": "production",
        "url": "http://localhost:63738/bi/site/production",
        "tenant_type": "Embedded BI",
        "created_date": "2023-03-10T10:24:42",
        "modified_date": "2023-03-31T09:03:01",
        "tenant_status": "Active",
        "use_site_identifier": true,
        "is_master": false
    },
    "status": true,
    "status_message": "Tenant details updated successfully"
}

Update Data Store Information

To get and update the data store information of the site/tenant, navigate to the following URL:
```
https://<your_domain>/bi/site/<site_identifier>/administration/data-process
```
Here, you can find the data store information of that site. Please update the new credentials and save the changes.

Was this article useful?

Dislike

Written by Israel Jebaraj Chandirakumar

Updated:

Comments