status_page_info

lucasheld.uptime_kuma.status_page_info module -- Retrieves facts about status pages.

Note

This module is part of the lucasheld.uptime_kuma collection (version 1.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install lucasheld.uptime_kuma.

To use it in a playbook, specify: lucasheld.uptime_kuma.status_page_info.

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values

Synopsis

• Retrieves facts about status pages.

Requirements

The below requirements are needed on the host that executes this module.

• uptime-kuma-api

Parameters

Parameter	Comments
api_headers dictionary	Headers that are passed to the socketio connection.
api_password string	The Uptime Kuma password. Only required if no api_token specified and authentication is enabled.
api_ssl_verify boolean	true to verify SSL certificates, or false to skip SSL certificate verification, allowing connections to servers with self signed certificates. Choices: no yes ← (default)
api_timeout float	How many seconds the client should wait for the connection, an expected event or a server response. Default: 10
api_token string	The Uptime Kuma login token. Only required if no api_username and api_password specified and authentication is enabled.
api_url string	The Uptime Kuma URL. Default: "http://127.0.0.1:3001"
api_username string	The Uptime Kuma username. Only required if no api_token specified and authentication is enabled.
api_wait_events float	How many seconds the client should wait for the next event of the same type. There is no way to determine when the last message of a certain type has arrived. Therefore, a timeout is required. If no further message has arrived within this time, it is assumed that it was the last message. Default: 0.2
slug string	The slug of the status page to inspect.

Examples

- name: get all status_pages
  lucasheld.uptime_kuma.status_page_info:
    api_url: http://127.0.0.1:3001
    api_username: admin
    api_password: secret123
  register: result

Return Values

Key	Description
status_pages complex	The status pages as list Returned: always
customCSS string	The custom CSS of the status page. Returned: always Sample: "None"
description string	The description of the status page. Returned: always Sample: "description 1"
domainNameList list / elements=string	The domain name list of the status page. Returned: always Sample: []
footerText string	The footer text of the status page. Returned: always Sample: "None"
googleAnalyticsId string	The Google Analytics ID of the status page. Returned: always Sample: "None"
icon string	The icon of the status page. Returned: always Sample: "/icon.svg"
id integer	The id of the status page. Returned: always Sample: 4
incident dictionary	The incident of the status page. Returned: always Sample: {"content": "sample content", "createdDate": "2022-08-26 12:07:00", "id": 2, "lastUpdatedDate": "None", "pin": 1, "style": "danger", "title": "sample title"}
maintenanceList list / elements=string	The maintenance list of the status page. Returned: always Sample: []
publicGroupList list / elements=string	The public group list of the status page. Returned: always Sample: [{"id": 5, "monitorList": [{"id": 18, "name": "sample monitor", "type": "http"}], "name": "Services", "weight": 1}]
published boolean	True if the status page is published. Returned: always Sample: true
showCertificateExpiry boolean	Show Certificate Expiry. Returned: always Sample: false
showPoweredBy boolean	True if the show powered by is enabled. Returned: always Sample: false
showTags boolean	True if the show tags is enabled. Returned: always Sample: false
slug string	The slug of the status page. Returned: always Sample: "slug1"
theme integer	The theme of the status page. Returned: always Sample: "auto"
title string	The title of the status page. Returned: always Sample: "status page 1"

Authors

• Lucas Held (@lucasheld)

Collection links

Issue Tracker Repository (Sources)