---
title: "Trigger a health check"
method: POST
path: "/integration/{integration_id}/health-check/"
tags: ["integrations"]
---

# Trigger a health check

`POST /integration/{integration_id}/health-check/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/integration/{integration_id}/health-check/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Manually trigger a health check for an integration.

## Path parameters

- `integration_id` string, uuid, required

## Response `201`

Successful Response

- HealthCheckReadSchema: Response model for a single health check result.
  - `checked_at` string, date-time, required: When the health check was performed.
  - `error_code` string, nullable: Machine-readable error code.
  - `error_message` string, nullable: Human-readable error message.
  - `id` string, uuid, required
  - `status` 'healthy' | 'warning' | 'error', required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Integration not found
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)