On this page:
The Database Visibility API allows you to get, create, update, and delete Database Visibility Collectors.
Include the following headers for all Database Visibility API requests:
JSON is currently the only supported format.
Supported API Calls
Get all Collectors
Get a Specific Collector
Create a Collector
The JSON you send must contain the relevant Collector information. The required fields describing the Collector vary based on the type of database. Below is a sample JSON request body:
For more information, see the table in the "UI Collector versus JSON Collector Configuration Field Names" section that follows.
Update a Collector
- Make a GET request for the collector that you want to update.
- Copy the JSON response body that is returned by the GET request to a text editor, and modify the fields that you want to update.
Make a POST request for the collector that you want to update, and include the updated JSON.
Below is a sample JSON request body:
The JSON you send must contain all the details of the existing collector with only the fields that you want to modify changed. To ensure you have all the fields, use the Get a Specific Collector call.
Delete a Specific Collector
Below is an example of a delete request.
Batch Delete Multiple Collectors
Send an array of the configuration Ids of the Collectors.
Below is an example of a batch delete command.
Example Request and Response
UI Collector versus JSON Collector Configuration Field Names
Use the table below to ensure you use the correct field names for your API calls. The Collector configuration field names are described in Configure the Database Agent to Monitor Server Hardware and Add Database Collectors.
|Section||UI Collector Configuration Field Name||JSON Collector Configuration Field Name|
|id (AppDynamics assigns this ID to the Collector when you configure the Collector. You need this ID when doing a batch delete.)|
|Connection Details||Hostname/IP Address||hostname|
|Custom JDBC Connection String||customConnectionString|
|Use Service Name||useServiceName|
|SID or SERVICE_NAME||sid|
|Connect as a sysdba||connectAsSysdba|
|Hardware Monitoring||Monitor Operating System||enableOSMonitor|
|Use Local WMI||useLocalWMI|