Перейти к содержанию

Постоянный доступ

На этой странице приведены описания методов API, предназначенных для работы с устройствами из раздела Постоянный доступ.

Терминология

В контексте API-вызовов устройства обозначаются как Агенты, поскольку технически управление устройством осуществляется через приложение Агент.

Управление устройствами

Список устройств

Вы можете получить полный список компьютеров используя метод agents/list

Запрос:
GET /v1/agents/list
  ?search=<string>
  &group_id=<string>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -G "https://api.pro32connect.ru/v1/agents/list" \
  --data-urlencode "search=<string>" \
  --data-urlencode "group_id=<string>" \
  -H "X-Api-Key: YOUR_API_KEY" \
Параметр Тип Значение
search string Поиск по имени агента, IP-адресу или названию группы
group_id string Фильтр по идентификатору группы

Группировка устройств

Подробнее о работе с группами устройств см. в руководстве Группировка устройств.

Ответ:
Пример ответа
Данные ответа
{
    "data":[ {
        "id":1001,
        "name":"Allesandro Paci",
        "group":"Accounting",
        "disabled":false,
        "limited":false,
        "link_time":1587837997,
        "last_time":1600374761,
        "geo":{
            "ip":"94.242.23.99",
            "country":"Russia",
            "region":"St.-Petersburg",
            "city":"St Petersburg"
        },
        "permanent_url":"https://https://go.pro32connect.ru/paci",
        "preview_url":"https://pro32connect.ru/preview/1245273f5448a704379da46f476564a592efb17c6a7695adde96247cd7874416GbBzRm6SRLMqrP0YoYFMxCopL6NTzvn8.png",
        "os":"win",
        "version":"1.9.4",
        "online":true,
        "installed":true,
        "favorite":false,
        "owner":"john.smith@gmail.com",
        "sessions":{
            "last":{
                "id":148505,
                "start_time":1600343858,
                "stop_time":1600343900,
                "client":{
                    "ip":"188.162.195.82",
                    "country":"Russian Federation",
                    "region":"Tatarstan",
                    "city":"Kazan",
                    "user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36"
                }
            },
            "total":121
        }
    }, ... ]
}
Название Тип Описание
id number Внутрисистемный идентификатор
device_id number Публичный идентификатор агента
name string Название
group string Группа
disabled boolean
Агент заблокирован?

⚠ К заблокированным агентам подключится нельзя. Блокировка наступает в случае превышения лимита по количеству компьютеров в тарифного плана.
limited boolean
Агент лимитирован?

ℹ Агент становится лимитированным в случае превышения лимита тарифного плана по количестсву прикрепленных файлов. Через 10 дней после добавления лимитированный агент становится заблокированным.
link_time unixtime Дата и время добавления в личный кабинет
last_time unixtime Дата и время последнего состояния «В сети»
geo object Гео-расположение
geo.ip string IP адрес
geo.country string Страна
geo.region string Регион
geo.city string Город
permanent_url string
Постоянный URL-адрес для подключения

ℹ Поле может отсутствовать, если доступ для неавторизованных техников закрыт
onetime_url string
URL-адрес для одноразового подключения

⚠ Ссылка меняется каждые 45 секунд

ℹ Поле может отсутствовать, если подключения по одноразовым ссылкам запрещены в настройках агента
preview_url string URL-адрес для загрузки превью рабочего стола
os string Операционная система. Возможные значения: win, mac, linux и android
os_user string Пользователь ОС
rdp bool Поддержка RDP
hibernate bool Режим сна
power_supply bool Питание
version string Версия агента
online boolean Текущее состояние «В сети»
installed boolean Агент установлен на компьютере?
favorite boolean Это избранный компьютер в списке в личном кабинете?
owner string Учетная запись владельца доступа к компьютеру внутри системы
sessions object Информация о подключениях
sessions.last object Последнее подключение
sessions.last.id number Внутри-системный идентификатор подключения
sessions.last.start_time unixtime Дата и время начала подключения
sessions.last.stop_time unixtime Дата и время конца подключения

