---
title: "HealthCheck.make()"
description: "Method for checking the availability of Bitrix24 REST API. Performs a simple request to the REST API to verify service health."
canonical_url: "https://bitrix24.github.io/b24jssdk/docs/working-with-the-rest-api/tools-health-check"
last_updated: "2026-05-08"
---
# HealthCheck.make()

> Method for checking the availability of Bitrix24 REST API. Performs a simple request to the REST API to verify service health.

> [!WARNING]
> We are still updating this page. Some data may be missing here — we will complete it shortly.

## Overview

Use `HealthCheck.make()` to check the availability of Bitrix24 REST API. The method returns a `Promise` with a boolean value indicating API availability.

```ts
// Basic usage
const isHealthy = await $b24.tools.healthCheck.make()

if (isHealthy) {
  console.log('Bitrix24 API is available')
} else {
  console.error('Problems accessing Bitrix24 API')
}
```

## Method Signature

```ts-type
make(
  options?: { requestId?: string }
): Promise<boolean>
```

### Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| **`requestId`** | `string` | No | Unique request identifier for tracking. Used for request deduplication and debugging. |

### Return Value

`Promise<boolean>` — a promise that resolves to a boolean value:

- **true** — REST API is available and responding, webhook is configured correctly.
- **false** — REST API is unavailable, an error occurred, or necessary access rights are missing.

## Examples

### Availability check

```ts [tools-health-check.ts]
? visitAndReplace ?
```

## Alternatives and Recommendations

- **For measuring response speed**: Use [`Ping`](https://bitrix24.github.io/b24jssdk/raw/docs/working-with-the-rest-api/tools-ping.md).
- **For checking specific permissions**: Perform a test request to the required API method.
- **On the client-side (browser):** Use the built-in [`B24Frame`](https://bitrix24.github.io/b24jssdk/raw/docs/getting-started/installation/vue.md#init) object.

## Sitemap

See the full [sitemap](/b24jssdk/sitemap.md) for all pages.