--- title: Common REST Metrics HTTP Endpoint description: The Common REST Metrics HTTP Endpoint provides access to OpenDJ's monitoring information via the Common REST protocol. component: pingds version: 7.5 page_id: pingds:configref:objects-crest-metrics-endpoint canonical_url: https://docs.pingidentity.com/pingds/7.5/configref/objects-crest-metrics-endpoint.html section_ids: parent: Parent common_rest_metrics_http_endpoint_properties: Common REST Metrics HTTP Endpoint properties basic_properties: Basic properties authorization-mechanism: authorization-mechanism base-path: base-path enabled: enabled excluded-metric-pattern: excluded-metric-pattern included-metric-pattern: included-metric-pattern advanced_properties: Advanced properties java-class: java-class --- # Common REST Metrics HTTP Endpoint The Common REST Metrics HTTP Endpoint provides access to OpenDJ's monitoring information via the Common REST protocol. ## Parent The Common REST Metrics HTTP Endpoint object inherits from [HTTP Endpoint](objects-http-endpoint.html). ## Common REST Metrics HTTP Endpoint properties You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html). | Basic Properties | Advanced Properties | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | | [authorization-mechanism](#authorization-mechanism) [base-path](#base-path) [enabled](#enabled) [excluded-metric-pattern](#excluded-metric-pattern) [included-metric-pattern](#included-metric-pattern) | [java-class](#java-class) | ### Basic properties Use the `--advanced` option to access advanced properties. ### authorization-mechanism | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | The HTTP authorization mechanisms supported by this HTTP Endpoint. | | *Default value* | None | | *Allowed values* | The name of an existing [http-authorization-mechanism](objects-http-authorization-mechanism.html).The referenced authorization mechanism must be enabled when the HTTP Endpoint is enabled. | | *Multi-valued* | Yes | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### base-path | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | *Synopsis* | All HTTP requests matching the base path or subordinate to it will be routed to the HTTP endpoint unless a more specific HTTP endpoint is found. | | *Default value* | None | | *Allowed values* | A string. | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | Yes | ### enabled | | | | ----------------------- | ----------------------------------------------- | | *Synopsis* | Indicates whether the HTTP Endpoint is enabled. | | *Default value* | None | | *Allowed values* | truefalse | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### excluded-metric-pattern | | | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Zero or more regular expressions identifying metrics that should not be published. The metric name prefix must not be included in the filter. Exclusion patterns take precedence over inclusion patterns. | | *Default value* | None | | *Allowed values* | Any valid regular expression pattern which is supported by the java.util.regex.Pattern class (see for documentation about this class for Java 17). | | *Multi-valued* | Yes | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### included-metric-pattern | | | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Zero or more regular expressions identifying metrics that should be published. The metric name prefix must not be included in the filter. Exclusion patterns take precedence over inclusion patterns. | | *Default value* | None | | *Allowed values* | Any valid regular expression pattern which is supported by the java.util.regex.Pattern class (see for documentation about this class for Java 17). | | *Multi-valued* | Yes | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ## Advanced properties Use the `--advanced` option to access advanced properties. ### java-class | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------ | | *Synopsis* | Specifies the fully-qualified name of the Java class that provides the Common REST Metrics HTTP Endpoint implementation. | | *Default value* | org.opends.server.protocols.http.CrestMetricsEndpoint | | *Allowed values* | A Java class that extends or implements:- org.opends.server.api.HttpEndpoint | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | Yes | | *Read-only* | No |