ℹ Поле может отсутствовать, если подключение активно
sessions.last.client object Информация о клиенте (автор подключения)
sessions.last.client.ip string IP-адрес
sessions.last.client.country string Страна
sessions.last.client.region string Регион
sessions.last.client.city string Город
sessions.last.client.user_agent string Пользовательский агент браузера клиента
sessions.total object Общее количество подключений

Информация об устройстве

Чтобы получить информацию об устройстве из раздела Постоянный доступ, используйте метод agents/info:

Запрос:
GET /v1/agents/info
  &agent_id=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -G "https://api.pro32connect.ru/v1/agents/info" \
  --data-urlencode "agent_id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY" \
Параметр Тип Значение
agent_id number Внутрисистемный идентификатор агента
Ответ:
Пример ответа
Данные ответа
{
    "data": {
        "id": 1001,
        "name": "Allesandro Paci",
        "group": "Accounting",
        "disabled": false,
        "limited": false,
        "link_time": 1587837997,
        "last_time": 1600374761,
        "geo": {
            "ip": "94.242.23.99",
            "country": "Russia",
            "region": "St.-Petersburg",
            "city": "St Petersburg"
        },
        "permanent_url": "https://https://go.pro32connect.ru/paci",
        "onetime_url": "https://https://go.pro32connect.ru/am2-l2g",
        "preview_url": "https://pro32connect.ru/preview/1245273f5448a704379da46f476564a592efb17c6a7695adde96247cd7874416GbBzRm6SRLMqrP0YoYFMxCopL6NTzvn8.png",
        "os": "win",
        "version": "2.7.6",
        "online": true,
        "installed": true,
        "favorite": false,
        "owner": "john.smith@gmail.com",
        "hardware": {
            "BIOS": "ALASKA - 1072009 - F51 - American Megatrends - 5000E",
            "BIOSDate": "",
            "BIOSVersion": "20191218",
            "CPU": "AMD Ryzen 5 2600X Six-Core Processor",
            "CPUCores": 6,
            "CPUCoresLogical": 12,
            "CPUFamily": "AMD64 Family 23 Model 8 Stepping 2",
            "CPUSpeed": 3600,
            "ComputerDomain": "WORKGROUP",
            "ComputerIP": [
                "10.66.65.3",
                "fe80::35da:bb0:c661:fff9"
            ],
            "ComputerModel": "B450 AORUS ELITE",
            "ComputerName": "DESKTOP-AU0VQEE",
            "ComputerWorkgroup": "WORKGROUP",
            "HDD": [ {
                "Model": "INTEL SSDPEKNW512G8",
                "Size": 488382
            } ],
            "Locale": "0419",
            "LocaleCountry": "Russia",
            "LocaleCurrency": "USD",
            "LocaleFormatDate": "MM-DD-YYYY",
            "LocaleFormatTime": "H:mm:ss",
            "LocaleOemPage": "437",
            "LocaleTimezone": -420,
            "LogicalDisks": [ {
                "Disk": "C:",
                "FileSystem": "NTFS",
                "FreeSpace": 13668,
                "Name": "",
                "Size": 487757
            } ],
            "Monitors": [ {
                "Name": "Universal PnP monitor",
                "ScreenHeight": 1080,
                "ScreenWidth": 1920
            } ],
            "NetAdapters": [ {
                "Addresses": "",
                "Cable": true,
                "DCHP": "",
                "DNS": "",
                "MACAddress": "18:C0:4D:44:F0:61",
                "Manufacturer": "Realtek",
                "Name": "Realtek Gaming GbE Family Controller",
                "Speed": 953,
                "WoL": true
            } ],
            "OSName": "Microsoft Windows 10 Pro",
            "OSVersion": "10.0.19044",
            "RAMBanks": [ {
                "Bank": "P0 CHANNEL A",
                "Capacity": 8192,
                "DataWidth": 64,
                "Locator": "DIMM 0",
                "Manufacturer": "Unknown",
                "PartNumber": "F4-3200C16-8GSXFB",
                "SerialNumber": "00000000"
            } ],
            "RAMPageFile": 51264,
            "RAMPhys": 32716,
            "RAMPhysAvail": 9380,
            "RAMVirt": 134217727,
            "RAMVirtAvail": 134213282,
            "SoundDevices": [ {
                "Name": "NVIDIA High Definition Audio"
            } ],
            "VideoCards": [ {
                "Integrated": true,
                "Name": "NVIDIA GeForce GT 710",
                "RAM": 1024
            } ],
            "VideoName": "NVIDIA GeForce GT 710",
            "VideoRAM": 1024
        },
        "sessions": {
            "last": {
                "id":148505,
                "start_time":1600343858,
                "stop_time":1600343900,
                "client":{
                    "ip":"188.162.195.82",
                    "country":"Russian Federation",
                    "region":"Tatarstan",
                    "city":"Kazan",
                    "user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36"
                }
            },
            "total": 1
        }
    }
}
Название Тип Описание
id number Внутрисистемный идентификатор
device_id number Публичный идентификатор агента
name string Название
group string Группа
disabled boolean
Агент заблокирован?

