> For the complete documentation index, see [llms.txt](https://docs.skyone.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.skyone.cloud/espanol/api-skyone-autosky/api-ambientes.md).

# API Ambientes

Llamadas de API para la operación de Ambientes.

```
Base path: /environments/
```

***

## Listar Ambientes

Listado de todos los ambientes.

```http
GET /environments/
```

### Respuesta

**Status:** `200 OK`

```json
[
    {
        "amb_uuid": "dd2f7c4e-8dee-4ecc-8033-f21207945d55",
        "nome": "Ambiente 1",
        "in_maintenance": false,
        "maintenance_msg": "En mantenimiento",
        "schedule_maintenance": false,
        "schedule_maintenance_start": "2020-12-11T03:10:14-03:00",
        "schedule_maintenance_end": "2020-12-12T07:35:15-03:00",
        "schedule_maintenance_msg": "En mantenimiento",
        "terminate_sessions": false,
        "terminate_instances": false,
        "schedule_warning": false,
        "schedule_warning_start": "2020-12-24T00:00:00-03:00",
        "schedule_warning_end": "2020-12-25T00:00:00-03:00",
        "schedule_warning_msg": "¡Feliz Navidad!",
        "display_warning_to_logged_users": false,
        "environment_state": "available",
        "preparation_server": {
            "instance_id": "ocid1.instance.oc1...",
            "name": "TEMPLATE_SERVER_NAME",
            "public_ip": "1.2.3.4",
            "private_ip": "4.3.2.1",
            "instance_state": "RUNNING",
            "stop_time": "2021/03/15 19:42:25"
        }
    }
]
```

### Campos del Objeto Ambiente

<table><thead><tr><th width="219.267578125">Campo</th><th width="144.5048828125">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td><code>amb_uuid</code></td><td>string</td><td>Identificador único del ambiente</td></tr><tr><td><code>nome</code></td><td>string</td><td>Nombre del ambiente</td></tr><tr><td><code>in_maintenance</code></td><td>boolean</td><td>Si está en mantenimiento inmediato</td></tr><tr><td><code>maintenance_msg</code></td><td>string</td><td>Mensaje de mantenimiento</td></tr><tr><td><code>schedule_maintenance</code></td><td>boolean</td><td>Si tiene mantenimiento programado activo</td></tr><tr><td><code>schedule_maintenance_start</code></td><td>string/null</td><td>Fecha/hora de inicio del mantenimiento programado</td></tr><tr><td><code>schedule_maintenance_end</code></td><td>string/null</td><td>Fecha/hora de fin del mantenimiento programado</td></tr><tr><td><code>schedule_maintenance_msg</code></td><td>string</td><td>Mensaje del mantenimiento programado</td></tr><tr><td><code>terminate_sessions</code></td><td>boolean</td><td>Si finaliza las sesiones durante el mantenimiento</td></tr><tr><td><code>terminate_instances</code></td><td>boolean</td><td>Si finaliza las instancias durante el mantenimiento</td></tr><tr><td><code>schedule_warning</code></td><td>boolean</td><td>Si tiene aviso programado activo</td></tr><tr><td><code>schedule_warning_start</code></td><td>string/null</td><td>Fecha/hora de inicio del aviso</td></tr><tr><td><code>schedule_warning_end</code></td><td>string/null</td><td>Fecha/hora de fin del aviso</td></tr><tr><td><code>schedule_warning_msg</code></td><td>string</td><td>Mensaje del aviso</td></tr><tr><td><code>display_warning_to_logged_users</code></td><td>boolean</td><td>Si muestra el aviso a los usuarios ya conectados</td></tr><tr><td><code>environment_state</code></td><td>string</td><td>Estado del ambiente (ej: available)</td></tr><tr><td><code>preparation_server</code></td><td>object/null</td><td>Datos del servidor de preparación (puede ser null)</td></tr></tbody></table>

***

## Obtener datos de un ambiente

Obtiene los datos de un ambiente especificado por su UUID.

```http
GET /environments/{amb_uuid}
```

### Parámetros de Path

| Parámetro  | Obligatorio | Descripción       |
| ---------- | ----------- | ----------------- |
| `amb_uuid` | Sí          | UUID del ambiente |

### Respuesta

**Status:** `200 OK`

Devuelve el objeto del ambiente con la misma estructura que el listado.

***

## Activar / Desactivar mantenimiento inmediato

Activa o desactiva el mantenimiento inmediato en un ambiente completo.

```http
PATCH /environments/{amb_uuid}
```

### Parámetros de Path

| Parámetro  | Obligatorio | Descripción       |
| ---------- | ----------- | ----------------- |
| `amb_uuid` | Sí          | UUID del ambiente |

### Cuerpo de la Solicitud

| Campo             | Tipo    | Obligatorio | Descripción                                                           |
| ----------------- | ------- | ----------- | --------------------------------------------------------------------- |
| `in_maintenance`  | boolean | Sí          | `true` para activar, `false` para desactivar                          |
| `maintenance_msg` | string  | No          | Mensaje presentado a los usuarios durante el próximo inicio de sesión |

### Respuesta

**Status:** `200 OK`

Devuelve el objeto del ambiente actualizado.

***

## Activar / Desactivar mantenimiento programado

Activa o desactiva el mantenimiento programado en un ambiente completo.

Es obligatorio especificar todos los campos a continuación cuando `schedule_maintenance` sea `true`.

```http
PATCH /environments/{amb_uuid}
```

### Parámetros de Path

| Parámetro  | Obligatorio | Descripción       |
| ---------- | ----------- | ----------------- |
| `amb_uuid` | Sí          | UUID del ambiente |

### Cuerpo de la Solicitud

| Campo                        | Tipo    | Obligatorio | Descripción                                                  |
| ---------------------------- | ------- | ----------- | ------------------------------------------------------------ |
| `schedule_maintenance`       | boolean | Sí          | Activa/desactiva el mantenimiento programado                 |
| `schedule_maintenance_start` | string  | Condicional | Fecha/hora de inicio. Formato: 2021-12-01T23:10:00.000-03:00 |
| `schedule_maintenance_end`   | string  | Condicional | Fecha/hora de finalización                                   |
| `schedule_maintenance_msg`   | string  | Condicional | Mensaje presentado a los usuarios                            |
| `terminate_sessions`         | boolean | No          | Finaliza las sesiones de los usuarios activos                |
| `terminate_instances`        | boolean | No          | Finaliza las instancias activas                              |

### Respuesta

**Status:** `200 OK`

Devuelve el objeto del ambiente actualizado.

***

## Activar / Desactivar avisos programados

Activa o desactiva la visualización programada de avisos en un ambiente completo.

Es obligatorio especificar todos los campos a continuación cuando `schedule_warning` sea `true`.

```http
PATCH /environments/{amb_uuid}
```

### Parámetros de Path

| Parámetro  | Obligatorio | Descripción       |
| ---------- | ----------- | ----------------- |
| `amb_uuid` | Sí          | UUID del ambiente |

### Cuerpo de la Solicitud

| Campo                             | Tipo    | Obligatorio | Descripción                                   |
| --------------------------------- | ------- | ----------- | --------------------------------------------- |
| `schedule_warning`                | boolean | Sí          | Activa/desactiva los avisos programados       |
| `schedule_warning_start`          | string  | Condicional | Fecha/hora de inicio                          |
| `schedule_warning_end`            | string  | Condicional | Fecha/hora de finalización                    |
| `schedule_warning_msg`            | string  | Condicional | Mensaje del aviso                             |
| `display_warning_to_logged_users` | boolean | Condicional | Muestra el aviso a los usuarios ya conectados |

### Respuesta

**Status:** `200 OK`

Devuelve el objeto del ambiente actualizado.


---

# 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.skyone.cloud/espanol/api-skyone-autosky/api-ambientes.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.