> 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/api-skyone-autosky/api-sessoes.md).

# API Sessões

Chamadas de API para operação de sessões de Usuários.

**Base path:** `/sessions/`

Esta API pode ser utilizada para o controle de sessões de usuários. Você poderá listar as sessões ativas, desconectar usuários e/ou enviar mensagens que serão apresentadas para os usuários.

***

## Listar Sessões

Realiza a consulta das sessões que estão ativas na plataforma Autosky.

```http
GET /sessions/
```

### Parâmetros de Query (opcionais)

| Parâmetro  | Tipo   | Descrição                   |
| ---------- | ------ | --------------------------- |
| `cli_uuid` | string | UUID do cliente para filtro |

### Resposta

**Status:** `200 OK`

```json
[
    {
        "ssid": "9cfb4863",
        "client": {},
        "user": {},
        "instance": {},
        "creation_date": "2017-10-02T18:35:14.470434Z",
        "termination_date": null,
        "termination_reason": "",
        "status": "ativa",
        "my_ip": "99.99.99.99"
    }
]
```

### Campos do Objeto Sessão

| Campo                | Tipo        | Descrição                                 |
| -------------------- | ----------- | ----------------------------------------- |
| `ssid`               | string      | Identificador único da sessão             |
| `client`             | object      | Dados do cliente associado                |
| `user`               | object      | Dados do usuário associado                |
| `instance`           | object      | Dados da instância                        |
| `creation_date`      | string      | Data/hora de criação da sessão (ISO 8601) |
| `termination_date`   | string/null | Data/hora de encerramento da sessão       |
| `termination_reason` | string      | Motivo do encerramento                    |
| `status`             | string      | Status da sessão (ex: `ativa`)            |
| `my_ip`              | string      | IP do usuário                             |

***

## Obter dados de uma sessão

Obtém dados de uma sessão especificada por seu identificador.

```http
GET /sessions/{ssid}
```

### Parâmetros de Path

| Parâmetro | Obrigatório | Descrição          |
| --------- | ----------- | ------------------ |
| `ssid`    | Sim         | ID único da sessão |

### Resposta

**Status:** `200 OK`

Retorna o objeto da sessão com a mesma estrutura da listagem.

***

## Remover Sessão

Procedimento de remoção/desconexão de um usuário.

Quando utilizado, envia uma mensagem de desconexão ao usuário com um timer de desligamento. Caso o usuário não feche a sessão espontaneamente, a sessão é encerrada dentro do timer definido (em minutos).

```http
DELETE /sessions/{ssid}
```

### Parâmetros de Path

| Parâmetro | Obrigatório | Descrição          |
| --------- | ----------- | ------------------ |
| `ssid`    | Sim         | ID único da sessão |

### Body da Requisição

| Campo     | Tipo   | Obrigatório | Descrição                                    |
| --------- | ------ | ----------- | -------------------------------------------- |
| `time`    | number | Sim         | Tempo em minutos para encerramento da sessão |
| `message` | string | Não         | Mensagem de aviso de desconexão              |

### Exemplo de Requisição

```json
{
    "time": 10,
    "message": "Manutenção preventiva em 10 minutos"
}
```

### Resposta

**Status:** `200 OK`

```json
{
    "status": "success"
}
```


---

# 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/api-skyone-autosky/api-sessoes.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.
