Skip to content
Hotrail

Docs

Account and API keys

Create a Hotrail account, an organization and an API key for the CLI and CI.

Create your account

Go to https://hotrail.buffersoltech.com and sign in with your email. We send a magic link, so there is no password to set. Your first sign in creates an organization that holds your apps, members and billing.

New accounts start on the Free plan. You can upgrade from Settings, then Billing, at any time.

Create an API key

Open Settings, then API keys, and create a key. The full key is shown once, so copy it into your secrets manager straight away. Keys are stored as hashes and cannot be recovered. Use the key in the CLI and in CI as HOTRAIL_API_KEY.

Check the key

Send the key in the x-api-key header. This call returns the organization the key belongs to.

bash
curl https://hotrail.buffersoltech.com/api/v1/me \
  -H "x-api-key: YOUR_API_KEY"

Next steps

Follow the quickstart to ship a first bundle or migrate from @capgo/capacitor-updater. Read the authentication guide to add passkeys and two factor sign in. Set up webhooks to receive events in your own systems.