community.healthchecksio.ping (1.3.1) — module

Install collection

Install with ansible-galaxy collection install community.healthchecksio:==1.3.1

Add to requirements.yml

  collections:
    - name: community.healthchecksio
      version: 1.3.1

Description

With the Pinging API, you can signal success, fail, and start events from your systems.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Send a success signal
  community.healthchecksio.ping:
    state: present
    uuid: "{{ check_uuid }}"
    signal: success

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Send a fail signal
  community.healthchecksio.ping:
    state: present
    uuid: "{{ check_uuid }}"
    signal: fail

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Send a start signal
  community.healthchecksio.ping:
    state: present
    uuid: "{{ check_uuid }}"
    signal: start

Inputs

    
uuid:
    description:
    - Check uuid to delete when state is C(absent) or C(pause).
    required: true
    type: str

state:
    choices:
    - present
    default: present
    description:
    - C(present) will send a signal.
    type: str

signal:
    choices:
    - success
    - fail
    - start
    default: success
    description:
    - Type of signal to send, C(success), C(fail) or C(start).
    type: str

api_token:
    aliases:
    - api_key
    description:
    - Healthchecks.io API token.
    - 'There are several environment variables which can be used to provide this value:'
    - C(HEALTHCHECKSIO_API_TOKEN), C(HEALTHCHECKSIO_API_KEY), C(HC_API_TOKEN), C(HC_API_KEY)
    required: true
    type: str

Outputs

msg:
  description: Signal result message
  returned: always
  sample: Sent success signal to 8597dcda-23d1-4e6b-b904-83df360bf8a8
  type: str