⚠ К заблокированным агентам подключится нельзя. Блокировка наступает в случае превышения лимита по количеству компьютеров в тарифного плана.
limited boolean
Агент лимитирован?

ℹ Агент становится лимитированным в случае превышения лимита тарифного плана по количестсву прикрепленных файлов. Через 10 дней после добавления лимитированный агент становится заблокированным.
link_time unixtime Дата и время добавления в личный кабинет
last_time unixtime Дата и время последнего состояния «В сети»
geo object Гео-расположение
geo.ip string IP адрес
geo.country string Страна
geo.region string Регион
geo.city string Город
permanent_url string
Постоянный URL-адрес для подключения

ℹ Поле может отсутствовать, если доступ для неавторизованных техников закрыт
onetime_url string
URL-адрес для одноразового подключения

⚠ Ссылка меняется каждые 45 секунд

ℹ Поле может отсутствовать, если подключения по одноразовым ссылкам запрещены в настройках агента
preview_url string URL-адрес для загрузки превью рабочего стола
os string Операционная система. Возможные значения: win, mac, linux и android
os_user string Пользователь ОС
rdp bool Поддержка RDP
hibernate bool Режим сна
power_supply bool Питание
version string Версия агента
online boolean Текущее состояние «В сети»
installed boolean Агент установлен на компьютере?
favorite boolean Это избранный компьютер в списке в личном кабинете?
owner string Учетная запись владельца доступа к компьютеру внутри системы
hardware object Информация о системе
hardware.BIOS string Информация о BIOS
hardware.BIOSDate string Дата обновления
hardware.BIOSVersion string Версия
hardware.CPU string Процессор
hardware.CPUCores number Количество ядер
hardware.CPUCoresLogical number Количество логических процессоров
hardware.CPUFamily string Семейство
hardware.CPUSpeed number Скорость
hardware.ComputerDomain string Домен
hardware.ComputerIP array IP-адрес
hardware.ComputerModel string Модель
hardware.ComputerName string Имя компьютера
hardware.ComputerWorkgroup string Рабочая группа
hardware.HDD array Жесткие диски
hardware.HDD[].Model string Модель
hardware.HDD[].Size number Размер
hardware.Locale string Локаль
hardware.LocaleCountry string Страна
hardware.LocaleCurrency string Валюта
hardware.LocaleFormatDate string Формат даты
hardware.LocaleFormatTime string Формат времени
hardware.LocaleOemPage string Кодировка страниц
hardware.LocaleTimezone number Таймзона
hardware.LogicalDisks array Логические диски
hardware.LogicalDisks[].Disk string Метка
hardware.LogicalDisks[].FileSystem string Тип файловой системы
hardware.LogicalDisks[].FreeSpace number Свободное место (МБ)
hardware.LogicalDisks[].Name string Название
hardware.LogicalDisks[].Size number Размер (МБ)
hardware.Monitors array Мониторы
hardware.Monitors[].Name string Название
hardware.Monitors[].ScreenHeight number Высота экрана
hardware.Monitors[].ScreenWidth number Ширина экрана
hardware.NetAdapters array Сетевые карты
hardware.NetAdapters[].Addresses string Адрес
hardware.NetAdapters[].Cable boolean Подключение в интернет по LAN-кабелю
hardware.NetAdapters[].DCHP string DCHP
hardware.NetAdapters[].DNS string DNS
hardware.NetAdapters[].MACAddress string MAC-адрес
hardware.NetAdapters[].Manufacturer string Производитель
hardware.NetAdapters[].Name string Название
hardware.NetAdapters[].Speed number Скорость
hardware.NetAdapters[].WoL boolean Включена настройка Wake-on-LAN
hardware.OSName string Название операционной системы
hardware.OSVersion string Версия операционной системы
hardware.RAMBanks array Память ОЗУ
hardware.RAMBanks[].Bank string Слот
hardware.RAMBanks[].Capacity number Емкость
hardware.RAMBanks[].Locator string Локатор
hardware.RAMBanks[].Manufacturer string Производитель
hardware.RAMBanks[].PartNumber string Партия
hardware.RAMBanks[].SerialNumber string Серия
hardware.RAMPageFile number Размер файла подкачки
hardware.RAMPhys number Общий объём физической оперативной памяти
hardware.RAMPhysAvail number Значение объёма свободной физической оперативной памяти
hardware.RAMVirt number Общий объём виртуальной памяти
hardware.RAMVirtAvail number Объём доступной виртуальной памяти
hardware.SoundDevices array Звуковые карты
hardware.SoundDevices[].Name string Название
hardware.VideoCards array Видео-карта
hardware.VideoCards[].Integrated boolean Интегрированная
hardware.VideoCards[].Name string Название
hardware.VideoCards[].RAM number Память
sessions object Информация о подключениях
sessions.last object Последнее подключение
sessions.last.id number Внутри-системный идентификатор подключения
sessions.last.start_time unixtime Дата и время начала подключения
sessions.last.stop_time unixtime Дата и время конца подключения

