You can use the action-log utility to do the following:

  • Show the Action Log entries (all existing or those over a specified time period).

  • Show the rotation policy of the Action Log.

    Every day Plesk automatically deletes the Action Log entries the rotation policy considers to be outdated.

  • Set up which Action Log entries Plesk will automatically delete every day:

    • Those older than the specified retention period.
    • Those older than the specified number of the most recent entries.
    • None. In this case, Plesk does not automatically delete any Action Log entries.

See more information on the Action Log.

Usage 

action-log <command> [
<option_1> [<parameter_1>]
[<option_2> [<parameter_2>]]
]

Example

The following command shows all the Action Log entries from January 1, 2022, to the current date in the JSON format:

plesk bin action-log --show -since 2022-01-01 -json

Commands

Command Description Example
--show

Shows the Action Log entries.

Used with the -since and -until options.

If you do not specify the options, Plesk will show the entries from the beginning of the month until the current date.

To show the Action Log entries between January 1 and 18, 2022.

plesk bin action-log --show -since 2022-01-01 -until 2022-01-18

--info Shows the rotation policy of the Action Log entries.

To show the rotation policy of the Action Log entries:

plesk bin action-log --info

--update

Sets up which Action Log entries Plesk automatically deletes.

Used with the -type option.

To set up Plesk to keep all the Action Log entries:

plesk bin action-log --update -type forever

--help or -h Shows the help on the utility usage.

To show the help on the utility usage:

plesk bin action-log --help

or

plesk bin action-log -h

Options

Option Parameter Description Example
-since <YYYY-MM-DD>

Specifies the date from which Plesk shows the Action Log.

Used with the --show command and the -until option.

If you do not specify the -until option, Plesk will show the Action Log until the current date.

To show the Action Log from January 1, 2022, until the current date:

plesk bin action-log --show -since 2022-01-01

-until <YYYY-MM-DD>

Specifies the date up to which Plesk shows the Action Log.

Used with the --show command and the -since option.

If you do not specify the -since option, Plesk will show the Action Log from the beginning of the month.

To show the Action Log from the beginning of the month until January 18, 2022:

plesk bin action-log --show -until 2022-01-18

-type <by_period|by_number|forever>

Specifies the rotation policy of the Action Log.

Used with the --update command and the tandem of -period and -num-periods options or the -num-records option alone.

To set up Plesk to automatically delete all the Action Log entries older than a day:

plesk bin action-log --update -type by_period -period day -num-periods 1

To set up Plesk to keep the latest 1000 entries of the Action Log:

plesk bin action-log --update -type by_number -num-records 1000

-period <day|week|month>

Specifies the retention period of the Action Log entries.

Used with the --update command and the -num-periods option.

To set up Plesk to automatically delete all the Action Log entries older than a week:

plesk bin action-log --update -type by_period -period week -num-periods 1

-num-periods <number>

Specifies the retention period of the Action Log entries.

Used with the --update command followed by -type by_period and the -period option.

To set up Plesk to automatically delete all the Action Log entries older than 3 months:

plesk bin action-log --update -type by_period -period month -num-periods 3

-num-records <number>

Specifies the number of the most recent entries the Action Log keeps.

Used with the --update command followed by -type by_number.

To set up Plesk to keep the latest 999999 Action Log entries:

plesk bin action-log --update -type by_number -num-records 999999

-json  

Shows the output in the JSON format.

Used with the --show command. If you do not specify the option, all data will be shown in the raw format.

To show the Action Log entries:

plesk bin action-log --show