• RELEASE NOTES
  • GET STARTED
    • How do I get started with DPA?
    • Register database instances
      • Register a single SQL Server database instance
      • Register a virtual machine and view performance data
    • Examples of investigating performance issues with DPA
      • The DPA approach to investigating performance issues
      • Investigate an application performance problem with DPA
      • Investigate an increase in wait time with DPA
      • Investigate a wait time anomaly with DPA
    • Create a DPA alert to monitor SQL statement execution time
    • Create a DPA report to track wait types for a single SQL statement
    • After evaluation, activate DPA licenses
    • Integrate DPA with the Orion Platform
    • Beyond Getting Started with DPA
  • Install or Upgrade
    • DPA installation overview
    • DPA installation preflight checklist
    • DPA system and monitoring requirements
      • DPA system requirements
      • Database versions you can monitor
      • Requirements for monitoring MySQL database instances
    • Install DPA
      • Install DPA on Windows
      • Install DPA on Linux
      • Install DPA on Azure Marketplace
    • Create the repository database
      • Create a SQL Server repository database
      • Create an Oracle repository database
      • Create a MySQL repository database
      • Create an Azure SQL Database repository database
    • Uninstall DPA
    • Upgrade DPA
      • Upgrade DPA on Windows
      • Upgrade DPA on Linux
      • Upgrade DPA on an Amazon Machine Image instance
      • Upgrade DPA on an Azure VM
  • Administer
    • Introduction
      • Introduction to DPA
      • DPA architecture
    • DPA licensing
      • DPA license types
      • DPA registration and licensing options for clustered environments
      • Requirements for monitoring a database instance running in a VM cluster
      • Purchase and view DPA licenses
      • Activate DPA licenses
      • Allocate or deallocate DPA licenses
      • Troubleshoot over-allocated DPA licenses
      • Deactivate your DPA licenses
    • Register a database instance for monitoring with DPA
      • Database instances DPA can monitor
      • Register multiple database instances
      • Register an Oracle database
      • Register a SQL Server database
      • Register a Sybase database
      • Register a DB2 database
      • Register a MySQL database
      • Register an Amazon RDS for Oracle database
      • Register an Amazon RDS for SQL Server database
      • Register an Amazon RDS for MySQL or Aurora database
      • Register an Azure SQL database
      • Unregister a monitored database instance
    • Database instance groups
      • About monitoring SQL Server Availability Groups with DPA
      • About monitoring Oracle multitenent databases (CDBs)
      • Manually group database instances
    • Monitor database instances with DPA
      • Update a monitored database instance
      • Stop monitoring a database instance for a period of time
      • DPA troubleshooting tips
    • Investigate performance issues with DPA
      • Access DPA query or table tuning advisors
      • Use DPA's query performance analysis to find the root cause of performance issues
      • Investigate inefficient queries running against a table
      • Identify blocking sessions and deadlocks with DPA
      • Find and investigate unusually long wait times (anomalies)
      • About anomaly detection in DPA
      • Add an annotation to document a change to the database
    • Manage SQL statement properties
      • Name SQL statements
      • Exclude SQL statements from DPA charts and analysis
      • Add excluded SQL statements back to DPA charts and analysis
    • Resource metrics in DPA
      • View resource metrics in DPA
      • About DPA resource metric baselines
      • View or change DPA resource metric thresholds
    • DPA user accounts
      • DPA roles and privileges
      • Create a DPA user account and assign privileges
      • DPA user authentication options
      • Configure DPA to use Active Directory or LDAP
    • DPA alerts
      • View the status of DPA alerts
      • Configure a DPA alert
      • Send SNMP traps from DPA alerts
      • Stop DPA alerts for a period of time
      • Use DPA to alert on increases in SQL wait times
      • Create a custom DPA alert to display the name of the active node in a SQL Server cluster
      • Create a DPA alert group
      • Create and manage DPA contacts and contact groups
      • Notification policy for DPA alerts
    • DPA reports
      • About DPA reports
      • Access and run DPA reports
      • Create a DPA report
      • Search for a SQL statement to report on
      • Schedule a DPA report for email delivery
      • Create a DPA report group
    • Link together separate DPA servers
      • Set up a Central Server and add remote DPA servers
      • Configure authentication for the DPA Central Server
      • View information from remote servers on the DPA Central Server
      • Advanced configuration for the DPA Central Server
    • Automate tasks with the DPA REST API
      • Manage the tokens used for authentication to the DPA API
      • Learn about and experiment with the DPA API
      • Examples of using Python scripts to make DPA API calls
      • Examples of using PowerShell scripts to make DPA API calls
    • DPA administrative tasks
      • Stop and start DPA
      • Set advanced DPA configuration options
      • Enable SNMP Monitoring in SCOM
  • All Files
Administer > Use the DPA REST API
  • Introduction
  • DPA licensing
  • Register a database instance for monitoring with DPA
  • Database instance groups
  • Monitor database instances with DPA
  • Investigate performance issues with DPA
  • Manage SQL statement properties
  • Resource metrics in DPA
  • DPA user accounts
  • DPA alerts
  • DPA reports
  • Link together separate DPA servers
  • Automate tasks with the DPA REST API
    • Manage the tokens used for authentication to the DPA API
    • Learn about and experiment with the DPA API
    • Examples of using Python scripts to make DPA API calls
    • Examples of using PowerShell scripts to make DPA API calls
  • DPA administrative tasks

Use the DPA REST API

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.

See the following topics to learn more about using the DPA API:

  • Manage tokens used for authentication to the DPA API
  • Learn about and experiment with the DPA API
  • Examples of using Python scripts to make DPA API calls
  • Examples of using PowerShell scripts to make DPA API calls