ℹ Поле может отсутствовать, если подключение активно
sessions.last.client object Информация о клиенте (автор подключения)
sessions.last.client.ip string IP-адрес
sessions.last.client.country string Страна
sessions.last.client.region string Регион
sessions.last.client.city string Город
sessions.last.client.user_agent string Пользовательский агент браузера клиента
sessions.total object Общее количество подключений

Изменить свойство устройства

Чтобы изменить какое-либо свойство устройства, привязанного к вашей учетной записи, вы можете использовать метод agents/update.

Необязательные поля

Вам не обязательно указывать все свойства в запросе. Будут изменены только те, которые вы зададите. Список полей, доступных для обновления, см. ниже в параметрах.

Запрос:
POST /v1/agents/update
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>,
  "permanent_url": {
    "enable": <boolean>,
    "url": <string>,
    "password": <string>
  }
}

curl -X POST "https://api.pro32connect.ru/v1/agents/update" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>,
    "permanent_url": {
      "enable": <boolean>,
      "url": "<string>",
      "password": "<string>"
    }
  }'
Параметр Тип Значение
id number Внутрисистемный идентификатор агента
name string Имя устройства
permanent_url object Постоянная ссылка для подключения
permanent_url.enable boolean Включить/выключить
permanent_url.url string Путь ссылки
permanent_url.password string Пароль для подключения (не меньше 8 символов, обязательно буквы и цифры)
Ответ:
Пример ответа
Данные ответа
{
    "status": 0,
    "data": {
        "id": 1001,
        "name": "Allesandro Paci",
        "group": "Accounting",
        "disabled": false,
        "limited": false,
        "link_time": 1587837997,
        "last_time": 1600374761,
        "geo": {
            "ip": "94.242.23.99",
            "country": "Russia",
            "region": "St.-Petersburg",
            "city": "St Petersburg"
        },
        "permanent_url": "https://https://go.pro32connect.ru/paci",
        "onetime_url": "https://https://go.pro32connect.ru/am2-l2g",
        "preview_url": "https://pro32connect.ru/preview/1245273f5448a704379da46f476564a592efb17c6a7695adde96247cd7874416GbBzRm6SRLMqrP0YoYFMxCopL6NTzvn8.png",
        "os": "win",
        "version": "2.7.6",
        "online": true,
        "installed": true,
        "favorite": false,
        "owner": "john.smith@gmail.com",
        "hardware": {
            "BIOS": "ALASKA - 1072009 - F51 - American Megatrends - 5000E",
            "BIOSDate": "",
            "BIOSVersion": "20191218",
            "CPU": "AMD Ryzen 5 2600X Six-Core Processor",
            "CPUCores": 6,
            "CPUCoresLogical": 12,
            "CPUFamily": "AMD64 Family 23 Model 8 Stepping 2",
            "CPUSpeed": 3600,
            "ComputerDomain": "WORKGROUP",
            "ComputerIP": [
                "10.66.65.3",
                "fe80::35da:bb0:c661:fff9"
            ],
            "ComputerModel": "B450 AORUS ELITE",
            "ComputerName": "DESKTOP-AU0VQEE",
            "ComputerWorkgroup": "WORKGROUP",
            "HDD": [ {
                "Model": "INTEL SSDPEKNW512G8",
                "Size": 488382
            } ],
            "Locale": "0419",
            "LocaleCountry": "Russia",
            "LocaleCurrency": "USD",
            "LocaleFormatDate": "MM-DD-YYYY",
            "LocaleFormatTime": "H:mm:ss",
            "LocaleOemPage": "437",
            "LocaleTimezone": -420,
            "LogicalDisks": [ {
                "Disk": "C:",
                "FileSystem": "NTFS",
                "FreeSpace": 13668,
                "Name": "",
                "Size": 487757
            } ],
            "Monitors": [ {
                "Name": "Universal PnP monitor",
                "ScreenHeight": 1080,
                "ScreenWidth": 1920
            } ],
            "NetAdapters": [ {
                "Addresses": "",
                "Cable": true,
                "DCHP": "",
                "DNS": "",
                "MACAddress": "18:C0:4D:44:F0:61",
                "Manufacturer": "Realtek",
                "Name": "Realtek Gaming GbE Family Controller",
                "Speed": 953,
                "WoL": true
            } ],
            "OSName": "Microsoft Windows 10 Pro",
            "OSVersion": "10.0.19044",
            "RAMBanks": [ {
                "Bank": "P0 CHANNEL A",
                "Capacity": 8192,
                "DataWidth": 64,
                "Locator": "DIMM 0",
                "Manufacturer": "Unknown",
                "PartNumber": "F4-3200C16-8GSXFB",
                "SerialNumber": "00000000"
            } ],
            "RAMPageFile": 51264,
            "RAMPhys": 32716,
            "RAMPhysAvail": 9380,
            "RAMVirt": 134217727,
            "RAMVirtAvail": 134213282,
            "SoundDevices": [ {
                "Name": "NVIDIA High Definition Audio"
            } ],
            "VideoCards": [ {
                "Integrated": true,
                "Name": "NVIDIA GeForce GT 710",
                "RAM": 1024
            } ],
            "VideoName": "NVIDIA GeForce GT 710",
            "VideoRAM": 1024
        },
        "sessions": {
            "last": {
                "id":148505,
                "start_time":1600343858,
                "stop_time":1600343900,
                "client":{
                    "ip":"188.162.195.82",
                    "country":"Russian Federation",
                    "region":"Tatarstan",
                    "city":"Kazan",
                    "user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36"
                }
            },
            "total": 1
        }
    }
}
Название Тип Описание
number status Статус результата. Возможные значения:
  • 0 - Данные успешно сохранены
  • 1 - Некорректный запрос
  • 7 - Путь для постоянной ссылки занят
  • 8 - Изменение свойств запрещено
  • 21 - Невалидный пароль для постоянной ссылки
