opengnsys
/
ogboot
2
0
Fork 0
Code Issues Pull Requests 2 Packages Projects Releases Wiki Activity

refs #271 adds v1 to all endpoints and changes post oglives endpoint

pull/2/head
Luis Gerardo Romero Garcia 2024-04-12 13:05:06 +02:00
parent 171120d350
commit 59387e1b3d
1 changed files with 60 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

120
README.md
View File

@ -12,37 +12,37 @@ El presente documento detalla los endpoints del API con sus respectivos parámet
### Tabla de Contenido ### Tabla de Contenido
1. [Obtener configuración de ogboot](#obtener-configuración-de-ogboot) - `GET /ogboot/config` 1. [Obtener configuración de ogboot](#obtener-configuración-de-ogboot) - `GET /ogboot/v1/config`
2. [Obtener datos de rendimiento](#obtener-datos-de-rendimiento) - `GET /ogboot/status` 2. [Obtener datos de rendimiento](#obtener-datos-de-rendimiento) - `GET /ogboot/v1/status`
3. [Mostrar información de todos los clientes ogLive instalados](#mostrar-información-de-todos-los-clientes-oglive-instalados) - `GET /ogboot/oglives` 3. [Mostrar información de todos los clientes ogLive instalados](#mostrar-información-de-todos-los-clientes-oglive-instalados) - `GET /ogboot/v1/oglives`
4. [Mostrar información de un cliente ogLive instalado](#mostrar-información-de-todos-los-clientes-oglive-instalados) - `GET /ogboot/oglives/{Index|Dir}` 4. [Mostrar información de un cliente ogLive instalado](#mostrar-información-de-todos-los-clientes-oglive-instalados) - `GET /ogboot/v1/oglives/{Index|Dir}`
5. [Mostrar información del cliente ogLive predeterminado](#mostrar-información-del-cliente-oglive-predeterminado) - `GET /ogboot/oglives/default` 5. [Mostrar información del cliente ogLive predeterminado](#mostrar-información-del-cliente-oglive-predeterminado) - `GET /ogboot/v1/oglives/default`
6. [Cambiar ogLive predeterminado](#cambiar-oglive-predeterminado) - `POST /ogboot/oglives/default/{Index}` 6. [Cambiar ogLive predeterminado](#cambiar-oglive-predeterminado) - `POST /ogboot/v1/oglives/default/{Index}`
7. [Instalar nuevo cliente ogLive desde imagen descargada](#instalar-nuevo-cliente-oglive-desde-imagen-descargada) - `POST /ogboot/oglive/{Index/iso}` 7. [Instalar nuevo cliente ogLive desde imagen descargada](#instalar-nuevo-cliente-oglive-desde-imagen-descargada) - `POST /ogboot/v1/oglive/{Index/iso}`
8. [Desinstalar cliente ogLive y eliminar imagen](#desinstalar-cliente-oglive-y-eliminar-imagen) - `DELETE /ogboot/oglives/{Index/iso}` 8. [Desinstalar cliente ogLive y eliminar imagen](#desinstalar-cliente-oglive-y-eliminar-imagen) - `DELETE /ogboot/v1/oglives/{Index/iso}`
9. [Regenerar archivo de información de los ogLive](#regenerar-archivo-de-información-de-los-oglive) - `PUT /ogboot/oglives` 9. [Regenerar archivo de información de los ogLive](#regenerar-archivo-de-información-de-los-oglive) - `PUT /ogboot/v1/oglives`
10. [Mostrar menú de descarga de imagen de ogLive](#mostrar-menú-de-descarga-de-imagen-de-oglive) - `GET /ogboot/images/download` 10. [Mostrar menú de descarga de imagen de ogLive](#mostrar-menú-de-descarga-de-imagen-de-oglive) - `GET /ogboot/v1/images/download`
11. [Obtener todos los archivos de arranque](#obtener-todos-los-archivos-de-arranque) - `GET /ogboot/pxes` 11. [Obtener todos los archivos de arranque](#obtener-todos-los-archivos-de-arranque) - `GET /ogboot/v1/pxes`
12. [Obtener archivo de arranque](#obtener-archivo-de-arranque) - `GET /ogboot/clients/pxes/{mac}` 12. [Obtener archivo de arranque](#obtener-archivo-de-arranque) - `GET /ogboot/v1/clients/pxes/{mac}`
13. [Crear archivo de arranque](#crear-archivo-de-arranque) - `POST /ogboot/pxes` 13. [Crear archivo de arranque](#crear-archivo-de-arranque) - `POST /ogboot/v1/pxes`
14. [Eliminar archivo de arranque](#eliminar-archivo-de-arranque) - `DELETE /ogboot/clients/pxes` 14. [Eliminar archivo de arranque](#eliminar-archivo-de-arranque) - `DELETE /ogboot/v1/clients/pxes`
15. [Obtener todas las plantillas](#obtener-todas-las-plantillas) - `GET /ogboot/pxe-templates` 15. [Obtener todas las plantillas](#obtener-todas-las-plantillas) - `GET /ogboot/v1/pxe-templates`
16. [Obtener contenido de la plantilla](#obtener-contenido-de-la-plantilla) - `GET /ogboot/pxe-templates/{nombre}` 16. [Obtener contenido de la plantilla](#obtener-contenido-de-la-plantilla) - `GET /ogboot/v1/pxe-templates/{nombre}`
17. [Crear plantilla](#crear-plantilla) - `POST /ogboot/pxe-templates` 17. [Crear plantilla](#crear-plantilla) - `POST /ogboot/v1/pxe-templates`
18. [Regenerar plantilla](#regenerar-plantilla) - `PUT /ogboot/pxe-templates` 18. [Regenerar plantilla](#regenerar-plantilla) - `PUT /ogboot/v1/pxe-templates`
### Obtener Configuración de ogboot ### Obtener Configuración de ogboot
Devuelve la configuración actual del ogboot. Devuelve la configuración actual del ogboot.
**URL:** `/ogboot/config` **URL:** `/ogboot/v1/config`
**Método HTTP:** GET **Método HTTP:** GET
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/config curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/config
``` ```
**Respuestas:** **Respuestas:**
@ -66,13 +66,13 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/config
Devuelve la consistencia, errores de incompatibilidad y de configuración Devuelve la consistencia, errores de incompatibilidad y de configuración
**URL:** `/ogboot/status` **URL:** `/ogboot/v1/status`
**Método HTTP:** GET **Método HTTP:** GET
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/status curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/status
``` ```
**Respuestas:** **Respuestas:**
@ -95,13 +95,13 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/status
Muestra información en formato JSON sobre todos los clientes ogLive instalados. Muestra información en formato JSON sobre todos los clientes ogLive instalados.
**URL:** `/ogboot/clients/oglives` **URL:** `/ogboot/v1/clients/oglives`
**Método HTTP:** GET **Método HTTP:** GET
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/clients/oglives/ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/clients/oglives/
[ [
{ {
@ -133,7 +133,7 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/clients/ogliv
Muestra información en formato JSON sobre un cliente ogLive instalado específico. Muestra información en formato JSON sobre un cliente ogLive instalado específico.
**URL:** `/ogboot/clients/oglives/{Index|Dir}` **URL:** `/ogboot/v1/clients/oglives/{Index|Dir}`
**Método HTTP:** GET **Método HTTP:** GET
**Parámetros de la URL:** **Parámetros de la URL:**
@ -142,7 +142,7 @@ Muestra información en formato JSON sobre un cliente ogLive instalado específi
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/clients/oglives/1 curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/clients/oglives/1
{ {
"distribution": "focal", "distribution": "focal",
@ -163,13 +163,13 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/clients/ogliv
Muestra información en formato JSON sobre el cliente ogLive predeterminado. Muestra información en formato JSON sobre el cliente ogLive predeterminado.
**URL:** `/ogboot/clients/oglives/default` **URL:** `/ogboot/v1/clients/oglives/default`
**Método HTTP:** GET **Método HTTP:** GET
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/clients/oglives/default curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/clients/oglives/default
{ {
"distribution": "focal", "distribution": "focal",
@ -202,7 +202,7 @@ Establece un nuevo cliente ogLive como predeterminado utilizando su índice.
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X POST -H "Authorization: $API_KEY" http://example.com/ogboot/clients/oglives/default/1 curl -X POST -H "Authorization: $API_KEY" http://example.com/ogboot/v1/clients/oglives/default/1
``` ```
**Respuestas:** **Respuestas:**
@ -213,18 +213,18 @@ curl -X POST -H "Authorization: $API_KEY" http://example.com/ogboot/clients/ogli
### Descargar e Instalar Nuevo Cliente ogLive desde Imagen Descargada ### Descargar e Instalar Nuevo Cliente ogLive desde Imagen Descargada
Descarga y luego instala un nuevo cliente ogLive utilizando la imagen descargada, especificada por su índice o nombre de archivo ISO. Descarga y luego instala un nuevo cliente ogLive utilizando la imagen descargada, especificada por su nombre de archivo ISO en el parámetro de entrada.
**URL:** `/ogboot/oglive/{Index/iso}` **URL:** `/ogboot/v1/oglive`
**Método HTTP:** POST **Método HTTP:** POST
**Parámetros de la URL:** **Parámetros de Entrada:**
- `{Index/iso}`: El índice o nombre de archivo ISO de la imagen ogLive que se utilizará para la descarga e instalación. - `ISO: Nombre de la ISO que se desea descargar e instalar
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X POST -H "Authorization: $API_KEY" http://example.com/ogboot/oglive/1 curl -X POST -H "Authorization: $API_KEY" -d "ISO=ogLive-focal-5.13.0-27-beta-amd64-r20210706.5b4bf5f.iso" http://example.com/ogboot/v1/oglive
``` ```
**Respuestas:** **Respuestas:**
@ -238,7 +238,7 @@ curl -X POST -H "Authorization: $API_KEY" http://example.com/ogboot/oglive/1
Desinstala un cliente ogLive específico y elimina su imagen asociada. Desinstala un cliente ogLive específico y elimina su imagen asociada.
**URL:** `/ogboot/oglives/{Index/iso}` **URL:** `/ogboot/v1/oglives/{Index/iso}`
**Método HTTP:** DELETE **Método HTTP:** DELETE
**Parámetros de la URL:** **Parámetros de la URL:**
@ -247,7 +247,7 @@ Desinstala un cliente ogLive específico y elimina su imagen asociada.
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X DELETE -H "Authorization: $API_KEY" http://example.com/ogboot/oglives/1 curl -X DELETE -H "Authorization: $API_KEY" http://example.com/ogboot/v1/oglives/1
``` ```
**Respuestas:** **Respuestas:**
@ -259,13 +259,13 @@ curl -X DELETE -H "Authorization: $API_KEY" http://example.com/ogboot/oglives/1
Regenera el archivo de información de los clientes ogLive instalados. Regenera el archivo de información de los clientes ogLive instalados.
**URL:** `/ogboot/oglives` **URL:** `/ogboot/v1/oglives`
**Método HTTP:** PUT **Método HTTP:** PUT
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X PUT -H "Authorization: $API_KEY" http://example.com/ogboot/oglives curl -X PUT -H "Authorization: $API_KEY" http://example.com/ogboot/v1/oglives
``` ```
**Respuestas:** **Respuestas:**
@ -278,13 +278,13 @@ curl -X PUT -H "Authorization: $API_KEY" http://example.com/ogboot/oglives
Muestra un menú con opciones para descargar imágenes de ogLive disponibles. Muestra un menú con opciones para descargar imágenes de ogLive disponibles.
**URL:** `/ogboot/images/download` **URL:** `/ogboot/v1/images/download`
**Método HTTP:** GET **Método HTTP:** GET
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/images/download curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/images/download
``` ```
**Respuestas:** **Respuestas:**
@ -297,13 +297,13 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/images/downlo
Obtiene una lista de todos los archivos de arranque disponibles. Obtiene una lista de todos los archivos de arranque disponibles.
**URL:** `/ogboot/pxes` **URL:** `/ogboot/v1/pxes`
**Método HTTP:** GET **Método HTTP:** GET
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/pxes curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/pxes
``` ```
**Respuestas:** **Respuestas:**
@ -315,7 +315,7 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/pxes
Obtiene un archivo de arranque específico utilizando la dirección MAC del cliente. Obtiene un archivo de arranque específico utilizando la dirección MAC del cliente.
**URL:** `/ogboot/clients/pxes/{mac}` **URL:** `/ogboot/v1/clients/pxes/{mac}`
**Método HTTP:** GET **Método HTTP:** GET
**Parámetros de la URL:** **Parámetros de la URL:**
@ -324,7 +324,7 @@ Obtiene un archivo de arranque específico utilizando la dirección MAC del clie
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/clients/pxes/00:11:22:33:44:55 curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/clients/pxes/00:11:22:33:44:55
``` ```
**Respuestas:** **Respuestas:**
@ -338,7 +338,7 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/clients/pxes/
Crea un nuevo archivo de arranque utilizando los parámetros proporcionados. Crea un nuevo archivo de arranque utilizando los parámetros proporcionados.
**URL:** `/ogboot/pxes` **URL:** `/ogboot/v1/pxes`
**Método HTTP:** POST **Método HTTP:** POST
**Cuerpo de la Solicitud:** **Cuerpo de la Solicitud:**
@ -347,7 +347,7 @@ Crea un nuevo archivo de arranque utilizando los parámetros proporcionados.
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X POST -H "Authorization: $API_KEY" -d '{"name": "bootfile", "config": "some_configuration"}' http://example.com/ogboot/pxes curl -X POST -H "Authorization: $API_KEY" -d '{"name": "bootfile", "config": "some_configuration"}' http://example.com/ogboot/v1/pxes
``` ```
**Respuestas:** **Respuestas:**
@ -359,7 +359,7 @@ curl -X POST -H "Authorization: $API_KEY" -d '{"name": "bootfile", "config": "so
Elimina un archivo de arranque específico utilizando su identificador único. Elimina un archivo de arranque específico utilizando su identificador único.
**URL:** `/ogboot/clients/pxes` **URL:** `/ogboot/v1/clients/pxes`
**Método HTTP:** DELETE **Método HTTP:** DELETE
**Parámetros de la URL:** **Parámetros de la URL:**
@ -368,7 +368,7 @@ Elimina un archivo de arranque específico utilizando su identificador único.
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X DELETE -H "Authorization: $API_KEY" http://example.com/ogboot/clients/pxes/00:11:22:33:44:55 curl -X DELETE -H "Authorization: $API_KEY" http://example.com/ogboot/v1/clients/pxes/00:11:22:33:44:55
``` ```
**Respuestas:** **Respuestas:**
@ -381,7 +381,7 @@ curl -X DELETE -H "Authorization: $API_KEY" http://example.com/ogboot/clients/px
Actualiza el repositorio de archivos de arranque con los archivos modificados. Actualiza el repositorio de archivos de arranque con los archivos modificados.
**URL:** `/ogboot/pxes` **URL:** `/ogboot/v1/pxes`
**Método HTTP:** PUT **Método HTTP:** PUT
**Cuerpo de la Solicitud:** **Cuerpo de la Solicitud:**
@ -390,7 +390,7 @@ Actualiza el repositorio de archivos de arranque con los archivos modificados.
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X PUT -H "Authorization: $API_KEY" -H "Content-Type: application/json" -d @data.json http://example.com/ogboot/pxes curl -X PUT -H "Authorization: $API_KEY" -H "Content-Type: application/json" -d @data.json http://example.com/ogboot/v1/pxes
``` ```
**Respuestas:** **Respuestas:**
@ -403,13 +403,13 @@ curl -X PUT -H "Authorization: $API_KEY" -H "Content-Type: application/json" -d
Obtiene una lista de todas las plantillas de arranque disponibles. Obtiene una lista de todas las plantillas de arranque disponibles.
**URL:** `/ogboot/pxe-templates` **URL:** `/ogboot/v1/pxe-templates`
**Método HTTP:** GET **Método HTTP:** GET
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/pxe-templates curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/pxe-templates
``` ```
**Respuestas:** **Respuestas:**
@ -422,7 +422,7 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/pxe-templates
Obtiene el contenido de una plantilla de arranque específica utilizando su nombre. Obtiene el contenido de una plantilla de arranque específica utilizando su nombre.
**URL:** `/ogboot/pxe-templates/{nombre}` **URL:** `/ogboot/v1/pxe-templates/{nombre}`
**Método HTTP:** GET **Método HTTP:** GET
**Parámetros de la URL:** **Parámetros de la URL:**
@ -431,7 +431,7 @@ Obtiene el contenido de una plantilla de arranque específica utilizando su nomb
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/pxe-templates/template1 curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/v1/pxe-templates/template1
``` ```
**Respuestas:** **Respuestas:**
@ -444,7 +444,7 @@ curl -X GET -H "Authorization: $API_KEY" http://example.com/ogboot/pxe-templates
Crea una nueva plantilla de arranque utilizando los datos proporcionados. Crea una nueva plantilla de arranque utilizando los datos proporcionados.
**URL:** `/ogboot/pxe-templates` **URL:** `/ogboot/v1/pxe-templates`
**Método HTTP:** POST **Método HTTP:** POST
**Cuerpo de la Solicitud:** **Cuerpo de la Solicitud:**
@ -453,7 +453,7 @@ Crea una nueva plantilla de arranque utilizando los datos proporcionados.
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X POST -H "Authorization: $API_KEY" -H "Content-Type: application/json" -d '{"name": "template1", "content": "template_content"}' http://example.com/ogboot/pxe-templates curl -X POST -H "Authorization: $API_KEY" -H "Content-Type: application/json" -d '{"name": "template1", "content": "template_content"}' http://example.com/ogboot/v1/pxe-templates
``` ```
**Respuestas:** **Respuestas:**
@ -465,7 +465,7 @@ curl -X POST -H "Authorization: $API_KEY" -H "Content-Type: application/json" -d
Regenera el contenido de una plantilla de arranque específica utilizando su nombre. Regenera el contenido de una plantilla de arranque específica utilizando su nombre.
**URL:** `/ogboot/pxe-templates/{nombre}` **URL:** `/ogboot/v1/pxe-templates/{nombre}`
**Método HTTP:** PUT **Método HTTP:** PUT
**Parámetros de la URL:** **Parámetros de la URL:**
@ -474,7 +474,7 @@ Regenera el contenido de una plantilla de arranque específica utilizando su nom
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X PUT -H "Authorization: $API_KEY" http://example.com/ogboot/pxe-templates/template1 curl -X PUT -H "Authorization: $API_KEY" http://example.com/ogboot/v1/pxe-templates/template1
``` ```
**Respuestas:** **Respuestas:**
@ -487,7 +487,7 @@ curl -X PUT -H "Authorization: $API_KEY" http://example.com/ogboot/pxe-templates
Elimina una plantilla de arranque específica utilizando su nombre. Elimina una plantilla de arranque específica utilizando su nombre.
**URL:** `/ogboot/pxe-templates/{nombre}` **URL:** `/ogboot/v1/pxe-templates/{nombre}`
**Método HTTP:** DELETE **Método HTTP:** DELETE
**Parámetros de la URL:** **Parámetros de la URL:**
@ -496,7 +496,7 @@ Elimina una plantilla de arranque específica utilizando su nombre.
**Ejemplo de Solicitud:** **Ejemplo de Solicitud:**
```bash ```bash
curl -X DELETE -H "Authorization: $API_KEY" http://example.com/ogboot/pxe-templates/template1 curl -X DELETE -H "Authorization: $API_KEY" http://example.com/ogboot/v1/pxe-templates/template1
``` ```
**Respuestas:** **Respuestas:**