community.healthchecksio.checks_flips_info (1.3.1) — module

Get a list of check flips

| "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

Get a list of check's status changes.

Returns a list of "flips" this check has experienced.

A flip is a change of status (from "down" to "up," or from "up" to "down").

Usage examples

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

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 flips
  returned: always
  sample:
    flips: []
  type: dict