hardis:org:diagnose:legacyapi
Description
Checks if an org uses retired or someday retired API version
See article below
This command is part of sfdx-hardis Monitoring and can output Grafana, Slack and MsTeams Notifications.
Agent Mode
Supports non-interactive execution with --agent:
sf hardis:org:diagnose:legacyapi --agent --target-org myorg@example.com
In agent mode, the command runs fully automatically with no interactive prompts.
Parameters
| Name | Type | Description | Default | Required | Options |
|---|---|---|---|---|---|
| agent | boolean | Run in non-interactive mode for agents and automation. Uses default values and skips prompts. | |||
| debug -d |
boolean | Activate debug mode (more logs) | |||
| eventtype -e |
option | Type of EventLogFile event to analyze | ApiTotalUsage | ||
| flags-dir | option | undefined | |||
| json | boolean | Format output as json. | |||
| limit -l |
option | Number of latest EventLogFile events to analyze | 999 | ||
| outputfile -f |
option | Force the path and name of output report file. Must end with .csv | |||
| skipauth | boolean | Skip authentication check when a default username is required | |||
| target-org -o |
option | undefined | |||
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration |
Examples
$ sf hardis:org:diagnose:legacyapi
$ sf hardis:org:diagnose:legacyapi -u hardis@myclient.com
$ sf hardis:org:diagnose:legacyapi --outputfile 'c:/path/to/folder/legacyapi.csv'
$ sf hardis:org:diagnose:legacyapi -u hardis@myclient.com --outputfile ./tmp/legacyapi.csv
$ sf hardis:org:diagnose:legacyapi --agent