-
Notifications
You must be signed in to change notification settings - Fork 4
Environment Monitor REST API
- Monitor Configuration
- Current environment status
- Aggregated environment status
- Resource status over time
Service enables monitor users to retrieve information regarding active environment.monitor environments and resource that are checked.
URI: /config/environments
Supported operations: GET
Accept: application/json
Returns list of current active environments along with resources checked for each particular environment.
GET http://{hostname}/config/environments
Service returns results of latest environment checks for all active environments or single environment passed as path variable.
URI: /environment/status/current
Supported operations: GET
Accept: application/json
Returns list of current active environments along with resources checked for each particular environment.
| Name | Type | Obligation | Details |
|---|---|---|---|
| environmentName | String | optional | environmentName as defined in EnvMonitor.xml |
GET http://{hostname}/environment/status/current
GET http://{hostname}/environment/status/current/{environmentName}
Service returns results of environment checks summarized by resource and status.
URI: /environment/status/aggregated
Supported operations: GET
Accept: application/json
Resulting list of environment checks summarized by resource and status.
| Name | Type | Obligation | Details |
|---|---|---|---|
| environmentName | String | mandatory | environmentName as defined in EnvMonitor.xml |
| resources | String | optional | comma separated list of resource id's to aggregate data defined in EnvMonitor.xml |
| startDate | ISO Date | mandatory | ISO formatted aggregation timeframe start |
| endDate | ISO Date | mandatory | ISO formatted aggregation timeframe end |
GET http://{hostname}/environment/status/aggregated/dev?startDate=2017-08-26T21:00:00.000Z&endDate=2017-08-27T19:56:03.834Z
Service returns resource check results for particular period
URI: /resource/status
Supported operations: GET
Accept: application/json
Returns list of resource check results for particular period.
| Name | Type | Obligation | Details |
|---|---|---|---|
| resource | String | optional | resource id as defined in EnvMonitor.xml |
| startDate | ISO Date | mandatory | ISO formatted aggregation timeframe start |
| endDate | ISO Date | mandatory | ISO formatted aggregation timeframe end |
GET http://{hostname}/resource/status/dev/resource1?startDate=2017-08-26T21:00:00.000Z&endDate=2017-08-27T19:58:23.084Z