shipthis/docs/apiKey.md

ShipThis manages building and uploading your Godot games to the App Store and Google Play.

# 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](https://asciinema.org/a/bfCPQIvDNt5zlgcEQhcs7o6Fr.svg)](https://asciinema.org/a/bfCPQIvDNt5zlgcEQhcs7o6Fr#shipthis-col80row24)

## Commands

### `apiKey create`

#### Description

Create a new API key for your ShipThis account.

#### Help Output

```help
USAGE
  $ shipthis apiKey create [-n <value>] [-d <value>] [-q]

FLAGS
  -d, --durationDays=<value>  [default: 365] duration of the API key in days
  -n, --name=<value>          name to apply to the API key (if not provided, a random name will be generated)
  -q, --quiet                 Outputs just the secret value

DESCRIPTION
  Create a new API key for your ShipThis account.

EXAMPLES
  $ shipthis apiKey create --durationDays 30

  $ shipthis apiKey create --name ci-key --durationDays 90

  $ shipthis apiKey create --name ci-key-headless --durationDays 365 --quiet
```

### `apiKey list`

#### Description

Displays a list of your ShipThis API keys.

#### Help Output

```help
USAGE
  $ shipthis apiKey list [-r asc|desc] [-o createdAt|updatedAt|name] [-p <value>] [-s <value>]

FLAGS
  -o, --orderBy=<option>    [default: createdAt] The field to order by
                            <options: createdAt|updatedAt|name>
  -p, --pageNumber=<value>  The page number to show (starts at 0)
  -r, --order=<option>      [default: desc] The order to sort by
                            <options: asc|desc>
  -s, --pageSize=<value>    [default: 10] The number of items to show per page

DESCRIPTION
  Displays a list of your ShipThis API keys.

EXAMPLES
  $ shipthis apiKey list

  $ shipthis apiKey list --pageNumber 1

  $ shipthis apiKey list --orderBy createdAt --order asc
```

### `apiKey revoke`

#### Description

Revokes a specific ShipThis API key.

#### Help Output

```help
USAGE
  $ shipthis apiKey revoke APIKEYID [-q]

ARGUMENTS
  APIKEYID  The ID of the API key to revoke

FLAGS
  -q, --quiet  Suppress output except for errors

DESCRIPTION
  Revokes a specific ShipThis API key.

EXAMPLES
  $ shipthis apiKey revoke abcd1234

  $ shipthis apiKey revoke abcd1234 --quiet
```