Autentisering

Varje begäran som CLI:n skickar bär en API-nyckel till ditt projekt. Spara nycklar en gång med status200 login, en kontext för varje miljö, eller ge dem till ett kommando i flaggor eller miljövariabler, som skript gör. Den här sidan visar varje sätt, och vilket ett kommando använder när det finns flera.

Innan du börjar#

Du behöver en API-nyckel till ditt projekt. Skapa en under Projektinställningar → Avancerad → API-nycklar med Skapa API-nyckel, och ge den den åtkomst dina kommandon behöver: se Skapa en API-nyckel. En nyckel gör det dess behörigheter tillåter: en nyckel som bara får läsa poster kan lista och läsa dem, men inte ändra dem.

På Status200 Cloud fungerar API-nycklar bara så länge projektet har planen Growth eller högre. Under den svarar varje kommando med API error (402) och ett meddelande som nämner planen, tills projektet uppgraderas; då fungerar samma nyckel igen. Se API-nycklar och SCIM under sin plan.

Logga in#

status200 login sparar en API-nyckel och adressen till ditt Status200 som en kontext, och gör den till den aktuella kontexten:

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

Till exempel en kontext med namnet production:

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

Den svarar Logged in successfully. Context "production" is now active. Ett snedstreck i slutet av adressen tas bort, och en ny inloggning under samma namn ersätter den kontexten.

Kontexter#

En kontext är en sparad inloggning: ett namn, en adress och en API-nyckel. Spara en för varje projekt eller miljö, och välj sedan en för alla kommandon som följer, eller för ett enda kommando.

1. Spara en kontext för varje miljö#

   Bash

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

   Varje inloggning gör sin kontext till den aktuella, så nu är staging den aktuella.

2. Lista dem#

   Bash

   status200 context list

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

   * markerar den aktuella kontexten. API-nycklar listas aldrig.

3. Byt till en annan kontext#

   Bash

   status200 context use production

   Den svarar Switched to context "production". och kommandona som följer använder den.

4. Använd en kontext för ett kommando#

   Bash

   status200 incident list --context staging

   Den aktuella kontexten förblir som den var.

Vilka inloggningsuppgifter ett kommando använder#

Ett kommando behöver en API-nyckel och en URL. Det tar var och en av de två från den första av de här platserna som har den:

Du kan alltså blanda dem: till exempel en API-nyckel från en miljövariabel med URL:en från den aktuella kontexten. Miljövariabler passar skript och CI-jobb, som inte har några sparade kontexter:

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

Flaggor går före allt annat, för ett kommando:

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

Kontrollera vad CLI:n kommer att använda#

status200 whoami visar URL:en och API-nyckeln som nästa kommando kommer att använda, och kontexten de kommer från:

status200 whoami

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

Bara nyckelns fyra första och fyra sista tecken visas. Raden Context visas bara när URL:en och nyckeln är kontextens egna, inte värden som en flagga eller en miljövariabel har ersatt. whoami läser dina inställningar utan att anropa Status200: den visar vad ett kommando kommer att skicka, inte om Status200 godtar det. Är inget sparat eller satt, svarar den:

Not authenticated. Run `status200 login` to authenticate.

Konfigurationsfilen#

status200 login sparar kontexter i ~/.oneuptime/config.json, i din hemmapp (%USERPROFILE%\.oneuptime\config.json på Windows). CLI:n skapar den så att bara din användare kan läsa och skriva den (läge 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>"
    }
  }
}

Filen innehåller API-nycklarna som de är: håll den borta från delade mappar, säkerhetskopior och repositorier. Logga ut från en kontext genom att ta bort den med status200 context delete <name>; logga ut från alla genom att ta bort filen. En nyckel som kan ha läckt är giltig tills du tar bort den i Status200, under Projektinställningar → Avancerad → API-nycklar.

Utdataformat och liststorlekar sparas inte här: ge -o och --limit till varje kommando.

Felsökning#

Nästa steg#