community.missing_collection.statuscake_locations_info_module.rst

community.missing_collection.statuscake_locations_info

Get information from Status Cake (Locations).

Version added: 0.3.0

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

Synopsis

• Get information from Status Cake (Locations).
• https://www.statuscake.com/api/v1/#tag/locations

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 statuscake.
best boolean	Choices: no yes ←	Return only locations with the least number of tests.
command string	Choices: uptime ← pagespeed	for which service you want to fetch all locations.
location string		Country ISO.
url string	Default: "https://api.statuscake.com/v1/"	statuscake api.

Examples

- name: list all uptime locations
  community.missing_collection.statuscake_locations_info:
    api_key: 'sGxxxxxxxxxxxx6y'
    command: 'uptime'

- name: list all pagespeed locations
  community.missing_collection.statuscake_locations_info:
    api_key: 'sGxxxxxxxxxxxx6y'
    command: 'pagespeed'

Return Values

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

Key	Returned	Description
data list	when success.	result of the api. Sample: [{'hostname': 'UKINT', 'description': 'United Kingdom, London - 5', 'region': 'United Kingdom / London', 'ipv4': '178.62.78.199', 'ipv6': '2a03:b0c0:1:d0::5e:f001', 'region_code': 'london', 'status': 'up'}]

Status

Authors

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