Get a specific monitored instance along with its status. The default format is JSON. The servlet will use the HTTP Accept header as a hint if no specific format is specified.

URL

/api/v1/instances

Method

GET

Formats

JSON, XML

Query parameters

N/A

Server state
The PingDataMetrics Server returns the server state status of the monitored instance, which is displayed by the status parameter. The status parameter can have one of the following values:
OFFLINE
Server cannot be contacted
STARTING_UP
Server is starting
ONLINE
Server is available
DEAD_LOCKED
Server is deadlocked and not able to process more operations
UNAVAILABLE
Server is unavailable, but not offline. The server can be in lockdown mode, but still online
DEGRADED
Server is available but is incapable of providing services
CONNECTION_ERROR
Server could not connect or has lost connection to the host
Instance with ID metrics-server in JSON format.
curl \
-X GET \
https://<metricsServerHost>:8080/api/v1/instances/metrics-server.json

Response Code

200 0K

Response Body

 
{
  "displayName": "metrics-server",
  "hostname": "metrics-server.example.com",
  "id" : "metrics-server",
  "operatingSystem": "Linux",
  "status" : {
    "state" : "ONLINE"
  },
  "type" : "metrics-server",
  "version": "PingData PingDataMetrics Server 7.3"
}