---
title: Healthy HTTP endpoint
description: The Healthy HTTP endpoint provides a way to check whether the server is able to handle requests.
component: pingds
version: 8.1
page_id: pingds:configref:objects-healthy-endpoint
canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-healthy-endpoint.html
section_ids:
  parent: Parent
  healthy_http_endpoint_properties: Healthy HTTP endpoint properties
  basic_properties: Basic properties
  authorization-mechanism: authorization-mechanism
  base-path: base-path
  enabled: enabled
  advanced_properties: Advanced properties
  java-class: java-class
---

# Healthy HTTP endpoint

The Healthy HTTP endpoint provides a way to check whether the server is able to handle requests.

At any point in time, the server can become temporarily or permanently unable to handle requests. This endpoint returns 200 without content when the server is able to handle requests or 503 with a JSON containing the reasons why the server is not able to handle requests. The JSON response contains one or both of the following fields: "alive-errors": an array of serious errors. "healthy-errors": an array of transient errors. When only field "healthy-errors" is returned, the server should eventually recover by itself without administrative actions. When "alive-errors" is returned, an administrative action is needed.

## Parent

The Healthy HTTP endpoint object inherits from [HTTP Endpoint](objects-http-endpoint.html).

## Healthy 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) | [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                                              |

## 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 Healthy HTTP endpoint implementation. |
| *Default value*         | org.opends.server.protocols.http.HealthyEndpoint                                                             |
| *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                                                                                                           |