data object Те же данные, что и в ответе метода Изменение свойства устройства

Добавление кнопки подключения в панель управления

Узнайте, как интегрировать ссылку для подключения в вашу систему, в руководстве Интеграция удалённого доступа в вашу систему.

Получить ссылку для подключения

Чтобы подключиться к компьютеру через API вам необходимо получить одноразовую ссылку, используя метод agents/connect

Время действия ссылки

Ссылка истекает сразу после первого использования. Вам необходимо получать новую ссылку каждый раз, когда вы хотите подключиться.

Запрос:
POST /v1/agents/connect
  ?agent_id=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -X POST "https://api.pro32connect.ru/v1/agents/connect?agent_id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY"
Параметр Тип Значение
agent_id number Внутрисистемный идентификатор агента
device_id number Публичный идентификатор агента. Доступен в карточке агента в личном кабинете.

ℹ Используется, если параметр agent_id не указан.
video boolean Возможные значение:
  • true - включено автоматическое ведение видео-записи
  • false - выключено автоматическое ведение видео-записи
Ответ:
Пример ответа
Данные ответа
{
    "data":{
        "url": "https://https://go.pro32connect.ru/john.smith/?connect=20177&amp;llt=66b4kj671pm3abpp5xh17elpnpze245382m9pxbrx313l2xp52hmxqe4e1dekpej&amp;s=c2c5ca25eb4fca787b74a97648e0856951e2b9c7aa02cbf83ac62c81e21a9bab"
    }
}
Название Тип Описание
url string URL-адрес для подключения

