---
canonical: https://docs.ideco.ru/v22/ru/ngfw/api/reverse-proxy-api
---



# Обратный прокси

::: page-constructor
blocks:
  - type: content-layout-block
    textContent:
      buttons:
        - text: Классический VCE
          theme: action
          width: 'auto'
        - text: Документация
          theme: outlined
          url: https://docs.ideco.ru/v22/ru/ngfw/settings/services/reverse-proxy
          width: 'auto'
    resetPaddings: false
    textWidth: l
    size: m
    centered: false
:::

{% cut "Получение списка публикаций" %}

```
GET /reverse_proxy_backend/user_sites
```

**Ответ на успешный запрос:**

```json5
[
    {
    "id": "string",
    "enabled": true | false,
    "dos_protection_enabled": true | false,
    "dos_protection_settings": {
      "limit_req": "integer",
      "limit_conn": "integer",
      "client_max_body_size": "integer",
    },
    "is_internal": true | false,
    "waf_profile": "string" | null,
    "redirect_http_to_https": true | false,
    "bind_remote_addr": true | false,
    "http2_compatibility": true | false,
    "site_type": "standard" | "owa",
    "domains_and_locations": ["string"],
    "target_schema": "http" | "https",
    "target_servers": ["string"],
    "target_path": "string",
    "comment": "string"
    },
    ...
]
```

* `id` - идентификатор публикации;
* `enabled` - публикация включена/выключена;
* `dos_protection_enabled` - защита от DoS включена/выключена;
* `dos_protection_settings` - параметры защиты от DoS:
  * `limit_req` - лимит запросов с одного IP в секунду, от `1` до `2^32 - 1`;
  * `limit_conn` - лимит подключений с одного IP, от `1` до `2^32 - 1`;
  * `client_max_body_size` - максимальный размер одного запроса, от `1` до `51200` МБ.
* `is_internal` - опция **Внутренний сервис Ideco NGFW Novum** включена/выключена;
* `waf_profile` - профиль WAF, может быть `null`. Должен быть `null`, если это внутренний ресурс (почта, ЛК, веб-интерфейс), максимальная длина - 42 символа;
* `redirect_http_to_https` - опция  **Перенаправлять HTTP-запросы на HTTPS** включена/выключена;
* `bind_remote_addr` - опция **Передавать web-серверу реальный IP-адрес клиента** включена/выключена;
* `http2_compatibility` - скрыть заголовки, запрещенные в HTTP/2;
* `site_type` - тип публикации: **Стандартный** или **Outlook Web Access**;
* `domains_and_locations` - непустой список доменов или доменов с путями, которые открыты для внешнего доступа. Каждый элемент списка представляет собой строку: `<домен или ip>[/<путь>]`;
* `target_schema` - доступ к публичному локальному веб-серверу осуществляется по протоколу `HTTP` или `HTTPS`;
* `target_servers` - непустой список адресов публикуемого локального веб-сервера, адрес может быть: `<IP-адрес>`, `<IP-адрес:порт>`, `<доменное_имя>`, `<доменное_имя:порт>`. Если `is_internal=false`, то в списке адресов нельзя указывать локальный адрес сервера (`127.0.0.1` или `localhost`);
* `target_path` - путь на публикуемом локальном веб-сервере: либо пустая строка, либо обязан начинаться с символа `/`;
* `comment` - комментарий, максимальная длина - 255 символов, может быть пустым.

Если значение `is_internal=true`, то необходимо выбрать один из трех сервисов: личный кабинет пользователя, веб-интерфейс или почта. Для этого укажите фиксированные значения:

* `target_servers`:
  * ЛК - `127.0.0.1:13303`;
  * Веб-интерфейс - `127.0.0.1:8443`;
  * Почта - `127.0.0.1:11071`.
* `target_path`:
  * ЛК - `/`;
  * Веб-интерфейс - `/`;
  * Почта - `/webmail`.
* `target_schema` - `https`;
* `bind_remote_addr` - `false`;
* `site_type` - `standard`.

{% endcut %}

{% cut "Создание публикации" %}

```
POST /reverse_proxy_backend/user_sites
```

**Json-тело запроса:**:

```json5
[
    {
    "enabled": true | false,
    "dos_protection_enabled": true | false,
    "dos_protection_settings": {
      "limit_req": "integer",
      "limit_conn": "integer",
      "client_max_body_size": "integer",
    },
    "is_internal": true | false,
    "waf_profile": "string" | null,
    "redirect_http_to_https": true | false,
    "bind_remote_addr": true | false,
    "http2_compatibility": true | false,
    "site_type": "standard" | "owa",
    "domains_and_locations": ["string"],
    "target_schema": "http" | "https",
    "target_servers": ["string"],
    "target_path": "string",
    "comment": "string"
    },
    ...
]
```
* `enabled` - публикация включена/выключена;
* `dos_protection_enabled` - защита от DoS включена/выключена;
* `dos_protection_settings` - параметры защиты от DoS:
  * `limit_req` - лимит запросов с одного IP в секунду, от `1` до `2^32 - 1`;
  * `limit_conn` - лимит подключений с одного IP, от `1` до `2^32 - 1`;
  * `client_max_body_size` - максимальный размер одного запроса, от `1` до `51200` МБ.
