Skip to content

monitor_alert_channel_list.md

Latest commit

 

History

History
78 lines (61 loc) · 3.85 KB

monitor_alert_channel_list.md

File metadata and controls

78 lines (61 loc) · 3.85 KB

monitor_alert_channel_list

List and filter on Alert Channels.

WARNING! This module makes use of beta endpoints and requires the C(api_version) field be explicitly set to C(v4beta).

Minimum Required Fields

Field Type Required Description
api_token str Required The Linode account personal access token. It is necessary to run the module.
It can be exposed by the environment variable LINODE_API_TOKEN instead.
See details in Usage.

Examples

- name: List all of available alert channels to the account
  linode.cloud.monitor_alert_channel_list:
    api_version: v4beta

Parameters

Field Type Required Description
order str Optional The order to list Alert Channels in. (Choices: desc, asc; Default: asc)
order_by str Optional The attribute to order Alert Channels by.
filters (sub-options) list Optional A list of filters to apply to the resulting Alert Channels.
count int Optional The number of Alert Channels to return. If undefined, all results will be returned.

filters

Field Type Required Description
name str Required The name of the field to filter on. Valid filterable fields can be found here.
values list Required A list of values to allow for this field. Fields will pass this filter if at least one of these values matches.

Return Values

  • alert_channels - The returned Alert Channels.

    • Sample Response: 
      [
    {
        "id": 123,
        "label": "alert notification channel",
        "type": "user",
        "channel_type": "email",
        "details": {
            "email": {
                "usernames": [
                    "admin-user1",
                    "admin-user2"
                ],
                "recipient_type": "user"
            }
        },
        "alerts": {
            "url": "/monitor/alert-channels/123/alerts",
            "type": "alerts-definitions",
            "alert_count": 0
        },
        "created": "2024-01-01T00:00:00",
        "updated": "2024-01-01T00:00:00",
        "created_by": "tester",
        "updated_by": "tester"
    }
]
    • See the Linode API response documentation for a list of returned fields