> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itential.com/adapters/configure/service-instance-configuration/properties/healthcheck-properties/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server.

# Healthcheck properties

> Reference for the adapter healthcheck object properties that control how and when the adapter checks the availability of an external system.

All healthcheck properties are defined within the `healthcheck` object in theItential Platform service instance configuration for the adapter. The healthcheck request itself is defined by a `healthcheck` action in the `.system` entity at `adapter/xyz/entities/.system/action.json`.

The healthcheck endpoint defaults to `/healthcheck` in many adapters, but this may not be the best endpoint for your system. Determine an appropriate endpoint and configure it before relying on healthchecks.

## Properties

| Property       | Type    | Required                | Description                                                                                                                                                                                                                                                                                                                |
| -------------- | ------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type`         | enum    | Yes                     | The healthcheck strategy to use. `none`: No healthchecks run; the adapter always reports a green status. `startup`: A healthcheck runs once at startup. Status reflects that result and is not updated again. `intermittent`: Healthchecks run at a defined interval; status reflects the result of the most recent check. |
| `frequency`    | integer | Yes (if `intermittent`) | How often to run healthchecks, in milliseconds.                                                                                                                                                                                                                                                                            |
| `query_object` | object  | No                      | Query parameters to append to the healthcheck request.                                                                                                                                                                                                                                                                     |

## Example

This example runs a healthcheck every five minutes against `GET /api/rest/v2.3/getSystemStatus` with a `mytest=hello` query parameter.

### Service instance configuration

```json
"healthcheck": {
  "type": "intermittent",
  "frequency": 300000,
  "query_object": {
    "mytest": "hello"
  }
}
```

### Endpoint configuration (`entities/.system/action.json`)

```json
{
  "name": "healthcheck",
  "protocol": "REST",
  "method": "GET",
  "entitypath": "{base_path}/{version}/getSystemStatus?{query}",
  "requestSchema": "schema.json",
  "responseSchema": "schema.json",
  "timeout": 0,
  "sendEmpty": false,
  "requestDatatype": "JSON",
  "responseDatatype": "JSON",
  "headers": {},
  "responseObjects": [
    {
      "type": "default",
      "key": "",
      "mockFile": "mockdatafiles/healthcheck-default.json"
    }
  ]
}
```

> Reference for the adapter healthcheck object properties that control how and when the adapter checks the availability of an external system.