Autenticação

Cada requisição que a CLI envia leva uma chave de API do seu projeto. Salve as chaves uma vez com status200 login, um contexto para cada ambiente, ou passe-as a um comando em flags ou variáveis de ambiente, como fazem os scripts. Esta página mostra cada forma, e qual delas um comando usa quando há várias.

Antes de começar#

Você precisa de uma chave de API do seu projeto. Crie uma em Configurações do projeto → Avançado → Chaves de API com Criar: Chave de API, e dê a ela o acesso de que seus comandos precisam: veja Criar uma chave de API. Uma chave faz o que suas permissões permitem: uma chave que só pode ler registros pode listá-los e lê-los, mas não alterá-los.

No Status200 Cloud, as chaves de API só funcionam enquanto o projeto está no plano Growth ou superior. Abaixo dele, todo comando responde API error (402) com uma mensagem que nomeia o plano, até que o projeto seja atualizado; então a mesma chave volta a funcionar. Veja Chaves de API e SCIM abaixo do plano.

Fazer login#

status200 login salva uma chave de API e o endereço do seu Status200 como um contexto, e o torna o contexto atual:

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

Por exemplo, um contexto chamado production:

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

Ela responde Logged in successfully. Context "production" is now active. Uma barra no fim do endereço é removida, e fazer login de novo com o mesmo nome substitui esse contexto.

Contextos#

Um contexto é um login salvo: um nome, um endereço e uma chave de API. Salve um para cada projeto ou ambiente e depois escolha um para todos os comandos seguintes, ou para um único comando.

1. Salvar um contexto para cada ambiente#

   Bash

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

   Cada login torna o seu contexto o atual, então agora o atual é staging.

2. Listá-los#

   Bash

   status200 context list

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

   O * marca o contexto atual. As chaves de API nunca são listadas.

3. Trocar para outro contexto#

   Bash

   status200 context use production

   Ela responde Switched to context "production". e os comandos seguintes o usam.

4. Usar um contexto para um único comando#

   Bash

   status200 incident list --context staging

   O contexto atual continua como estava.

Quais credenciais um comando usa#

Um comando precisa de uma chave de API e de uma URL. Ele pega cada uma das duas do primeiro destes lugares que a tiver:

Então você pode combiná-los: por exemplo, uma chave de API de uma variável de ambiente com a URL do contexto atual. Variáveis de ambiente combinam com scripts e jobs de CI, que não têm contextos salvos:

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

As flags vêm antes de tudo, para um único comando:

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

Verificar o que a CLI vai usar#

status200 whoami mostra a URL e a chave de API que o próximo comando vai usar, e o contexto de onde elas vêm:

status200 whoami

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

Só os quatro primeiros e os quatro últimos caracteres da chave são mostrados. A linha Context aparece apenas quando a URL e a chave são as do próprio contexto, e não valores que uma flag ou uma variável de ambiente substituiu. O whoami lê suas configurações sem chamar o Status200: ele mostra o que um comando vai enviar, não se o Status200 aceita. Sem nada salvo nem definido, ele responde:

Not authenticated. Run `status200 login` to authenticate.

O arquivo de configuração#

status200 login salva os contextos em ~/.oneuptime/config.json, na sua pasta pessoal (%USERPROFILE%\.oneuptime\config.json no Windows). A CLI o cria de forma que só o seu usuário possa lê-lo e gravá-lo (modo 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>"
    }
  }
}

O arquivo guarda as chaves de API como elas são: mantenha-o fora de pastas compartilhadas, backups e repositórios. Para sair de um contexto, exclua-o com status200 context delete <name>; para sair de todos, exclua o arquivo. Uma chave que possa ter vazado continua válida até que você a exclua no Status200, em Configurações do projeto → Avançado → Chaves de API.

Os formatos de saída e os tamanhos de lista não são salvos aqui: passe -o e --limit a cada comando.

Solução de problemas#

Próximos passos#