The default format is JSON. The servlet will use the HTTP Accept header as a hint if no specific format is specified. Results are filtered using the various instance query parameters.

URL

/api/v1/instances

Method

GET

Formats

JSON, XML

Query parameters

instanceHostname
Hostnames of the servers from which data is gathered. Multiple values are evaluated as logical ORs.
instanceLocation
Locations of the servers from which data is gathered. Multiple values are evaluated as logical ORs.
instanceType
Types of servers to get data from. Possible values are:
  • ds
  • proxy
  • sync
  • metrics-server
instanceVersion
Versions of the servers to get data from. Multiple values are evaluated as logical ORs.
All instances in JSON format.
curl \
-X GET \
https://<metricsHost>:8080/api/v1/instances.json
All PingDirectory server and PingDirectoryProxy server instances in XML format:
curl \
-X GET \
https://<metricsHost>:8080/api/v1/instances.xml?
instanceType=data-store&instanceType=proxy

Response Code

200 0K

Response Body

{
  "found" : 2
   "offset" : 0,#
  "instances" : [ {
    "type" : "ds",
    "id" : "pingidentity4510",
    "hostname": "pingidentity5200.example.com",
    "displayName" : "pingidentity4510",
    "version": "Directory Server 7.3.0",
    "operatingSystem": "Linux",
    "status": {
       "state": "ONLINE"
       }
  }, {
     "type" : "ds",
    "id" : "unboundid3500",
    "hostname": "unboundid3500.example.com",
    "displayName" : "directory3500",
    "version": "UnboundID Directory Server 3.5.0.0",
    "operatingSystem": "Linux",
    "status": {
      "state": "DEGRADED",
      "unavailableAlerts": [
        "replication-backlogged"
      ]
    }
} ] }