Audit channels

The CLI allows you to create, delete and update the Audit channel. The commands for these actions are shown in the table below.

Commands	Description
`create`	Create a new audit channel
`delete`	Delete an audit channel
`update`	Update an existing audit channel

List audit channels

Basic list

lenses-cli auditchannels

Detailed view

lenses-cli auditchannels --details

List audit channels with possible flags

lenses-cli auditchannels \
  --page=1 \
  --pageSize=10 \
  --sortField="name" \
  --sortOrder="asc" \
  --templateName=[TEMPLATE_NAME] \
  --channelName=[CHANNEL_NAME]

List audit channel templates

When creating audit channels, one of existing predefined channel templates needs to be used.

Such a command lists all available audit channel templates:

lenses-cli auditchannel-templates

To get all details, use JSON format:

lenses-cli auditchannel-templates --output JSON

Create new audit channel

lenses-cli auditchannels create \
  --name "my-audit-channel-1" \
  --connectionName=[CONECTION_NAME] \
  --templateName=[TEMPLATE_NAME] \
  --properties='[{"key":"body","value":"payload1-created"},{"key":"insecure","value":true},{"key":"method","value":"GET"}]'

Create new audit channel using a YAML file:

name: "my-audit-channel-2"
templateName: [TEMPLATE_NAME]
connectionName: [CONECTION_NAME]
properties:
  - key: "body"
    value: "body-payload"
  - key: "insecure"
    value: true
  - key: "method"
    value: "GET"

Save the file as audit_chann.yml and execute it like this:

lenses-cli auditchannels create audit_channel.yml

Update an audit channel

lenses-cli auditchannels update \
  --id [ID_OF_THE_CHANNEL_TO_BE_UPDATED] \
  --name "my-audit-channel-2-updated" \
  --connectionName=[CONNECTION_NAME] \
  --templateName=[TEMPLATE_NAME] \
  --properties='[{"key":"body","value":"payload1-created"},{"key":"insecure","value":true},{"key":"method","value":"GET"}]'

Delete an audit channel

lenses-cli auditchannels delete \
    --channelID=[ID_OF_THE_CHANNEL_TO_BE_UPDATED]

Last modified: September 26, 2024