The Code42 CLI
code42 command to interact with your Code42 environment.
code42 security-datais a CLI tool for extracting AED events. Additionally, you can choose to only get events that Code42 previously did not observe since you last recorded a checkpoint (provided you do not change your query).
code42 high-risk-employeeis a collection of tools for managing the high risk employee detection list. Similarly, there is
- Python 3.6.2+
code42 CLI using:
$ python3 -m pip install code42cli
First, create your profile:
code42 profile create --name MY_FIRST_PROFILE --server example.authority.com --username email@example.com
Your profile contains the necessary properties for logging into Code42 servers. After running
code42 profile create,
the program prompts you about storing a password. If you agree, you are then prompted to input your password.
Your password is not shown when you do
code42 profile show. However,
code42 profile show will confirm that a
password exists for your profile. If you do not set a password, you will be securely prompted to enter a password each
time you run a command.
For development purposes, you may need to ignore ssl errors. If you need to do this, use the
option when creating your profile:
code42 profile create -n MY_FIRST_PROFILE -s https://example.authority.com -u firstname.lastname@example.org --disable-ssl-errors
You can add multiple profiles with different names and the change the default profile with the
code42 profile use MY_SECOND_PROFILE
--profile flag is available on other commands, such as those in
security-data, it will use that profile
instead of the default one. For example,
code42 security-data search -b 2020-02-02 --profile MY_SECOND_PROFILE
To see all your profiles, do:
code42 profile list
Security Data and Alerts
Using the CLI, you can query for security events and alerts just like in the admin console, but the results are output to stdout so they can be written to a file or piped out to another process (for sending to an external syslog server, for example).
The following examples pertain to security events, but can also be used for alerts by replacing
To print events to stdout, do:
code42 security-data search -b <begin_date>
--begin is usually required.
And end date can also be given with
--end to query for a specific date range (if end is not passed, it will get all events up to the present time).
To specify a begin/end time, you can pass a date or a date w/ time as a string:
code42 security-data search -b '2020-02-02 12:51:00'
code42 security-data search -b '2020-02-02 12:30'
code42 security-data search -b '2020-02-02 12'
code42 security-data search -b 2020-02-02
or a shorthand string specifying either days, hours, or minutes back from the current time:
code42 security-data search -b 30d
code42 security-data search -b 10d -e 12h
Begin date will be ignored if provided on subsequent queries using
Use other formats with
code42 security-data search -b 2020-02-02 -f CEF
The available formats are CEF, JSON, and RAW-JSON. Currently, CEF format is only supported for security events.
To write events to a file, just redirect your output:
code42 security-data search -b 2020-02-02 > filename.txt
To send events to an external server, use the
send-to command, which behaves the same as
search except for defaulting
RAW-JSON output and sending results to an external server instead of to stdout:
The default port (if none is specified on the address) is the standard syslog port 514, and default protocol is UDP:
code42 security-data send-to 10.10.10.42 -b 1d
Results can also be sent over TCP to any port by using the
-p/--protocol flag and adding a port to the address argument:
code42 security-data send-to 10.10.10.42:8080 -p TCP -b 1d
Note: For more complex requirements when sending to an external server (SSL, special formatting, etc.), use a dedicated
syslog forwarding tool like
rsyslog or connection tunneling tool like
If you want to periodically run the same query, but only retrieve the new events each time, use the
-c/--use-checkpoint option with a name for your checkpoint. This stores the timestamp of the query's last event to a
file on disk and uses that as the "begin date" timestamp filter on the next query that uses the same checkpoint name.
Checkpoints are stored per profile.
Initial run requires a begin date:
code42 security-data search -b 30d --use-checkpoint my_checkpoint
Subsequent runs do not:
code42 security-data search --use-checkpoint my_checkpoint
You can also use wildcard for queries, but note, if they are not in quotes, you may get unexpected behavior.
code42 security-data search --actor "*"
The search query parameters are as follows:
--include-non-exposure(does not work with
--advanced-query(raw JSON query)
You cannot use other query parameters if you use
To learn more about acceptable arguments, add the
-h flag to
The CLI can also access "saved searches" that are stored in the admin console, and run them via their saved search ID.
saved-search list subcommand to list existing searches with their IDs:
code42 security-data saved-search list
show subcommand will give details about the search with the provided ID:
code42 security-data saved-search show <ID>
To get the results of a saved search, use the
--saved-search option with your search ID on the
code42 security-data search --saved-search <ID>
You can both add and remove employees from detection lists using the CLI. This example uses
code42 high-risk-employee add email@example.com --notes "These are notes" code42 high-risk-employee remove firstname.lastname@example.org
Detection lists include a
bulk command. To add employees to a list, you can pass in a csv file. First, generate the
csv file for the desired command by executing the
code42 high-risk-employee bulk generate-template add
generate-template takes a
cmd parameter for determining what type of template to generate. In the
example above, we give it the value
add to generate a file for bulk adding users to the high risk employee list.
Next, fill out the csv file with all the users and then pass it in as a parameter to
code42 high-risk-employee bulk add users_to_add.csv
Note that for
bulk remove, the file only has to be an end-line delimited list of users with one line per user.
security-data, only the first 10,000 of each set of events containing the exact same insertion timestamp is
If you keep getting prompted for your password, try resetting with
code42 profile reset-pw.
If that doesn't work, delete your credentials file located at ~/.code42cli or the entry in keychain.
Shell tab completion
To enable shell autocomplete when you hit
tab after the first few characters of a command name, do the following:
For Bash, add this to ~/.bashrc:
eval "$(_CODE42_COMPLETE=source_bash code42)"
For Zsh, add this to ~/.zshrc:
eval "$(_CODE42_COMPLETE=source_zsh code42)"
For Fish, add this to ~/.config/fish/completions/code42.fish:
eval (env _CODE42_COMPLETE=source_fish code42)
Open a new shell to enable completion. Or run the eval command directly in your current shell to enable it temporarily.
The CLI exposes a few helpers for writing custom extension scripts powered by the CLI. Read the user-guide here.