community.missing_collection.checkly_variables_module.rst

community.missing_collection.checkly_variables

Management of the checkly environment variables.

Version added: 0.3.0

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

Synopsis

• Management of the checkly environment variables.
• https://www.checklyhq.com/docs/api#tag/Environment-variables

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.
command string	Choices: create ← update delete	type of operation on environment variables.
key string / required		environment key.
locked boolean	Choices: no ← yes	Used only in the UI to hide the value like a password.
url string	Default: "https://api.checklyhq.com/v1/variables/"	checkly api.
value string	Default: ""	environment value.

Examples

- name: create environment key-pair
  community.missing_collection.checkly_variables:
    api_key: '95e3814891ef433298150a539750076e'
    command: 'create'
    key: 'GITHUB_TOKEN'
    value: '95e3814891ef43329815'

- name: update value of key and locked
  community.missing_collection.checkly_variables:
    api_key: '95e3814891ef433298150a539750076e'
    command: 'update'
    key: 'GITHUB_TOKEN'
    value: '33298150a539750076e'
    locked: true

- name: delete key
  community.missing_collection.checkly_variables:
    api_key: '95e3814891ef433298150a539750076e'
    command: 'delete'
    key: 'GITHUB_TOKEN'

Return Values

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

Key	Returned	Description
result dictionary	when command is create/update and success.	result of checkly api. Sample: {'key': 'GITHUB_TOKEN', 'locked': False, 'value': '95e3814891ef43329815'}

Status

Authors

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