Enable the XML API allows you to request information from the DAM Server using a standardized HTTP GET/POST request and receive the response in an XML format. You can find the detailed structure of the XML reply in the XSD file located in the System → Interfaces → XML API tab.
Enable the service through the System tab.
Access the service by authenticating with a user that has the XML API permission (default administrator user has the relevant permission). Authentication is done via HTTP Basic Auth.
Use the following base URL for a request: <server URL>/xmlapi.svc.
The XML API allows you to perform queries regarding alerts, VA results, DBMSs, sensors and others.
To test the XML API, a simple browser request can be used. For example, to get a list of sensors and their current state, issue the following request in a browser (replace localhost with relevant domain name or IP address):
https://localhost:8443/xmlapi.svc?service=sensorNote
The port number mentioned here varies depending on the Database Security configuration.
The web browser test displays a dialog box asking for a username and password in order to successfully submit the XML API request.
A successful request then results in an XML response that enumerates the sensors known to Database Security. These sensor details are not limited to current instances, but also deleted sensor instances.
Each service supports a set of parameters that can be used to limit the request. For example, the alert service supports the HH$TimeBackPeriod parameter, which specifies the time back in milliseconds that an alert was executed at. For example, to get all alerts from the last five minutes, issue the following request:
https://127.0.0.1:8443/xmlapi.svc?service=alert&HH$TimeBackPeriod=300000