community.missing_collection.checkly_runtimes_info_module.rst

community.missing_collection.checkly_runtimes_info

Get information from checkly about Runtimes.

Version added: 0.3.0

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values
• Status

Synopsis

• Get information from checkly about Runtimes.
• https://www.checklyhq.com/docs/api#tag/Runtimes

Requirements

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

• requests

Parameters

Parameter	Choices/Defaults	Comments
api_key string / required		api key for checkly.
id string		runtime id/name.
url string	Default: "https://api.checklyhq.com/v1/runtimes/"	checkly api.

Examples

- name: get details of all checkly runtimes
  community.missing_collection.checkly_runtimes_info:
    api_key: 'a8f0xxxxxxxxxxx00'
  register: __

- name: get details of one specific runtimes
  community.missing_collection.checkly_runtimes_info:
    api_key: 'a8f0xxxxxxxxxxx00'
    id: '{{ __.result[0].name }}'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
result dict/list	when success.	result of the api. Sample: [{'name': 'string', 'default': True, 'description': 'string', 'dependencies': {}}]

Status

Authors

• Davinder Pal (@116davinder) <dpsangwal@gmail.com>