community.healthchecksio.channels_info (1.3.1) — module

Get a list of integrations

| "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 integrations belonging to the project.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get a list of integrations
  community.healthchecksio.channels_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 integrations
  returned: always
  sample:
    channels:
    - id: 82a60fd3-5ae3-4a9e-9747-00097de67711
      kind: email
      name: Email
    - id: 853de669-6910-4bc1-a4cc-55f774a135fd
      kind: slack
      name: ''
  type: dict