community.missing_collection.checkly_checks_info_module.rst

community.missing_collection.checkly_checks_info

Get information about checkly checks.

Version added: 0.3.0

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values
• Status

Synopsis

• Get information about checkly checks.
• https://www.checklyhq.com/docs/api#tag/Checks

Requirements

The below requirements are needed on the host that executes this module.

• requests

Parameters

Parameter	Choices/Defaults	Comments
api_check_url_filter_pattern string		Filters the results by a string contained in the URL of an API check. for instance a domain like www.myapp.com. Only returns API checks.
api_key string / required		api key for checkly.
id string		id of alert channel.
limit integer	Default: 100	number of checks in one call.
page integer	Default: 1	page number of retrieve call.
url string	Default: "https://api.checklyhq.com/v1/checks/"	checkly api.

Examples

- name: get all checks from checkly
  community.missing_collection.checkly_checks_info:
    api_key: 'a8f08873c494445ba156e572e1324300'

- name: get one check from checkly
  community.missing_collection.checkly_checks_info:
    api_key: 'a8f08873c494445ba156e572e1324300'
    id: '39308'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
result list/dict	when success.	result of checkly api. Sample: [{'id': 'string', 'name': 'string', 'checkType': 'BROWSER', 'frequency': 10, 'frequencyOffset': 1, 'activated': True, 'muted': False, 'doubleCheck': True, 'sslCheck': True, 'shouldFail': True, 'locations': [], 'request': {}, 'script': 'string', 'environmentVariables': [], 'tags': [], 'setupSnippetId': 0, 'tearDownSnippetId': 0, 'localSetupScript': 'string', 'localTearDownScript': 'string', 'alertSettings': {}, 'useGlobalAlertSettings': True, 'degradedResponseTime': 10000, 'maxResponseTime': 20000, 'groupId': 0, 'groupOrder': 0, 'runtimeId': '2021.06', 'alertChannelSubscriptions': [], 'alertChannels': {}, 'created_at': '2019-08-24', 'updated_at': '2019-08-24T14:15:22Z'}]

Status

Authors

• Davinder Pal (@116davinder) <dpsangwal@gmail.com>