PlanetScale CLI commands: audit log

August 1, 2022

Getting Started

Make sure to first set up your PlanetScale developer environment. Once you've installed the pscale CLI, you can interact with PlanetScale and manage your databases straight from the command line.

The `audit log` command

Lists all audit logs in an organization. The user running the command must have Organization-level permissions, specifically list_organization_audit_logs.

Usage:

pscale audit-log <SUB-COMMAND> <FLAG>

Available sub-commands

Sub-command	Description
`list`	List all audit logs in an organization

Available flags

Flag	Description
`-h`, `--help`	View help for `audit-log` command
`--action`	Filter based on action type
`--limit` int	The number of events to return. Min: 1, Max: 100
`--starting-after` string	The ID of the audit log to start after (for pagination)
`--org <ORGANIZATION_NAME>`	The organization for the current user

Global flags

Command	Description
`--api-token <TOKEN>`	The API token to use for authenticating against the PlanetScale API.
`--api-url <URL>`	The base URL for the PlanetScale API. Default is `https://api.planetscale.com/`.
`--config <CONFIG_FILE>`	Config file. Default is `$HOME/.config/planetscale/pscale.yml`.
`--debug`	Enable debug mode.
`-f`, `--format <FORMAT>`	Show output in a specific format. Possible values: `human` (default), `json`, `csv`.
`--no-color`	Disable color output.
`--service-token <TOKEN>`	The service token for authenticating.
`--service-token-id <TOKEN_ID>`	The service token ID for authenticating.

Examples

The `list` sub-command with `--org` flag

Command:

pscale audit-log list --org <ORGANIZATION_NAME>

Output:

 ID (25)      ACTOR (25)  ACTION                   EVENT                     REMOTE IP      LOCATION         CREATED AT
------------- ----------- ------------------------ ------------------------ --------------- ---------------- ------------
xxxxxxxxxx  Name        Open_web_console main    branch.open_web_console  xxx.xxx.xxx.x   Los Angeles, CA  1 day ago

Pagination

Use the ID from the last result and pass it as the --starting-after to retrieve the next page of results.

pscale audit-log list --limit 5 --starting-after <ID>

Need help?

Get help from the PlanetScale Support team, or join our GitHub discussion board to see how others are using PlanetScale.