Добавление кнопки подключения в панель управления

Узнайте, как интегрировать ссылку для подключения в вашу систему, в руководстве Интеграция удалённого доступа в вашу систему.

Перезагрузить устройство

Чтобы отправить запрос на перезагрузку устройства, необходимо использовать метод /agents/reboot.

Запрос:
POST /v1/agents/reboot
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>
  "safe": <boolean>
}

curl -X POST "https://api.pro32connect.ru/v1/agents/reboot" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>,
    "safe": <boolean>
  }'
Параметр Тип Значение
id number Внутрисистемный идентификатор агента
safe boolean Возможные значения:
  • true - перезагрузка в безопасном режиме
  • false - перезагрузка в обычном режиме
Пример ответа
Данные ответа
{
    "status": 0,
}
Название Тип Описание
number status Статус результата. Возможные значения:
  • 0 - Запрос принят
  • 1 - Недопустимый запрос

Доступность

Проверьте, какие типы агентов поддерживают функцию перезагрузки, в руководстве Функции управления экраном.

Пробудить устройство

Чтобы отправить запрос на пробуждение устройства с использованием функции Wake-on-LAN, вы можете использовать запрос agents/wake.

Подготовка устройства

Для работы этой функции требуется предварительная настройка устройств с поддержкой пробуждения. Подробнее см. в руководстве Как настроить Wake-on-LAN?.

Запрос:
POST /v1/agents/wake
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
"id": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/agents/wake" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>
  }'
Параметр Тип Значение
id number Внутренний системный идентификатор агента
Ответ:
Пример ответа
Данные ответа
{
    "status": 0,
}
Имя Тип Описание
status number Статус результата. Возможные значения:
  • 0 — запрос принят
  • 1 — неверный запрос

Выход устройства из системы

Чтобы отвязать устройство от вашей учетной записи и удалить его из постоянного доступа, используйте метод agents/logout.

Будьте осторожны!

После отвязки устройства вы больше не сможете им управлять.

Запрос:
POST /v1/agents/logout
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/agents/logout" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>
  }'
Параметр Тип Значение
id number Внутрисистемный идентификатор агента
Ответ:
Пример ответа
Данные ответа
{
    "status": 0
}
Название Тип Описание
number status Статус результата. Возможные значения:
  • 0 - Выход устройства выполнен успешно
  • 1 - Некорретный запрос
  • 6 - Устройство не найдено
  • 8 - Операция запрещена

Объединение устройств

Чтобы объединить две дублирующиеся записи одного и того же устройства в постоянном доступе, можно использовать запрос agents/merge.

Что такое дублирующиеся устройства?

В некоторых случаях из-за некорректного развёртывания приложения Агент (например, при использовании системных образов или контейнеризации ОС) в списке постоянного доступа могут появляться несколько записей одного и того же устройства. Чтобы избежать путаницы и неудобств, вы можете объединить такие дубликаты в одно устройство.

Запрос:
POST /v1/agents/merge
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "agent_id": <number>,
  "device_id": <number>,
  "target_agent_id": <number>,
  "target_device_id": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/agents/merge" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "agent_id": <number>,
    "device_id": <number>,
    "target_agent_id": <number>,
    "target_device_id": <number>
  }'
Параметр Тип Значение
agent_id number Внутренний идентификатор агента в системе
device_id number Публичный идентификатор агента. Доступен в карточке агента в личном кабинете
target_agent_id number Внутренний идентификатор агента в системе
target_device_id number Публичный идентификатор агента. Доступен в карточке агента в личном кабинете

