--- title: "Update BI Tool" method: PUT path: "/data-bi-connection/{id}" tags: ["BI Tool"] --- # Update BI Tool `PUT /data-bi-connection/{id}` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/data-bi-connection/{id}` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to update an existing BI Tool ## Path parameters - `id` string, uuid, required ## Request body - object - `data` DataBiConnectionUpdateSchema, required: Update schema for DataBiConnection model. Update - `name` string: What the BI tool is called here. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `baseUrl` string: The tool's own address, such as https://metabase.acme.com or https://acme.cloud.looker.com. Power BI needs none. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `credentials` string, password: JSON credentials that may read the tool's dashboards and what they query. Encrypted at rest and never returned by the API. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [No access - you don't have permission for this operation], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `isEnabled` boolean: Whether its dashboards are read every hour. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] ## Response `200` Updated successfully - object - `data` DataBiConnectionReadSchema: Read schema for DataBiConnection model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `name` string, required: What the BI tool is called here. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `tool` 'Metabase' | 'Superset' | 'Tableau' | 'Looker' | 'Power BI' | 'Hightouch' | 'Census', required: Which BI tool it is. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `baseUrl` string: The tool's own address, such as https://metabase.acme.com or https://acme.cloud.looker.com. Power BI needs none. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `isEnabled` boolean: Whether its dashboards are read every hour. Permissions - Create: [Project Owner, Project Admin, Telemetry Admin, Create Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Telemetry Admin, Edit Data Asset] - `lastSyncedAt` object: When its dashboards were last read. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `lastSyncError` string: Why the last read failed; empty when it did not. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `dashboardCount` number: How many dashboards the last read found. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `matchedTableCount` number: How many watched tables the last read found behind its dashboards. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)