community.missing_collection.checkly_snippets_module.rst

community.missing_collection.checkly_snippets

Management of the checkly Snippets.

Version added: 0.3.0

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

Synopsis

• Management of the checkly Snippets
• https://www.checklyhq.com/docs/api#tag/Snippets

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 snippets.
id string		id of snippet.
name string		name of snippet.
script string		raw string of script code.
url string	Default: "https://api.checklyhq.com/v1/snippets/"	checkly api.

Examples

- name: create snippet
  community.missing_collection.checkly_snippets:
    api_key: 'b8155af5c45a476fb60c294c33ff549e'
    command: 'create'
    name: 'consoleTest'
    script: "console.log('test');"

- name: update snippet code
  community.missing_collection.checkly_snippets:
    api_key: 'b8155af5c45a476fb60c294c33ff549e'
    command: 'update'
    id: '1704'
    name: 'consoleTest'
    script: "console.log('test1');"

- name: delete snippet
  community.missing_collection.checkly_snippets:
    api_key: 'b8155af5c45a476fb60c294c33ff549e'
    command: 'delete'
    id: '1704'

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: {'created_at': '2021-09-05T21:51:23.164Z', 'id': 1705, 'name': 'consoleTest', 'script': "console.log('test');"}

Status

Authors

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