Обязательные параметры запроса

  • Для идентификации исходного устройства (того, которое необходимо объединить с целевым) используйте agent_id или device_id.
  • Для идентификации целевого устройства используйте target_agent_id или target_device_id.

Всего запрос должен содержать два параметра:

  1. Один параметр для идентификации исходного устройства
  2. Один параметр для идентификации целевого устройства
Ответ:
Пример ответа
Данные ответа
{
    "status": 0,
}
Название Тип Описание
number status Статус результата. Возможные значения:
  • 0 — Объединение успешно выполнено
  • 2 — Внутренняя ошибка сервера
  • 6 — Одно из устройств не найдено
  • 8 — Нет доступа к одному из устройств

Управление группами

Список групп

Вы можете получить список всех групп аккаунта с помощью метода groups/list.

Группировка устройств

Подробнее об управлении группами устройств см. в руководстве Группировка устройств.

Запрос:
GET /v1/groups/list
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -G "https://api.pro32connect.ru/v1/agents/list" \
  -H "X-Api-Key: YOUR_API_KEY" \
Ответ:
Пример ответа
Данные ответа
{
    "data":[ {
        "id":1001,
        "name":"Los Angeles"
    },{
        "id":1002,
        "name":"Chicago"
    },{
        "id":1003,
        "name":"New York"
    }, ... ]
}
Название Тип Описание
id number Внутренний идентификатор группы
name string Название группы

Добавить устройство в группу

Вы можете добавить устройство в группу с помощью метода groups/agent/insert.

Запрос:
POST /v1/groups/agent/insert
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>,
  "agent_id": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/groups/agent/insert" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>,
    "agent_id": <number>
  }'
Параметр Тип Значение
id number Внутренний идентификатор группы в системе
agent_id number Внутренний идентификатор устройства в системе
Ответ:
Пример ответа
Данные ответа
{
    "status": 0
}
Название Тип Описание
status number Статус результата. Возможные значения:
  • 0 — Устройство успешно добавлено в группу
  • 2 — Внутренняя ошибка сервера
  • 6 — Группа или устройство не найдены
  • 8 — Недостаточно прав

Удалить устройство из группы

Вы можете удалить устройство из группы с помощью метода groups/agent/remove.

Запрос:
POST /v1/groups/agent/remove
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "agent_id": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/groups/agent/remove" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "agent_id": <number>
  }'
Параметр Тип Значение
agent_id number Внутренний идентификатор устройства в системе
Ответ:
Пример ответа
Данные ответа
{
    "status": 0
}
Название Тип Описание
status number Статус результата. Возможные значения:
  • 0 — Устройство успешно удалено из группы
  • 2 — Внутренняя ошибка сервера
  • 6 — Устройство не найдено
  • 8 — Недостаточно прав

Создать группу

Вы можете создать новую группу с помощью метода groups/create.

Запрос:
POST /v1/groups/create
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "name": <string>,
  "order": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/groups/create" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "name": <string>,
    "order": <number>
  }'
Параметр Тип Значение
name string Имя создаваемой группы
order number Позиция создаваемой группы в списке
Ответ:
Пример ответа
Данные ответа
{
    "status": 0
}
Название Тип Описание
status number Статус результата. Возможные значения:
  • 0 — Группа успешно создана
  • 2 — Внутренняя ошибка сервера
  • 8 — Недостаточно прав

Отредактировать группу

Вы можете изменить свойства группы с помощью метода groups/edit.

Запрос:
POST /v1/groups/edit
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>,
  "name": <string>,
  "order": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/groups/edit" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>,
    "name": <string>,
    "order": <number>
  }'
Параметр Тип Значение
id number Внутренний идентификатор группы
name string Новое имя группы
order number Новая позиция группы в списке
Ответ:
Пример ответа
Данные ответа
{
    "status": 0
}
Название Тип Описание
status number Статус результата. Возможные значения:
  • 0 — Группа успешно обновлена
  • 2 — Внутренняя ошибка сервера
  • 6 — Группа не найдена
  • 8 — Недостаточно прав

