Sign in
Git Provider Connections

Run an on-demand health check for a git connection.

Changed on

Probes the upstream (GitHub App, PAT, or OAuth token), persists the result, and fires admin notifications on status transitions. Returns the updated connection.

post/git-connections/{connection_id}/health-check

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/git-connections/{connection_id}/health-check
  • Auth: HTTP bearer

Path parameters

connection_idinteger required

Connection ID

Response

Health check completed

account_namestring required
account_typestring required
consecutive_health_failuresinteger required
created_atstring date-time required
has_authenticated_credentialsboolean required

Whether this connection can make authenticated provider requests. This exposes capability only; credential values are never serialized.

health_messagestring nullable

Human-readable reason when health_status is "unhealthy"; null otherwise.

health_statusstring required

Current health status: "healthy", "unhealthy", or "unknown".

idinteger required
installation_idstring nullable
is_activeboolean required
is_expiredboolean required
last_health_check_atstring date-time nullable
last_sync_errorstring nullable

Why the most recent repository sync failed or timed out; null once a sync succeeds.

last_sync_error_atstring date-time nullable
last_synced_atstring date-time nullable
provider_idinteger required
synced_repository_countinteger required

Running count of repositories persisted by the current (or most recent) sync. Resets to 0 when a new sync begins; useful for showing live progress on large syncs.

syncingboolean required
updated_atstring date-time required
user_idinteger nullable

Changes

  • 4b228ebed583Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1dc3e6788214Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status