---
title: Common REST monitoring
description: Query PingAM monitoring metrics through the common REST API endpoint to gather installation information in JSON format
component: pingam
version: 7.5
page_id: pingam:maintenance:monitoring-crest
canonical_url: https://docs.pingidentity.com/pingam/8/maintenance/monitoring-crest.html
llms_txt: https://docs.pingidentity.com/pingam/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
keywords: ["REST API", "Monitoring"]
page_aliases: ["maintenance-guide:monitoring-crest.adoc"]
superseded_by: https://docs.pingidentity.com/pingam/8/maintenance/monitoring-crest.html
section_ids:
  enable-crest: Enable the common REST monitoring interface
---

# Common REST monitoring

Common REST refers to the REST framework supported by all Ping Advanced Identity Software products. AM exposes an endpoint that lets REST clients gather information about your AM installation in JSON format.

When [enabled](#enable-crest), AM makes the common REST-formatted metrics available at the `/json/metrics/api` endpoint.

For example, to query all monitoring metrics:

```bash
$ curl \
--request GET \
--header 'Content-Type: application/json' \
--header 'iPlanetDirectoryPro: P8Eri6d…​xAAA.*' \
'https://openam.example.com:8443/openam/json/metrics/api?_queryFilter=true&_prettyPrint=true'
{
  "result" : [ {
    "_id" : "session.authentication-client-based.get-matching-sessions.failure",
    "count" : 0,
    "max" : 0.0,
    "mean" : 0.0,
    "min" : 0.0,
    "p50" : 0.0,
    "p75" : 0.0,
    "p95" : 0.0,
    "p98" : 0.0,
    "p99" : 0.0,
    "p999" : 0.0,
    "stddev" : 0.0,
    "m15_rate" : 0.0,
    "m1_rate" : 0.0,
    "m5_rate" : 0.0,
    "mean_rate" : 0.0,
    "duration_units" : "milliseconds",
    "rate_units" : "calls/second",
    "total" : 0.0,
    "_type" : "timer"
  },
  …​
```

To output values for a specific metric, use the format `/json/metric/api/metric name`.

For example:

```bash
$ curl \
--request GET \
--header 'Content-Type: application/json' \
--header 'iPlanetDirectoryPro: P8Eri6d…​xAAA.*' \
'https://openam.example.com:8443/openam/json/metrics/api/authentication.success'
{
    "_id":"authentication.success",
    "m15_rate":2.3882880682497324E-4,
    "m1_rate":1.0818067450729532E-12,
    "m5_rate":3.057223961594952E-5,
    "mean_rate":1.072595825176473E-4,
    "units":"events/second",
    "total":9.0,
    "count":9,
    "_type":"summary"
}
```

For monitoring metrics reference, refer to [Monitoring metrics](monitoring-metrics.html).

## Enable the common REST monitoring interface

1. Ensure you have [enabled monitoring](monitoring-am.html#enable-monitoring).

2. Go to Configure > Global Services > Monitoring.

3. On the Secondary Configurations tab, click `crest`.

4. Set CREST to Enabled.

5. Click Save Changes.