community.missing_collection.checkly_check_statuses_info_module.rst

community.missing_collection.checkly_check_statuses_info

Get information from checkly about check statuses.

Version added: 0.3.0

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

Synopsis

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

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		check id.
url string	Default: "https://api.checklyhq.com/v1/check-statuses/"	checkly api.

Examples

- name: get details of all checkly check statuses
  community.missing_collection.checkly_check_statuses_info:
    api_key: 'a8f0xxxxxxxxxxx00'
  register: __

- name: get details of one specific check statuses
  community.missing_collection.checkly_check_statuses_info:
    api_key: 'a8f0xxxxxxxxxxx00'
    id: '{{ __.result[0].checkId }}'

Return Values

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

Key	Returned	Description
result dict/list	when success.	result of the api. Sample: [{'name': 'string', 'checkId': 'string', 'hasFailures': True, 'hasErrors': True, 'isDegraded': True, 'longestRun': 0, 'shortestRun': 0, 'lastRunLocation': 'string', 'lastCheckRunId': 'string', 'sslDaysRemaining': 0, 'created_at': '2019-08-24', 'updated_at': '2019-08-24T14:15:22Z'}]

Status

Authors

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