PingDirectory

Retrieve events

The detailed information for one or more events can be retrieved, with optional filtering, based on the following API definition.

URL

/api/v1/events/[?query-parameters] retrieves a list of events.

/api/v1/events/{eventId} retrieves a single event.

Method

GET

Formats

JSON, XML

Query Parameters
type

Limits the result to include only events of the specified types. See the HTML API Reference for event types.

severity

Limits the result to include only events that have the matching severity. Valid severity values are: INFO, WARNING, ERROR, and FATAL.

instance, instanceType, instanceLocation, instanceHostname, instanceVersion, startTime, and endTime.

For a description of each parameter, see Perform a metric query.

limit, offset

For a description of each parameter, see Pagination.

Response Code

200 0K

Response Body

 
{
  "found" : 2,
  "offset" : 0,
  "events" : [

{"id":"9bdfd1b8-3811-4a84-b779-93553ff35f83",
	"creationDate":1351274815559,
	"eventType":"server-starting",
	"eventSeverity":"INFO",
	"sourceProductInstance":"lockdown-test",
	"summary":"Server Starting",
	"detail":"The Directory Server is starting"},
 {"id":"9bdfd1b8-3811-4a84-b779-93553ff35f83",
	"creationDate":1351274815559,
	"eventType":"server-starting",
	"eventSeverity":"INFO",
	"sourceProductInstance":"directory-3",
	"summary":"Server Starting",
	"detail":"The Directory Server is starting"}
  ]
}