Authentification

Chaque requête envoyée par la CLI porte une clé API de votre projet. Enregistrez les clés une fois avec status200 login, un contexte par environnement, ou donnez-les à une commande dans des options ou des variables d'environnement, comme le font les scripts. Cette page montre chaque façon de faire, et celle qu'une commande utilise quand il y en a plusieurs.

Avant de commencer#

Il vous faut une clé API de votre projet. Créez-en une dans Paramètres du projet → Avancé → Clés API avec Créer : Clé API, et donnez-lui l'accès dont vos commandes ont besoin : voir Créer une clé API. Une clé fait ce que ses autorisations permettent : une clé qui ne peut que lire des enregistrements peut les lister et les lire, mais pas les modifier.

Sur Status200 Cloud, les clés API ne fonctionnent que tant que le projet a l'offre Growth ou une offre supérieure. En dessous, chaque commande répond API error (402) avec un message qui nomme l'offre, jusqu'à ce que le projet passe à une offre supérieure ; la même clé fonctionne alors de nouveau. Voir Clés API et SCIM sous leur offre.

Se connecter#

status200 login enregistre une clé API et l'adresse de votre Status200 comme contexte, et en fait le contexte actuel :

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

Par exemple, un contexte nommé production :

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

Elle répond Logged in successfully. Context "production" is now active. Une barre oblique à la fin de l'adresse est retirée, et une nouvelle connexion sous le même nom remplace ce contexte.

Contextes#

Un contexte est une connexion enregistrée : un nom, une adresse et une clé API. Enregistrez-en un par projet ou par environnement, puis choisissez-en un pour toutes les commandes qui suivent, ou pour une seule commande.

1. Enregistrer un contexte par environnement#

   Bash

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

   Chaque connexion fait de son contexte le contexte actuel : c'est donc staging qui est actuel maintenant.

2. Les lister#

   Bash

   status200 context list

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

   Le * marque le contexte actuel. Les clés API ne sont jamais listées.

3. Passer à un autre contexte#

   Bash

   status200 context use production

   Elle répond Switched to context "production". et les commandes qui suivent l'utilisent.

4. Utiliser un contexte pour une seule commande#

   Bash

   status200 incident list --context staging

   Le contexte actuel reste tel qu'il était.

Les identifiants qu'une commande utilise#

Une commande a besoin d'une clé API et d'une URL. Elle prend chacune des deux au premier de ces endroits qui en a une :

Vous pouvez donc les combiner : par exemple une clé API tirée d'une variable d'environnement avec l'URL du contexte actuel. Les variables d'environnement conviennent aux scripts et aux tâches de CI, qui n'ont pas de contextes enregistrés :

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

Les options passent avant tout le reste, pour une seule commande :

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

Vérifier ce que la CLI va utiliser#

status200 whoami affiche l'URL et la clé API que la prochaine commande utilisera, et le contexte dont elles viennent :

status200 whoami

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

Seuls les quatre premiers et les quatre derniers caractères de la clé sont affichés. La ligne Context n'apparaît que si l'URL et la clé sont celles du contexte, et non des valeurs remplacées par une option ou une variable d'environnement. whoami lit vos réglages sans appeler Status200 : il montre ce qu'une commande enverra, pas si Status200 l'accepte. Quand rien n'est enregistré ni défini, il répond :

Not authenticated. Run `status200 login` to authenticate.

Le fichier de configuration#

status200 login enregistre les contextes dans ~/.oneuptime/config.json, dans votre dossier personnel (%USERPROFILE%\.oneuptime\config.json sous Windows). La CLI le crée de sorte que seul votre utilisateur puisse le lire et l'écrire (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>"
    }
  }
}

Le fichier contient les clés API telles quelles : gardez-le hors des dossiers partagés, des sauvegardes et des dépôts. Pour vous déconnecter d'un contexte, supprimez-le avec status200 context delete <name> ; pour vous déconnecter de tous, supprimez le fichier. Une clé qui a pu fuiter reste valide jusqu'à ce que vous la supprimiez dans Status200, dans Paramètres du projet → Avancé → Clés API.

Les formats de sortie et la taille des listes ne sont pas enregistrés ici : passez -o et --limit à chaque commande.

Dépannage#

Étapes suivantes#