Get Started
GETTING STARTED

Authenticate

Create an org API key in Portal, copy it once, and log in from the CLI.

Do this once on each machine or CI environment that needs to call the run9 API.

An API key is org-scoped. Create it in the same org that owns the boxes or snaps you want to access.

Create an API key in Portal

Open Portal and go to the target org’s settings page:

  1. If you are on My Orgs, click Settings on the target org.
  2. If you are already inside that org workspace, use the left sidebar Org Settings.
  3. Open API Keys.
  4. Click Create API Key.
  5. Fill Description if you want a note for this key.
  6. Choose an Expire policy.
  7. Click Create API Key.
  8. Copy both Access Key and Secret Key from the result dialog.

Secret Key is shown only once, so copy it before closing the dialog.

Log in

run9 auth login \
  --endpoint https://api.run.sys9.ai \
  --ak ak-... \
  --sk sk-...

The public API endpoint is https://api.run.sys9.ai.

Check the current session

run9 auth whoami

Use whoami when you want to confirm that the CLI is using the key pair you just created.

Log out

run9 auth logout

If you revoke or rotate the key in Portal, log in again with the new key pair.