api_key_info

lucasheld.uptime_kuma.api_key_info module -- Retrieves facts about api keys.

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.api_key_info.

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values

Synopsis

• Retrieves facts about api keys.

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
id integer	The id of the api key to inspect. Only required if no name specified.
name string	The name of the api key to inspect. Only required if no id specified.

Examples

- name: get all api keys
  lucasheld.uptime_kuma.api_key_info:
    api_url: http://127.0.0.1:3001
    api_username: admin
    api_password: secret123
  register: result

Return Values

Key	Description
api_keys complex	The api keys as list Returned: always
active boolean	True if the api key is active. Returned: always Sample: false
createdDate string	The creation date of the api key. Returned: always Sample: "2023-03-20 11:15:05"
expires string	The expiration date of the api key. Returned: always Sample: "2023-03-30 12:20:00"
id integer	The id of the api key. Returned: always Sample: 1
name string	The name of the api key. Returned: always Sample: "api key 1"
status string	The status of the api key. Returned: always Sample: "inactive"
userID integer	The user id of the api key. Returned: always Sample: 1

Authors

• Lucas Held (@lucasheld)

Collection links

Issue Tracker Repository (Sources)