community.healthchecksio.checks_pings_info (1.3.1) — module

Get a list of check pings

| "added in version" 0.1.0 of community.healthchecksio"

Authors: Mark Mercado (@mamercad)

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

Returns a list of pings this check has received.

This endpoint returns pings in reverse order (most recent first).

The total number of returned pings depends on the account's billing plan (100 for free accounts, 1000 for paid accounts).

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get a list of checks pings
  community.healthchecksio.checks_pings_info:
    state: present
    uuid: cae50618-c97f-483e-9814-0277dc523d1e

Inputs

    
uuid:
    description:
    - If specified, returns this specific check.
    required: false
    type: str

state:
    choices:
    - present
    default: present
    description:
    - C(present) will return the check pings.
    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

data:
  description: List of check pings
  returned: always
  sample:
    pings:
    - date: '2021-09-12T13:00:02.231650+00:00'
      method: GET
      n: 2759
      remote_addr: 58.46.132.66
      scheme: https
      type: success
      ua: curl/7.68.0
  type: dict