Authentication

Every request the CLI sends carries an API key of your project. Save keys once with status200 login, one context for each environment, or hand them to a command in flags or environment variables, as scripts do. This page shows each way, and which one a command uses when there are several.

Before you begin#

You need an API key of your project. Create one in Project Settings → Advanced → API Keys with Create API Key, and give it the access your commands need: see Create an API key. A key does what its permissions allow, so a key that may only read records can list and read them, but not change them.

On Status200 Cloud, API keys work only while the project is on the Growth plan or above. Below it, every command answers API error (402) with a message that names the plan, until the project is upgraded; then the same key works again. See API keys and SCIM below their plan.

Log in#

status200 login saves an API key and your Status200's address as a context, and makes it the current context:

status200 login <api-key> <instance-url> [--context-name <name>]

For example, a context named production:

status200 login <api-key> https://status200.ru --context-name production

It answers Logged in successfully. Context "production" is now active. A slash at the end of the address is removed, and logging in again under the same name replaces that context.

Contexts#

A context is a saved login: a name, an address and an API key. Save one for each project or environment, then choose one for all the commands that follow, or for a single command.

1. Save a context for each environment#

   Bash

   status200 login <production-api-key> https://status200.ru --context-name production
   status200 login <staging-api-key> https://status200.example.com --context-name staging

   Each login makes its context the current one, so staging is current now.

2. List them#

   Bash

   status200 context list

   ┌───┬────────────┬───────────────────────────────┐
   │   │ Name       │ URL                           │
   ├───┼────────────┼───────────────────────────────┤
   │   │ production │ https://status200.ru          │
   ├───┼────────────┼───────────────────────────────┤
   │ * │ staging    │ https://status200.example.com │
   └───┴────────────┴───────────────────────────────┘

   The * marks the current context. API keys are never listed.

3. Switch to another context#

   Bash

   status200 context use production

   It answers Switched to context "production". and the commands that follow use it.

4. Use a context for one command#

   Bash

   status200 incident list --context staging

   The current context stays as it was.

Which credentials a command uses#

A command needs an API key and a URL. It takes each of the two from the first of these places that has it:

So you can mix them: an API key from an environment variable with the URL of the current context, for example. Environment variables suit scripts and CI jobs, which have no saved contexts:

export STATUS200_API_KEY=<api-key>
export STATUS200_URL=https://status200.ru
status200 incident list

export STATUS200_API_KEY=<api-key>
export STATUS200_URL=https://status200.ru
status200 incident list

$env:STATUS200_API_KEY = "<api-key>"
$env:STATUS200_URL = "https://status200.ru"
status200 incident list

Flags come before everything else, for one command:

status200 --api-key <api-key> --url https://status200.ru incident list

Check what the CLI will use#

status200 whoami shows the URL and the API key the next command will use, and the context they come from:

status200 whoami

URL:     https://status200.ru
API Key: 4f1c****0a13
Context: production

Only the first four and the last four characters of the key are shown. The Context line appears only when the URL and the key are that context's own, not values a flag or an environment variable replaced. whoami reads your settings without calling Status200: it shows what a command will send, not whether Status200 accepts it. With nothing saved or set, it answers:

Not authenticated. Run `status200 login` to authenticate.

The configuration file#

status200 login saves contexts in ~/.oneuptime/config.json, in your home folder (%USERPROFILE%\.oneuptime\config.json on Windows). The CLI creates it so that only your user can read and write it (mode 0600):

{
  "currentContext": "production",
  "contexts": {
    "production": {
      "name": "production",
      "apiUrl": "https://status200.ru",
      "apiKey": "<api-key>"
    },
    "staging": {
      "name": "staging",
      "apiUrl": "https://status200.example.com",
      "apiKey": "<api-key>"
    }
  }
}

The file holds the API keys as they are: keep it out of shared folders, backups and repositories. To log out of one context, delete it with status200 context delete <name>; to log out of all of them, delete the file. A key that may have leaked stays valid until you delete it in Status200, in Project Settings → Advanced → API Keys.

Output formats and list sizes are not saved here: give -o and --limit to each command.

Troubleshooting#

Next steps#