> For the complete documentation index, see [llms.txt](https://docs.verge.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.verge.io/knowledge-base/de/automation-api/api-helper-script.md).

# API-Hilfsskript

Der `yb-api` Das Hilfsskript bietet Entwicklern eine einfache Möglichkeit, mit der VergeOS-API zu interagieren. Es vereinfacht API-Aufrufe wie das Abrufen virtueller Maschinen, das Aktualisieren von Konfigurationen und die Verwaltung von Ressourcen. Dieser Leitfaden beschreibt die wichtigsten Befehle und die Verwendung des `yb-api` Skripts.

## Voraussetzungen

* Zugriff auf ein VergeOS-System.
* Zugriff auf den Cluster über SSH oder direkte Verbindung.
* **wget** und **curl** muss für bestimmte Vorgänge auf dem System installiert sein.

### Ausführen des Hilfsskripts

Um Hilfe zu erhalten oder die verfügbaren Optionen anzuzeigen, führen Sie aus:

```bash
yb-api --help
```

Verbinden Sie sich mit dem Knoten und führen Sie diesen Befehl aus, um den API-Helfer zu verwenden.

![yb-api-Beispiel](/files/b6d72fdfc6acd710e51714dc6aabf1ffbbff4278)

## Beispielbefehle

Nachfolgend sind Beispiele dafür, wie man `yb-api` für verschiedene VM-Verwaltungsaufgaben verwendet.

### Eine Liste der virtuellen Maschinen abrufen (ohne Snapshots)

Rufen Sie eine Liste der VMs ab und filtern Sie Snapshots heraus.

```bash
yb-api --get --user=admin --server=10.0.0.100 \\
--fields='name,$key,ram,machine#status#status as machine_status' \\
--filter='is_snapshot eq false' /v4/vms
```

### Einfache Ausgabe aller VMs

Dieser Befehl ruft eine Liste aller VMs ab. Die `--server`, `--user`, `--filter`, und `--fields` Schalter sind in diesem Fall optional.

```bash
yb-api --get /v4/vms
```

### Detaillierte VM-Informationen abrufen

Rufen Sie die meisten Felder ab, einschließlich Informationen zu Laufwerken und NICs, für eine bestimmte VM (in diesem Fall VM 1).

```bash
yb-api --get --user=admin --server=10.0.0.100 \\
--fields='most,machine[most,drives[most],nics[most]]' /v4/vms/1
```

### Eine virtuelle Maschine umbenennen

Ändern Sie den Namen einer vorhandenen virtuellen Maschine (VM 1) in "NEWNAME".

```bash
yb-api --put='{"name":"NEWNAME"}' --user=admin --server=10.0.0.100 /v4/vms/1
```

### Eine virtuelle Maschine löschen

Löschen Sie eine bestimmte VM (VM 1) mithilfe ihrer `$key`.

```bash
yb-api --delete --user=admin --server=10.0.0.100 \\
--fields='name,$key,ram' /v4/vms/1
```

### Eine neue virtuelle Maschine erstellen

Erstellen Sie eine neue VM mit bestimmten Konfigurationen (Name, CPU-Kerne, RAM usw.).

```bash
yb-api --post='{"name":"NEWVM","enabled":true,"description":"test vm",\
"os_family":"linux","cpu_cores":4,"ram":"8192"}' --user=admin \\
--server=10.0.0.100 /v4/vms
```

### Das Datenbankschema der VM-Tabelle abrufen

Rufen Sie das Schema für die Datenbanktabelle der VMs ab.

```bash
yb-api --get --user=admin --server=10.0.0.100 '/v4/vms/$table'
```

### Eine virtuelle Maschine klonen

Klonen Sie eine vorhandene VM (VM 1) und geben Sie ihr einen neuen Namen.

```bash
yb-api --get --user=admin --server=10.0.0.100 '/v4/vm_actions' \\
--post='{"vm":1, "action": "clone", "params": {"name": "NEW VM NAME"}}'
```

### Eine virtuelle Maschine einschalten

Schalten Sie eine vorhandene VM (VM 1) ein.

```bash
yb-api --get --user=admin --server=10.0.0.100 '/v4/vm_actions' \\
--post='{"vm":1, "action": "poweron"}'
```

## Hinweise zu `yb-api`

* Der `yb-api` Das Skript basiert auf **wget**, das unter macOS möglicherweise nicht standardmäßig installiert ist. Stellen Sie sicher, es bei Bedarf zu installieren.
* **curl** wird für die Upload-Funktion in bestimmten API-Aufrufen verwendet, z. B. beim Senden von Daten zum Erstellen neuer VMs.

***

Durch die Verwendung des `yb-api` Hilfsskripts können Entwickler die Interaktion mit der VergeOS-API vereinfachen und virtuelle Maschinen effizienter verwalten. Lassen Sie uns wissen, wenn Sie Hilfe bei weiteren Befehlen oder Optionen benötigen.

***

{% hint style="info" %}
**Dokumentinformationen**

* Zuletzt aktualisiert: 2024-08-29
* vergeOS-Version: 4.12.6
  {% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.verge.io/knowledge-base/de/automation-api/api-helper-script.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.