Connect a Postman API key to check your work
You do each step in Postman, then LiftOff uses your key to look at your workspace and confirm it's done. Connect once and it works for every module. Your key is saved in this browser and is only used to check your work in Postman.
The UI push is great for a one-off publish. The Postman CLI runs the same sync from your terminal — useful when you already live in git, or when you later automate the step in CI.
Publish with `postman workspace push`
Run the CLI against your connected deskly-api folder so local Postman files sync to the same Cloud View you just used.
-
Open the Postman terminal (or any terminal) in your connected
deskly-apifolder. Confirm you're still on thefeature/branch that has your collection. -
Confirm the Postman CLI is available:
postman --versionIf the command isn't found, install the CLI, then retry. Pick one method:
npm (Windows, macOS, and Linux):
npm install -g postman-clicurl (macOS, Linux, and WSL):
curl -o- "https://dl-cli.pstmn.io/install/unix.sh" | shDon't mix both installers — you can end up with two
postmanbinaries. More options: Install the Postman CLI. -
Log in to the Postman CLI. The command below uses the same API key already connected to LiftOff. The key stays masked on this page; Copy puts the real command on your clipboard so you can paste it into the terminal.
commandpostman login --with-api-key $POSTMAN_API_KEY
Connect your Postman API key in Settings first — then Copy will fill it into this command.
Prefer a browser instead? Run
postman loginwith no flags — a window opens and you sign in there.For CI/CD or a server with no browser, don't paste a personal key into the workflow. Store it as a secret named
POSTMAN_API_KEYand run:postman login --with-api-key $POSTMAN_API_KEYDon't commit an API key to the repo.
-
From the repo root (where
.postman/andpostman/live), publish:postman workspace push -yThe
-y/--yesflag skips interactive confirmation — handy in scripts. Omit it if you want to review the prompt first. -
Switch back to Cloud View in the desktop app and confirm Deskly API (and any other items you pushed) are still there.
Expected outcome: The CLI completes without errors, and Cloud View still shows your Deskly elements.
CI note (optional reading): The same postman workspace push -y command can run in GitHub Actions after merge — install the CLI, log in with a POSTMAN_API_KEY secret, then push. You don't need to add that workflow for this module; see Automate Native Git with CI/CD for the official example.
Caution: Keep secrets out of Git. Use local environment values in the app for credentials; only commit Shared values you intend to share.
Troubleshooting
- Not logged in — Copy the masked command above (or re-run
postman loginfor the browser flow). Use aPOSTMAN_API_KEYsecret only in CI or on a server with no browser. - Wrong directory —
cdto the connecteddeskly-apiroot so the CLI can see.postman/andpostman/. - Nothing to push — Local View and Cloud View may already match; that's fine if Cloud View still shows Deskly API.