Health Checks
List 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.
get/v1/health-checks
Query parameters
cursorstring
Pagination cursor.
per_pageinteger
Number of items to list per page.
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.
Example:github-installation
Filter by integration type.
status'pass' | 'warn' | 'fail'
Filter by health check status.
Example:fail
started_at_afterstring date-time
Return health checks started at or after this date.
Example:2024-01-01T00:00:00Z
started_at_beforestring date-time
Return health checks started at or before this date.
Example:2024-12-31T23:59:59Z
Response
Health check list
Example response
[
{
"id": 1,
"status": "pass",
"started_at": "2024-06-01T10:00:00Z",
"first_started_at": "2024-05-15T08:00:00Z",
"type": "github-installation",
"instance": {
"id": 42,
"name": "my-org",
"url": "https://github.com/my-org",
"status": "active"
},
"results": [
{
"kind": "api_access_rights",
"status": "pass"
}
],
"last_successful_check_date": "2024-06-01T10:00:00Z"
}
]