Copy page

CLI

Go live with CLI

Go live deploys everything in apitogo.config.json to APItoGo: the portal, the gateway, sign-in and plans.

Before you deploy

1. Sign in to APItoGo once on this computer:

   Code
   apitogo login

   In CI, set APITOGO_API_KEY_ID and APITOGO_API_SECRET (an API key from the dashboard) instead.

2. Check the config:

   Code
   apitogo check

Deploy

Code
apitogo deploy

On the first run, deploy creates the project: it asks for the hosting plan (Free, Starter or Professional) and writes the project's id into apitogo.config.json. Starter and Professional open the platform's checkout. To create the project without deploying, run apitogo project create --plan <plan>.

Then it sets up each service and prints what it did:

Code
identity: deployed (https://id.apitogo.com/<project>)
gateway: deployed (https://<name>.api.apitogo.com/), 12 operation(s)
plans: deployed, 2 plans, billing: stripe
portal: deployed to production (https://<name>.apitogo.com)
Deploy finished.

A step whose input has not changed since the last deploy is skipped. --force runs it anyway.

Secrets deploy asks for

Deploy asks, hidden, for the secrets the config needs and stores them as project secrets:

When	It asks for
plans.json has a plan with a price	Your Stripe secret key, then the webhook signing secret
identity.connections has a provider	That provider's client secret, under the name the config gives

Set up Stripe for paid plans shows where the Stripe values are. Set or change a secret yourself with apitogo secrets set <NAME>, and list them with apitogo secrets list.

Selling paid plans and using a custom domain need Starter or Professional. On Free, deploy stops at a paid plan and says so.

One service at a time

Code
apitogo deploy --only portal
apitogo deploy --only gateway,plans

--only takes portal, gateway, identity and plans.

Other flags

Flag	Purpose
--force	Redeploy even when nothing changed
--yes	Confirm a change that cannot be undone, such as another sign-in provider
--verbose	Show the build log and every platform step
--json	Print the result as JSON only
--project-id	Deploy to this project for this run only

To move the folder to another project for good, use apitogo project use <id> (see Commands).

After deploy

Code
apitogo status              # account, project and live checks
apitogo teardown --yes      # delete the project and everything in it

Your plans and APItoGo's

Kind	What it is	Where
Hosting plan	What you pay APItoGo: Free, Starter, Professional	Chosen on the first deploy or project create --plan
Your plans	What your users pay you for your API	apitogo/plans.json (Plans)

Related

• Walkthrough
• Commands
• Configuration overview
• MCP go live