community.missing_collection.statuscake_contact_groups_info_module.rst

community.missing_collection.statuscake_contact_groups_info

Get information from Status Cake (contact-groups).

Version added: 0.3.0

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

Synopsis

• Get information from Status Cake (contact-groups).
• https://www.statuscake.com/api/v1/#tag/contact-groups

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.
url string	Default: "https://api.statuscake.com/v1/contact-groups/"	statuscake contact-groups api.

Examples

- name: get all contact-groups
  community.missing_collection.statuscake_contact_groups_info:
    api_key: 'Ohxxxxxxxxxxxxxxxxpi'

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: [{'id': '1', 'name': 'Operations Team', 'ping_url': 'https://www.example.com/notificaions', 'email_addresses': [], 'mobile_numbers': [], 'integrations': []}]

Status

Authors

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