24fire-api

Die 24fire-api soll die Interaktion mit der 24fire Kunden Api vereinfachen und verbessern.

Features

• 🔗 Kommunikation über SSL
• 🏃 Schnelle interaktion
• ➡️ Direkte Anfragen ohne Middelware
• ℹ️ Einfache Bedienung
• 🆕 Neuste Version

Optimierungen & Feedback

Welche Optimierungen hast du in deinem Code vorgenommen? Z.B. Refactoring, Performance-Verbesserungen

Wenn du Feedback hast, wenden dich an mich unter [email protected]

Author & Credits

• Flostechnikwelt
• Lars.1309

Empfehlenswert

• Offizielle API Dokumentation
• 24fire
• Discord

Wie wird es installiert?

Um die 24fire-api in deinem Projekt zu installieren, führe bitte den folgenden Befehl aus

  npm install 24fire-api

Wie bekomme ich einen API Key?

Jeder Kunde hat die möglichkeit für seine VM einen API-Key zu bekommen.

1. Wähle deinen Server aus

2. Öffne das Menu durch den Buttn mit den drei Strichen

3. Klicke auf "API-Key anzeigen"

4. Nun sollte dieses Modal erscheinen, hier kannst du den API-Key kopieren

## Wie verwende ich fireapi-24fire?

Einen fireApi Client erstellen

  const fireApi = require("24fire-api")
  const apiKey = 'DEIN_API_SCHLÜSSEL';
  const myFireApi = new fireApi(apiKey);

VM

-> Zeige die VM Konfiguration an

  myFireApi.vm().getVMconfig().then(data => {
    console.log('VM config:', data);
  }).catch(error => {
    console.error('Fehler:', error);
  });

-> Den aktuellen VM Status Abrufen

  myFireApi.vm().getVMstatus().then(data => {
    console.log('Aktueller VM Status:', data);
  }).catch(error => {
    console.error('Fehler:', error);
  });

-> Die VM Starten

  myFireApi.vm().startVM().then(data => {
    console.log('Antwort: ', data);
  }).catch(error => {
    console.error('Fehler: ', error);
  });

-> Die VM herunterfahren

  myFireApi.vm().stopVM().then(data => {
    console.log('Antwort: ', data);
  }).catch(error => {
    console.error('Fehler: ', error);
  });

-> Die VM neustarten

  myFireApi.vm().restartVM().then(data => {
    console.log('Antwort:', data);
  }).catch(error => {
    console.error('Fehler:', error);
  });

Backup

-> Alle Backups auflisten

  myFireApi.backup().listBackups().then(data => {
    console.log('Backup List:', data);
  }).catch(error => {
    console.error('Fehler:', error);
  });

-> Ein neues Backup erstellen

  myFireApi.backup().createBackup(description).then(data => {
    console.log('Antwort:', data);
  }).catch(error => {
    console.error('Fehler:', error);
  });

Parameter	Type	Description
description	string	Optional. Es kann optional ein Beschreibung hinzugefügt werden.

-> Ein Backup Löschen

  myFireApi.backup().deleteBackup(backupId).then(data => {
    console.log('Antwort: ', data);
  }).catch(error => {
    console.error('Fehler: ', error);
  });

Parameter	Type	Description
backupId	string	Benötigt. Die ID vom Backup welches gelöscht werden soll.

Monitoring

-> Alle Messungen vom Server Abrufen

  myFireApi.monitoring().getStats().then(data => {
    console.log('Alle Messungen:', data);
  }).catch(error => {
    console.error('Fehler:', error);
  });

-> Alle Ausfälle abrufen

  myFireApi.monitoring().retieceOutages().then(data => {
    console.log('Antwort:', data);
  }).catch(error => {
    console.error('Fehler:', error);
  });