← Tools Reference

Checkly

Checkly integration (Developer Tools). Imported from open-connector.

API key7 toolshttps://api.checklyhq.com
GET
checkly_get_current_account
Retrieve details for the Checkly account attached to the API key.

/v1/accounts/me

GET
checkly_list_checks
List Checkly checks with optional type, tag, status, and search filters.

/v1/checks

8 parameters
ParamTypeRequiredDescription
limitintegeroptionalMaximum number of checks to return.
pageintegeroptionalPage number to retrieve.
apiCheckUrlFilterPatternstringoptionalFilter API checks by a string contained in the checked URL.
tagarrayoptionalTags used to filter checks.
checkTypestringoptionalCheckly check type filter.
searchstringoptionalCase-insensitive partial name search.
statusstringoptionalCurrent check status filter.
applyGroupSettingsbooleanoptionalWhether group settings should be applied to returned checks.
GET
checkly_get_check
Retrieve one Checkly check by ID.

/v1/checks/{checkId}

3 parameters
ParamTypeRequiredDescription
checkIdstringrequiredCheckly check identifier.
includeDependenciesbooleanoptionalWhether to include check dependencies in the response.
applyGroupSettingsbooleanoptionalWhether group settings should be applied to the check.
GET
checkly_list_check_statuses
List current statuses for Checkly checks.

/v1/check-statuses

GET
checkly_get_check_status
Retrieve current status details for one Checkly check.

/v1/check-statuses/{checkId}

1 parameter
ParamTypeRequiredDescription
checkIdstringrequiredCheckly check identifier.
GET
checkly_list_check_results
List recent Checkly results for one check.

/v1/check-results/{checkId}

9 parameters
ParamTypeRequiredDescription
checkIdstringrequiredCheckly check identifier.
limitintegeroptionalMaximum number of check results to return.
pageintegeroptionalPage number to retrieve.
fromstringoptionalLower UNIX timestamp boundary for returned results.
tostringoptionalUpper UNIX timestamp boundary for returned results.
locationstringoptionalCheckly data center location used to filter results.
checkTypestringoptionalCheckly check type filter.
hasFailuresbooleanoptionalWhether to return only results with failures.
resultTypestringoptionalCheck result type filter.
GET
checkly_get_check_result
Retrieve one Checkly check result by ID.

/v1/check-results/{checkId}/{checkResultId}

2 parameters
ParamTypeRequiredDescription
checkIdstringrequiredCheckly check identifier.
checkResultIdstringrequiredCheckly check result identifier.