API Key
Your API key is a persistent credential that authenticates all programmatic access to ShipStatic.
Format
ship-{64 hex characters}
Every key starts with the ship- prefix.
Properties
| Property | Value |
|---|---|
| Lifetime | Persistent - never expires |
| Scope | Full account access |
| Per account | One |
| Revocable | Yes - regenerate from the Web console |
Where to find it
Your API key is available in the Web console under Settings > API key.
Usage
The CLI, SDK, and API all authenticate with your API key:
# CLI - flag or environment variable
ship ./dist --api-key ship-abc123...
export SHIP_API_KEY=ship-abc123...// SDK - constructor option
new Ship({ apiKey: 'ship-abc123...' });// API - Authorization header
Authorization: Bearer ship-abc123...
Configuration
Store your API key once and every tool picks it up:
| Method | Used by |
|---|---|
SHIP_API_KEY environment variable |
CLI, SDK |
.shiprc file |
CLI, SDK |
package.json "ship" key |
CLI, SDK |
| Constructor option | SDK |
Authorization header |
API |
Run ship config to store your key interactively.
API Key vs Token
For automated or shared workflows, consider Tokens instead. Tokens are single-use, time-limited, and scoped to deploys only - safer for CI/CD pipelines and collaborators.
When both are present, the token takes precedence for that request.