Creating API Tokens

shipa token create [--id/-i token-id] [--team/-t team] [--description/-d description] [--expires/-e expiration]

The command above creates a new API token associated to a team.

Flag

Description

-e, --expires

(= 0s) The expiration for the token is created. A duration suffix is mandatory (s for seconds, m for minutes, h for hours, ...). 0 or unset means it never expires.

-i, --id

(= "") A unique identifier for the token is created.

-t, --team

(= "") The team name responsible for this token.

Updating API Token

shipa token update <token-id> [--regenerate] [--description/-d description] [--expires/-e expiration]

The command above creates a new API token associated to a team.

Flag

Description

-e, --expires

(= 0s) The expiration for the token is updated. A duration suffix is mandatory ('s' for seconds, 'm' for minutes, 'h' for hours, ...). Setting to 0 or unset means the previous value will be used. Setting to a negative value will remove any existing expiration.

--regenerate

(= false) Setting regenerate will change the value of the token, invalidating the previous value.

Deleting a Token API

shipa token delete <token id>

Deletes an existing token.

Listing Tokens

The command below lists existing API tokens associated with a team.

shipa token list

Did this page help you?