community.healthchecksio.badges_info (1.3.1) — module

Get the project badges

| "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 map of all tags in the project, with badge URLs for each tag.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get the project badges
  community.healthchecksio.badges_info:
    state: present
    api_token: "{{ lookup('ansible.builtin.env', 'HEALTHCHECKSIO_API_TOKEN') }}"

Inputs

    
state:
    choices:
    - present
    default: present
    description:
    - C(present) will return the integrations.
    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: Project badges
  returned: always
  sample:
    badges:
      '*':
        json: https://healthchecks.io/badge/5dc9afdd-f4da-4b74-bb83-84430f/_JD3lXcF-2.json
        json3: https://healthchecks.io/badge/5dc9afdd-f4da-4b74-bb83-84430f/_JD3lXcF.json
        shields: https://healthchecks.io/badge/5dc9afdd-f4da-4b74-bb83-84430f/_JD3lXcF-2.shields
        shields3: https://healthchecks.io/badge/5dc9afdd-f4da-4b74-bb83-84430f/_JD3lXcF.shields
        svg: https://healthchecks.io/badge/5dc9afdd-f4da-4b74-bb83-84430f/_JD3lXcF-2.svg
        svg3: https://healthchecks.io/badge/5dc9afdd-f4da-4b74-bb83-84430f/_JD3lXcF.svg
      test:
        json: https://healthchecks.io/badge/5dc9afdd-f4da-4b74-bb83-84430f/e823bLfZ-2/test.json
        json3: https://healthchecks.io/badge/5dc9afdd-f4da-4b74-bb83-84430f/e823bLfZ/test.json
        shields: https://healthchecks.io/badge/5dc9afdd-f4da-4b74-bb83-84430f/e823bLfZ-2/test.shields
        shields3: https://healthchecks.io/badge/5dc9afdd-f4da-4b74-bb83-84430f/e823bLfZ/test.shields
        svg: https://healthchecks.io/badge/5dc9afdd-f4da-4b74-bb83-84430f/e823bLfZ-2/test.svg
        svg3: https://healthchecks.io/badge/5dc9afdd-f4da-4b74-bb83-84430f/e823bLfZ/test.svg
  type: dict