Удалить группу

Вы можете удалить группу с помощью метода groups/remove.

Запрос:
POST /v1/groups/remove
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "id": <number>
}

curl -X POST "https://api.pro32connect.ru/v1/groups/remove" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "id": <number>
  }'
Параметр Тип Значение
id number Внутренний идентификатор группы
Ответ:
Пример ответа
Данные ответа
{
    "status": 0
}
Название Тип Описание
status number Статус результата. Возможные значения:
  • 0 — Группа успешно удалена
  • 2 — Внутренняя ошибка сервера
  • 6 — Группа не найдена
  • 8 — Недостаточно прав

Инвентаризация программного обеспечения

Список установленного ПО

Вы можете получить список установленных приложений на устройствах из раздела Постоянный доступ с помощью метода inventory/program/list.

Настройки команды

Список приложений собирается только при включённой опции Разрешить получение списка программ с устройств в настройках команды. Подробнее см. в отдельном руководстве: Настройки команды

Запрос:
GET /v1/inventory/program/list
  ?agent_id=<number>
  &group_id=<number>
  &type=<string>
  &date_from=<number>
  &date_to=<number>
  &version_from=<string>
  &version_to=<string>
  &name=<string>
  &publisher=<string>
  &search=<string>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -G "https://api.pro32connect.ru/v1/inventory/program/list" \
  --data-urlencode "agent_id=<number>" \
  --data-urlencode "group_id=<number>" \
  --data-urlencode "type=<string>" \
  --data-urlencode "date_from=<number>" \
  --data-urlencode "date_to=<number>" \
  --data-urlencode "version_from=<string>" \
  --data-urlencode "version_to=<string>" \
  --data-urlencode "name=<string>" \
  --data-urlencode "publisher=<string>" \
  --data-urlencode "search=<string>" \
  -H "X-Api-Key: YOUR_API_KEY" \
Параметр Тип Значение
agent_id number Фильтр по устройству. Внутренний идентификатор устройства в системе
group_id number Фильтр по группе. Внутренний идентификатор группы в системе
type string Фильтр по типу установленного приложения. Возможные значения:
  • msi — приложение, установленное через Windows Installer (.msi)
  • registry — приложение, обнаруженное только через запись в реестре Windows
  • dpkg — пакет, установленный через систему пакетов Debian (.deb)
  • rpm — пакет, установленный через менеджер пакетов RPM (.rpm)
date_from number Фильтр по дате установки приложения. Начало периода. Значение в формате unixtime
date_to number Фильтр по дате установки приложения. Конец периода. Значение в формате unixtime
version_from string Фильтр по версии приложения. Минимальная версия. Формат Semantic Versioning (SemVer)
version_to string Фильтр по версии приложения. Максимальная версия. Формат Semantic Versioning (SemVer)
name string Фильтр по названию приложения. Используется точное совпадение
publisher string Фильтр по издателю приложения. Используется точное совпадение
search string Поиск по названию и издателю приложения. Используется регистронезависимый поиск по подстроке
Ответ:
Пример ответа
Данные ответа
{
    "filter": {
        "type": "msi"
    },
    "data":[ {
        "agent_ids": [1001, 1002],
        "name": "WireGuard",
        "publisher": "WireGuard LLC",
        "version": "0.5.3"
    },{
        "agent_ids": [1003],
        "name": "Node.js",
        "publisher": "Node.js Foundation",
        "version": "8.11.4"
    }, ... ]
}
Название Тип Описание
data object Список установленных приложений
data.[].name string Название приложения
data.[].publisher string Издатель приложения
data.[].version string Минимальная версия приложения среди найденных устройств
data.[].agent_ids array Список внутренних идентификаторов устройств, на которых установлено приложение
filter object Применённый фильтр. Дублирует параметры запроса
filter.group_id number Внутренний идентификатор группы
filter.type string Тип установленного приложения
filter.date_from number Начало диапазона даты установки
filter.date_to number Конец диапазона даты установки
filter.version_from string Минимальная версия приложения
filter.version_to string Максимальная версия приложения
filter.name string Название приложения
filter.publisher string Издатель приложения
filter.search string Поиск по названию и издателю приложения