Skip to main content

Topic: apiKey

Description

Commands in the apiKey topic are prefixed with shipthis apiKey. These commands let you create new keys, list existing ones, and revoke keys you no longer need.

info

ShipThis API keys are securely generated, random tokens used to authenticate requests to the ShipThis API. They are intended for automated environments, like CI pipelines, where manual login is not practical.
The raw key is only shown once when created, so make sure to copy and store it securely.

Example

asciicast

Commands

apiKey create

Description

Create a new API key for your ShipThis account.

Help Output

apiKey list

Description

Displays a list of your ShipThis API keys.

Help Output

apiKey revoke

Description

Revokes a specific ShipThis API key.

Help Output