Subcommand | Description |
---|---|
get | Retrieve trigger details for the given trigger id. |
list | Retrieve list of triggers based on specified filters. |
create | Create a new trigger on the cloud. |
update | Update an existing trigger on the cloud. |
create-template-file | Creates a template file that can be used for creation or update of a trigger. |
delete | Delete a trigger with a given ID. |
deploy | Deploy a trigger to a given system or all compatible systems. |
linked | Retrieve triggers that are linked to a given system. |
candidates | Provides a list of systems where the trigger can be deployed. |
--system-id
ID of the involved system.--trigger-id
ID of the involved trigger. Multiple can be given: e.g. --trigger-id 1
--trigger-id 2
--trigger-id 3
.--trigger-name
Name of the trigger to retrieve details for. Multiple can be given: --trigger-name name1
--trigger-name name2
.--priority
Priority of the trigger to retrieve details for. Multiple can be given: --priority 1
--priority 2
.--output-file
The result will be saved into this provided filepath. The output format is json, so please provide a filepath with that format:/path/to/file.json--output-file
flag. If the provided path doesn’t exist, it will be created. See example below where several filters can be used at the same time:
Usage:
--api-key
: Provide your USER_SECRET_KEY.--name
: Trigger name to create [required if not using a file].--description
: Description of the trigger [optional].--input-file
: Full path to the input file to use, it has to be a .json file, example : /path/to/input.json--folder-path
is provided, the template will be saved in the current directory.
Usage:
name
is mandatory. Other fields are optional and can be removed from the template file if not needed. Note that for the creation to work properly you need to remove the fields that are not necessary for your trigger.
If you need help to fill the template file, you can check the Trigger Options Help for more information about possible values of several fields.
--input-file
and --trigger-id
which are both required. You can generate a template file using the same command as for the creation:
Usage:
--api-key
: Provide your USER_SECRET_KEY [required].--trigger-id
: ID of the trigger to deploy [required].--system-id
: ID of the system to deploy the trigger to [mutually exclusive with --to-all-systems
].--to-all-systems
: Deploy to all compatible systems [mutually exclusive with --system-id
].--api-key
: Provide your USER_SECRET_KEY [required].--system-id
: ID of the system to retrieve linked triggers for [required].--output-file
: Filepath where the result will be saved (JSON format).--details
: If specified, shows detailed information (ID, status, etc.). If not, only trigger IDs are displayed.--details
is not provided, only the list of trigger IDs is shown.
--api-key
: Provide your USER_SECRET_KEY [required].--trigger-id
: ID of the trigger to check for compatible systems [required].--output-file
: Filepath where the result will be saved (JSON format recommended).trigger-id
. If the trigger is linked to any system, it is not possible to delete: you need to unlink it from the system(s) first and then try again.
Usage: