community.missing_collection.checkly_check_groups_info_module.rst

community.missing_collection.checkly_check_groups_info

Get information about checkly check groups.

Version added: 0.3.0

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

Synopsis

• Get information about checkly check groups.
• https://www.checklyhq.com/docs/api#tag/Check-groups

Requirements

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

• requests

Parameters

Parameter	Choices/Defaults	Comments
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/check-groups/"	checkly api.

Examples

- name: get all check groups from checkly
  community.missing_collection.checkly_check_groups_info:
    api_key: 'a8f08873c494445ba156e572e1324300'

- name: get one check group from checkly
  community.missing_collection.checkly_check_groups_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': 0, 'name': 'string', 'activated': True, 'muted': True, 'tags': [], 'locations': [], 'concurrency': 3, 'apiCheckDefaults': {}, 'browserCheckDefaults': {}, 'environmentVariables': [], 'doubleCheck': True, 'useGlobalAlertSettings': True, 'alertSettings': {}, 'alertChannelSubscriptions': [], 'setupSnippetId': 0, 'tearDownSnippetId': 0, 'localSetupScript': 'string', 'localTearDownScript': 'string', 'runtimeId': '2021.06', 'created_at': '2019-08-24', 'updated_at': '2019-08-24T14:15:22Z'}]

Status

Authors

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