Skip to main content
PRE-RELEASE: route commands are not GA yet. Their arguments, flags, and output may change.
Manage the routes API keys you created, such as with harness setup, across all your machines and teams.

​
list

List the routes API keys you created, across all your machines and teams. Key values are never shown.

​
Options

​
TEXT
Filter JSON output with a jq expression; implies —output json (or jsonl for streamed commands)
​
TEXT
default:"text"
Output formatOne of: text, json, jsonl, none
​
TEXT
Use a specific stored profile for this command, overriding BASETEN_PROFILE and the current profile
​
BOOL
Enable verbose logging

​
Examples

List your routes API keys

​
Filter output with --jq

Print key prefixes

​
Output

Text mode (--output text): Table with NAME, PREFIX, TEAM, CREATED, and LAST USED columns. JSON mode (--output json): payload type managementapi.APIKeys.

​
delete

Delete one routes API key by prefix, or all of them with --all. Harnesses using a deleted key lose access until you rerun harness setup on that machine, which creates a new key.

​
Options

​
BOOL
Delete all your routes API keys, on every machine and team.Mutually exclusive with other flags in group key.
​
TEXT
Filter JSON output with a jq expression; implies —output json (or jsonl for streamed commands)
​
TEXT
default:"text"
Output formatOne of: text, json, jsonl, none
​
TEXT
Prefix of the key to delete, as shown by route api-key list.Mutually exclusive with other flags in group key.
​
TEXT
Use a specific stored profile for this command, overriding BASETEN_PROFILE and the current profile
​
BOOL
Skip the interactive confirmation prompt. Required when stdin is not a terminal.
​
BOOL
Enable verbose logging

​
Examples

Delete a lost machine’s key
Delete all your routes API keys without prompting

​
Filter output with --jq

Print deleted prefixes

​
Output

Text mode (--output text): Each deleted prefix, on stderr. JSON mode (--output json): payload type cmd.RouteAPIKeyDeleteResult. deleted lists the deleted prefixes and failed the ones that could not be deleted. The command fails if any deletion failed.