* `is_internal` - опция **Внутренний сервис Ideco NGFW Novum** включена/выключена;
* `waf_profile` - профиль WAF, может быть `null`. Должен быть `null`, если это внутренний ресурс (почта, ЛК, веб-интерфейс), максимальная длина - 42 символа;
* `redirect_http_to_https` - опция  **Перенаправлять HTTP-запросы на HTTPS** включена/выключена;
* `bind_remote_addr` - опция **Передавать web-серверу реальный IP-адрес клиента** включена/выключена;
* `http2_compatibility` - скрыть заголовки, запрещенные в HTTP/2;
* `site_type` - тип публикации: **Стандартный** или **Outlook Web Access**;
* `domains_and_locations` - непустой список доменов или доменов с путями, которые открыты для внешнего доступа. Каждый элемент списка представляет собой строку: `<домен или ip>[/<путь>]`;
* `target_schema` - доступ к публичному локальному веб-серверу осуществляется по протоколу `HTTP` или `HTTPS`;
* `target_servers` - непустой список адресов публикуемого локального веб-сервера, адрес может быть: `<IP-адрес>`, `<IP-адрес:порт>`, `<доменное_имя>`, `<доменное_имя:порт>`. Если `is_internal=false`, то в списке адресов нельзя указывать локальный адрес сервера (`127.0.0.1` или `localhost`);
* `target_path` - путь на публикуемом локальном веб-сервере: либо пустая строка, либо обязан начинаться с символа `/`;
* `comment` - комментарий, максимальная длина - 255 символов, может быть пустым.

Если значение `is_internal=true`, то необходимо выбрать один из трех сервисов: личный кабинет пользователя, веб-интерфейс или почта. Для этого укажите фиксированные значения:

* `target_servers`:
  * ЛК - `127.0.0.1:13303`;
  * Веб-интерфейс - `127.0.0.1:8443`;
  * Почта - `127.0.0.1:11071`.
* `target_path`:
  * ЛК - `/`;
  * Веб-интерфейс - `/`;
  * Почта - `/webmail`.
* `target_schema` - `https`;
* `bind_remote_addr` - `false`;
* `site_type` - `standard`.

**Ответ на успешный запрос:**

```json5
{
  "id": "string"
}
```

* `id` - идентификатор публикации.

{% endcut %}

{% cut "Изменение публикации" %}

```
PATCH /reverse_proxy_backend/user_sites/<id публикации>
```

**Json-тело запроса:**:

```json5
[
    {
    "enabled": true | false,
    "dos_protection_enabled": true | false,
    "dos_protection_settings": {
      "limit_req": "integer",
      "limit_conn": "integer",
      "client_max_body_size": "integer",
    },
    "is_internal": true | false,
    "waf_profile": "string" | null,
    "redirect_http_to_https": true | false,
    "bind_remote_addr": true | false,
    "http2_compatibility": true | false,
    "site_type": "standard" | "owa",
    "domains_and_locations": ["string"],
    "target_schema": "http" | "https",
    "target_servers": ["string"],
    "target_path": "string",
    "comment": "string"
    },
    ...
]
```

* `enabled` - публикация включена/выключена;
* `dos_protection_enabled` - защита от DoS включена/выключена;
* `dos_protection_settings` - параметры защиты от DoS:
  * `limit_req` - лимит запросов с одного IP в секунду, от `1` до `2^32 - 1`;
  * `limit_conn` - лимит подключений с одного IP, от `1` до `2^32 - 1`;
  * `client_max_body_size` - максимальный размер одного запроса, от `1` до `51200` МБ.
* `is_internal` - опция **Внутренний сервис Ideco NGFW Novum** включена/выключена;
* `waf_profile` - профиль WAF, может быть `null`. Должен быть `null`, если это внутренний ресурс (почта, ЛК, веб-интерфейс), максимальная длина - 42 символа;
* `redirect_http_to_https` - опция  **Перенаправлять HTTP-запросы на HTTPS** включена/выключена;
* `bind_remote_addr` - опция **Передавать web-серверу реальный IP-адрес клиента** включена/выключена;
* `http2_compatibility` - скрыть заголовки, запрещенные в HTTP/2;
* `site_type` - тип публикации: **Стандартный** или **Outlook Web Access**;
* `domains_and_locations` - непустой список доменов или доменов с путями, которые открыты для внешнего доступа. Каждый элемент списка представляет собой строку: `<домен или ip>[/<путь>]`;
* `target_schema` - доступ к публичному локальному веб-серверу осуществляется по протоколу `HTTP` или `HTTPS`;
* `target_servers` - непустой список адресов публикуемого локального веб-сервера, адрес может быть: `<IP-адрес>`, `<IP-адрес:порт>`, `<доменное_имя>`, `<доменное_имя:порт>`. Если `is_internal=false`, то в списке адресов нельзя указывать локальный адрес сервера (`127.0.0.1` или `localhost`);
* `target_path` - путь на публикуемом локальном веб-сервере: либо пустая строка, либо обязан начинаться с символа `/`;
* `comment` - комментарий, максимальная длина - 255 символов, может быть пустым.

Если значение `is_internal=true`, то необходимо выбрать один из трех сервисов: личный кабинет пользователя, веб-интерфейс или почта. Для этого укажите фиксированные значения:

* `target_servers`:
  * ЛК - `127.0.0.1:13303`;
  * Веб-интерфейс - `127.0.0.1:8443`;
  * Почта - `127.0.0.1:11071`.
* `target_path`:
  * ЛК - `/`;
  * Веб-интерфейс - `/`;
  * Почта - `/webmail`.
* `target_schema` - `https`;
* `bind_remote_addr` - `false`;
* `site_type` - `standard`.

**Ответ на успешный запрос:** 200 ОК

{% endcut %}

{% cut "Удаление публикации" %}

```
DELETE /reverse_proxy_backend/user_sites/<id публикации>
```

**Ответ на успешный запрос:** 200 ОК

{% endcut %}

