community.missing_collection.checkly_dashboards_info_module.rst

community.missing_collection.checkly_dashboards_info

Get information about checkly dashboards.

Version added: 0.3.0

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

Synopsis

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

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

Examples

- name: get all dashboards from checkly
  community.missing_collection.checkly_dashboards_info:
    api_key: 'a8f08873c494445ba156e572e1324300'

- name: get one dashboard from checkly
  community.missing_collection.checkly_dashboards_info:
    api_key: 'a8f08873c494445ba156e572e1324300'
    id: 'bfffd643'

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: [{'customUrl': 'string', 'customDomain': 'string', 'logo': 'string', 'header': 'string', 'width': 'FULL', 'refreshRate': 60, 'paginate': True, 'paginationRate': 30, 'tags': [], 'hideTags': False, 'dashboardId': 'string'}]

Status

Authors

• Davinder Pal (@116davinder) <[email protected]>