This page describes the Database Visibility API methods you can use 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.
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. See UI Collector versus JSON Collector Configuration Field Names
Example JSON Request
extraProperties: To configure the frequency for sampling queries from the database (except Cassandra), you can use the
extraProperties parameter in the JSON request payload. The following JSON sample can be used in the request payload to configure the sampling interval:
The following JSON key-value pair is used in
extraProperties for configuring the interval:
value: positive integer
The value can be 1, 2, 5, 10, 20, or 30.
You can configure this property through the agent. See Configure the Agent Settings for Monitoring Database
Update a Collector
- Make a
GETrequest for the collector that you want to update.
- Copy the JSON response body that is returned by the
GETrequest to a text editor, and modify the fields that you want to update.
POSTrequest for the collector that you want to update, and include the updated JSON.
Example JSON Request
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.
To add a new sub-collector to an existing collector, provide the sub-collector details without the
Delete a Specific Collector
Example 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.
Get All Monitored Database Servers
The output is a list of database servers and their details.
Get Database Server Details
The output contains a list of the database's details, including name, node ID, and database type.
Get all Database Agent Events
For a list of query string parameters, see Retrieve Event Data.
The output gives you a list of events. For each event element, you can determine the node that the event is mapped to by looking for the entity-definition element.
Get all Database Monitoring Application Nodes
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|
|Custom JDBC Connection String|
|Use Service Name|
|SID or SERVICE_NAME|
|Connect as a sysdba|
|Hardware Monitoring||Monitor Operating System|
|Use Local WMI|