community.missing_collection.statuscake_contact_groups_module.rst

community.missing_collection.statuscake_contact_groups

Management of the Status Cake (contact-groups).

Version added: 0.3.0

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

Synopsis

• Management of the 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.
command string	Choices: create ← update delete	type of operation on contact groups.
email_addresses_csv string		Comma separated list of email addresses.
id string		id of contact-groups test. required only for `delete` and `update`.
integrations_csv string		Comma separated list of integration IDs.
mobile_numbers_csv string		Comma separated list of international format mobile phone numbers.
ping_url string		URL or IP address of an endpoint to push uptime events. Currently this only supports HTTP GET endpoints. {'example': 'https://www.google.com'}
url string	Default: "https://api.statuscake.com/v1/contact-groups/"	statuscake contact-groups api.

Examples

- name: create contact groups test
  community.missing_collection.statuscake_contact_groups:
    api_key: 'sGxxxxxxxxxxxx6y'
    command: 'create'
    ping_url: 'https://www.google.com'
    name: "google_contact_groups_test"
    email_addresses_csv: "786spartan@gmail.com"
  register: __id

- name: update contact groups name
  community.missing_collection.statuscake_contact_groups:
    api_key: 'sGxxxxxxxxxxxx6y'
    command: 'update'
    id: '{{ __id.id }}'
    name: "new_google_contact_groups_test"

- name: delete contact groups test
  community.missing_collection.statuscake_contact_groups:
    api_key: 'sGxxxxxxxxxxxx6y'
    command: 'delete'
    id: '{{ __id.id }}'

Return Values

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

Key	Returned	Description
id string	when command is `create` and success.	id of contact-groups test. Sample: 230089

Status

Authors

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