---
title: "List health checks"
method: GET
path: "/v1/health-checks"
tags: ["Health Checks"]
---

# List health checks

`GET /v1/health-checks`

List the latest health check per integration instance for the authenticated account.

Each entry represents the most recent health check run for a given instance.
Results can be filtered by integration type and health status.

## Query parameters

- `cursor` string
- `per_page` integer
- `type` 'aws-ecr-installation' | 'aws-honeytoken-organization' | 'aws-s3-installation' | 'azure-cr-installation' | 'azure-devops-installation' | 'bitbucket-cloud-workspace' | 'bitbucket-installation' | 'confluence-cloud-installation' | 'confluence-data-center-installation' | 'docker-hub-installation' | 'gerrit-installation' | 'github-installation' | 'gitlab-installation' | 'google-artifact-installation' | 'jfrog-artifact-installation' | 'jfrog-package-installation' | 'jira-cloud-installation' | 'jira-data-center-installation' | 'microsoft-onedrive-installation' | 'microsoft-teams-installation' | 'red-hat-quay-installation' | 'servicenow-installation' | 'servicenow-issue-tracking-config' | 'sharepoint-online-drive-installation' | 'slack-workspace' — The integration type identifier.
- `status` 'pass' | 'warn' | 'fail' — Filter by health check status.
- `started_at_after` string, date-time — Return health checks started at or after this date.
- `started_at_before` string, date-time — Return health checks started at or before this date.

## Response `200`

Health check list

- object[]
  - `id` integer, required — The unique ID of this health check run.
  - `status` 'pass' | 'warn' | 'fail', required — The aggregate status of this health check run.
  - `started_at` string, date-time, required — When this health check run started.
  - `first_started_at` string, date-time, nullable — When the current uninterrupted streak of health checks started for this instance. `null` if not yet computed.
  - `type` 'aws-ecr-installation' | 'aws-honeytoken-organization' | 'aws-s3-installation' | 'azure-cr-installation' | 'azure-devops-installation' | 'bitbucket-cloud-workspace' | 'bitbucket-installation' | 'confluence-cloud-installation' | 'confluence-data-center-installation' | 'docker-hub-installation' | 'gerrit-installation' | 'github-installation' | 'gitlab-installation' | 'google-artifact-installation' | 'jfrog-artifact-installation' | 'jfrog-package-installation' | 'jira-cloud-installation' | 'jira-data-center-installation' | 'microsoft-onedrive-installation' | 'microsoft-teams-installation' | 'red-hat-quay-installation' | 'servicenow-installation' | 'servicenow-issue-tracking-config' | 'sharepoint-online-drive-installation' | 'slack-workspace', required — The integration type identifier.
  - `instance` object, required — The integration instance associated with a health check.
    - `id` integer, required — The ID of the integration instance.
    - `name` string, required — The display name of the integration instance.
    - `url` string, required — The URL of the integration instance.
    - `status` 'active' | 'revoked' | 'suspended' | 'deleted', required — The operational status of the integration instance.
  - `results` object[], required — Individual check results for this run.
    - `kind` 'api_network' | 'webhook_network' | 'api_access_rights' | 'webhook_access_rights', required — The category of the check.
    - `status` 'pass' | 'warn' | 'fail', required — The result of this check.
    - `error_code` integer, required — Error code. `0` means no error.
    - `error_message` string, required — Human-readable error message. Empty string when there is no error.
  - `last_successful_check_date` string, date-time, nullable — The date of the last successful (passing) health check for this instance.

## Other responses

- `400` — Invalid data
- `401` — Invalid API key
- `403` — Permission denied
- `404` — Resource not found
- `503` — API under maintenance

---

[API](https://skmtc.net/gitguardian/apis/gitguardian-api.md) · [All operations](https://skmtc.net/gitguardian/apis/gitguardian-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gitguardian/gitguardian-api/revisions/511b067cdcb1/schema)