> 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/es/automation-api/api-helper-script.md).

# Script de ayuda de la API

El `yb-api` el script auxiliar proporciona una forma sencilla para que los desarrolladores interactúen con la API de VergeOS. Simplifica la realización de llamadas a la API, como recuperar máquinas virtuales, actualizar configuraciones y gestionar recursos. Esta guía describirá los comandos clave y el uso del `yb-api` script.

## Requisitos previos

* Acceso a un sistema VergeOS.
* Acceso al clúster mediante SSH o conexión directa.
* **wget** y **curl** debe estar instalado en el sistema para ciertas operaciones.

### Ejecución del script auxiliar

Para obtener ayuda o ver las opciones disponibles, ejecute:

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

Conéctese al nodo y ejecute este comando para comenzar a usar el asistente de la API.

![Ejemplo de yb-api](/files/f6e71c29a72969876157a45ede3b29882f6db9c6)

## Comandos de ejemplo

A continuación se muestran ejemplos de cómo usar `yb-api` para diversas tareas de administración de VM.

### Obtener una lista de máquinas virtuales (excluyendo instantáneas)

Recuperar una lista de VM y filtrar las instantáneas.

```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
```

### Volcado simple de todas las VM

Este comando recupera una lista de todas las VM. Los `--server`, `--user`, `--filter`, y `--fields` indicadores son opcionales en este caso.

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

### Obtener información detallada de la VM

Recupere la mayoría de los campos, incluida la información de discos y NIC, para una VM específica (VM 1 en este caso).

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

### Cambiar el nombre de una máquina virtual

Cambie el nombre de una máquina virtual existente (VM 1) a "NEWNAME".

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

### Eliminar una máquina virtual

Eliminar una VM específica (VM 1), usando su `$key`.

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

### Crear una nueva máquina virtual

Crear una nueva VM con configuraciones específicas (nombre, núcleos de CPU, RAM, etc.).

```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
```

### Obtener el esquema de la tabla de la base de datos de VM

Recupere el esquema de la tabla de la base de datos de VM.

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

### Clonar una máquina virtual

Clonar una VM existente (VM 1) y darle un nuevo nombre.

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

### Encender una máquina virtual

Encender una VM existente (VM 1).

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

## Notas sobre `yb-api`

* El `yb-api` el script depende de **wget**, que puede no estar instalado de forma predeterminada en macOS. Asegúrese de instalarlo si es necesario.
* **curl** se utiliza para la función de carga en ciertas llamadas a la API, como enviar datos para crear nuevas VM.

***

Al usar el `yb-api` script auxiliar, los desarrolladores pueden simplificar la interacción con la API de VergeOS y gestionar las máquinas virtuales de manera más eficiente. Háganos saber si necesita ayuda con más comandos u opciones.

***

{% hint style="info" %}
**Información del documento**

* Última actualización: 2024-08-29
* Versión de vergeOS: 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/es/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.