community.missing_collection.statuscake_uptime_info_module.rst

community.missing_collection.statuscake_uptime_info

Get information from Status Cake (Uptime).

Version added: 0.3.0

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

Synopsis

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

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.
get_all_alerts boolean	Choices: no yes	fetch alerts info about one specific test id.
get_all_periods boolean	Choices: no yes	fetch test periods info about one specific test id.
get_all_tests boolean	Choices: no yes	get list of all Uptime tests.
get_histroy boolean	Choices: no yes	fetch history info about one specific test id.
get_one boolean	Choices: no yes	fetch info about one specific test id.
id string		id of uptime test.
limit integer	Default: 5000	number of results per page.
page integer	Default: 1	id of page for which you want to fetch results.
status string	Choices: up ← down	status of uptime test.
url string	Default: "https://api.statuscake.com/v1/uptime/"	statuscake Uptime api.

Examples

- name: get all uptime tests
  community.missing_collection.statuscake_uptime_info:
    api_key: 'sxxxxxxxxxxxx6y'
    get_all_tests: true
  register: __tests

- name: get info about one uptime test
  community.missing_collection.statuscake_uptime_info:
    api_key: 'sxxxxxxxxxxxx6y'
    get_one: true
    id: '{{ __tests.data[0].id }}'

- name: get history about one uptime test
  community.missing_collection.statuscake_uptime_info:
    api_key: 'sxxxxxxxxxxxx6y'
    get_histroy: true
    id: '{{ __tests.data[0].id }}'

- name: get all periods about one uptime test
  community.missing_collection.statuscake_uptime_info:
    api_key: 'sxxxxxxxxxxxx6y'
    get_all_periods: true
    id: '{{ __tests.data[0].id }}'

- name: get all alerts about one uptime test
  community.missing_collection.statuscake_uptime_info:
    api_key: 'sxxxxxxxxxxxx6y'
    get_all_alerts: true
    id: '{{ __tests.data[0].id }}'

Return Values

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

Key	Returned	Description
data dict/list	when success.	result of the api. Sample: [{'check_rate': 300, 'contact_groups': [], 'host': '', 'id': '6086154', 'name': 'google_http_check-79', 'paused': False, 'status': 'up', 'tags': [], 'test_type': 'HTTP', 'uptime': 100, 'website_url': 'https://www.google.com'}]

Status

Authors

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