Submit a ticketCall us
Home > Success Center > Database Performance Analyzer (DPA) > DPA - Knowledgebase Articles > DPA 12.1 feature: REST API

DPA 12.1 feature: REST API

Overview

Use the DPA REST API to securely connect to the DPA server and issue commands. DPA API calls can retrieve information and automate management tasks, such as registering database instances, stopping and starting monitors, adding annotations, and allocating licenses.

Environment

DPA 12.1 and later

Detail

What can I do with the DPA API?

Include API calls in scripts to automate DPA management tasks. For example, you can write scripts to automate the process of adding a database instance for monitoring, or to automatically add an annotation when certain events occur. You can call the DPA API with any programming language that can send HTTP requests.

 

The tasks that you can perform with the DPA API include:

 

  • Registering or unregistering a database instance
  • Allocating or deallocating licenses
  • Starting or stopping monitoring
  • Updating the password for a monitored database instance
  • Adding or removing annotations
  • Getting information about licenses, monitored database instances, and annotations

Learn about the API

The DPA API is documented in the Swagger interface. Use this interactive interface to explore the available API endpoints and try out API calls.

 

For detailed information about accessing and using the Swagger interface, see this topic

 

api_feature_overview.png

 

Last modified

Tags

Classifications

Public