community.missing_collection.statuscake_ssl_info_module.rst

community.missing_collection.statuscake_ssl_info

Get information from Status Cake (SSL).

Version added: 0.3.0

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

Synopsis

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

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_tests boolean	Choices: no yes	get list of all ssl tests.
get_one_test boolean	Choices: no yes	fetch info about one specific test id.
id string		id of ssl test.
url string	Default: "https://api.statuscake.com/v1/ssl/"	statuscake ssl api.

Examples

- name: get all ssl tests
  community.missing_collection.statuscake_ssl_info:
    api_key: 'Ohxxxxxxxxxxxxxxxxpi'
    get_all_tests: true
  register: __tests

- name: get info about one ssl test
  community.missing_collection.statuscake_ssl_info:
    api_key: 'Ohxxxxxxxxxxxxxxxxpi'
    get_one_test: 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: [{'alert_at': [1, 7, 30], 'alert_broken': False, 'alert_expiry': False, 'alert_mixed': False, 'alert_reminder': False, 'certificate_score': 95, 'certificate_status': 'CERT_OK', 'check_rate': 999999, 'cipher': 'TLS_CHACHA20_POLY1305_SHA256', 'cipher_score': 100, 'contact_groups': [], 'flags': {'follow_redirects': False, 'has_mixed': False, 'has_pfs': True, 'is_broken': False, 'is_expired': False, 'is_extended': False, 'is_missing': False, 'is_revoked': False}, 'follow_redirects': False, 'hostname': 'new_google_ssl_test', 'id': '238191', 'issuer_common_name': 'GTS CA 1C', 'last_reminder': 0, 'mixed_content': [], 'paused': False, 'updated_at': '2021-08-12T20:06:55+00:00', 'user_agent': '', 'valid_from': '2021-07-12T03:48:00+00:00', 'valid_until': '2021-10-04T03:48:00+00:00', 'website_url': 'https://www.google.com'}]

Status

Authors

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