community.missing_collection.checkly_mw_info_module.rst

community.missing_collection.checkly_mw_info

Get information about checkly Maintenance windows.

Version added: 0.3.0

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

Synopsis

• Get information about checkly Maintenance windows.
• https://www.checklyhq.com/docs/api#tag/Maintenance-windows

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 maintenance window.
limit integer	Default: 100	number of maintenance windows retrieved in one call.
page integer	Default: 1	page number of maintenance window retrieve call.
url string	Default: "https://api.checklyhq.com/v1/maintenance-windows/"	checkly api.

Examples

- name: get all maintenance windows from checkly
  community.missing_collection.checkly_maintenance_windows_info:
    api_key: 'a8f08873c494445ba156e572e1324300'

- name: get one maintenance window from checkly
  community.missing_collection.checkly_maintenance_windows_info:
    api_key: 'a8f08873c494445ba156e572e1324300'
    id: '426'

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', 'tags': [], 'startsAt': '2019-08-24', 'endsAt': '2019-08-24', 'repeatInterval': 1, 'repeatUnit': 'string', 'repeatEndsAt': '2019-08-24', 'created_at': '2019-08-24', 'updated_at': '2019-08-24'}]

Status

Authors

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