Sign in

v2

latestOpenAPI 3.0.4Apache 2.0raw.githubusercontent.com2026-07-1754198241.7 KB
Connectors

Check connector health

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.

post/connectors/{connectorInstanceId}/healthchecks

Path parameters

connectorInstanceIdstring uuid required

Stable platform identifier for a configured connector instance.

Example:3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5

Stable identifier of the configured connector instance. This is not the Party id; the connector instance has its own id and points at its backing Party.

Request body

includeDependenciesboolean

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.

Example request

{
  "includeDependencies": true,
  "operationKind": "READ"
}

Response

Connector health result.

connectorInstanceIdstring uuid required

Stable platform identifier for a configured connector instance.

status'HEALTHY' | 'DEGRADED' | 'UNHEALTHY' | 'UNKNOWN' required

Overall health status.

checkedAtstring date-time required

Timestamp when the health check completed.

Example response

{
  "connectorInstanceId": "3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5",
  "status": "DEGRADED",
  "checkedAt": "2026-06-18T10:15:00Z",
  "details": [
    {
      "name": "openapi-contract",
      "status": "HEALTHY",
      "message": "Contract document resolved."
    },
    {
      "name": "oauth-token",
      "status": "DEGRADED",
      "message": "Token expires within the warning window."
    }
  ]
}