---
title: "Check connector health"
method: POST
path: "/connectors/{connectorInstanceId}/healthchecks"
tags: ["Connectors"]
---

# Check connector health

`POST /connectors/{connectorInstanceId}/healthchecks`

Performs a health check for the connector instance and optionally its dependencies, such as
endpoint reachability, credentials, contract availability, or operation-specific readiness.
The health result is observational and does not change connector lifecycle status.

## Path parameters

- `connectorInstanceId` string, uuid, required — Stable platform identifier for a configured connector instance.

## Request body

- HealthCheckRequest — Request to run a connector health check. The check can be scoped to dependencies or an operation kind.
  - `includeDependencies` boolean — Whether dependency checks such as endpoint reachability, credential validity, and contract availability should be included.
  - `operationKind` 'READ' | 'WRITE' | 'UPDATE' | 'DELETE' | 'UPSERT' | 'QUERY' | 'SEARCH' | 'IMPORT' | 'EXPORT' | 'INVOKE' | 'DISCOVER' | 'VALIDATE' — Reusable operation taxonomy shared by connectors, inventory, policy, and workflows. The operation kind is logical; connector-local details live in operationName.

## Response `200`

Connector health result.

- ConnectorHealth — Connector health result for one connector instance.
  - `connectorInstanceId` string, uuid, required — Stable platform identifier for a configured connector instance.
  - `status` 'HEALTHY' | 'DEGRADED' | 'UNHEALTHY' | 'UNKNOWN', required — Overall health status.
  - `checkedAt` string, date-time, required — Timestamp when the health check completed.
  - `details` HealthDetail[] — Dependency-level health details.
    - `name` string — Dependency or check name.
    - `status` string — Status of the dependency or check.
    - `message` string — Human-readable health message.
    - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data.

## Other responses

- `401` — Authentication is required.
- `404` — The requested resource was not found.

---

[API](https://skmtc.net/sphereon-opensource/apis/connector-integration-profile-api.md) · [All operations](https://skmtc.net/sphereon-opensource/apis/connector-integration-profile-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sphereon-opensource/connector-integration-profile-api/versions/60cb8c70871b/schema)