Список туннелей (с пагинацией)
GET
/tunnelsКонтракт
Параметр | Значение |
|---|---|
| Раздел | tunnels |
| Авторизация | CookieAuth |
| Принимает | не требуется |
| Возвращает | application/json |
Параметры
6 параметров
Имя | Где | Обязательный | Тип | Описание |
|---|---|---|---|---|
input | query | нет | string | Строка поиска |
group_id | query | нет | string | Фильтр по ID группы |
count | query | да | integer | Размер страницы |
page | query | да | integer | Номер страницы, начиная с 1 |
key | query | да | string | Поле сортировки |
order | query | да | enum(asc, desc) | Направление сортировки |
"asc"
Ответы
4 ответов
Статус | Описание | Тип |
|---|---|---|
200 | Успешный ответ | object |
400 | Некорректные параметры запроса | object |
401 | Не авторизован | object |
500 | Внутренняя ошибка сервера | object |
{ "cursor": { "count": 0, "currentPage": 0, "totalPages": 0, "totalRows": 0 }, "data": [ { "ID": 0, "activatedAt": "<string>", "agent": { "caps": [ "<string>" ], "cores": 0, "createdAt": "<string>", "hostname": "<string>", "id": 0, "interfaces": [ { "address": "<string>", "deviceId": "<string>", "driver": "<string>", "name": "<string>", "vendor": "<string>" } ], "ip": "<string>", "online": true, "port": 0, "synced": true, "updatedAt": "<string>" }, "agentId": 0, "createdAt": "<string>", "description": "<string>", "issuer": { "agreementAccepted": true, "createdAt": "<string>", "deletedAt": "<string>", "email": "<string>", "group": { "createdAt": "<string>", "deletedAt": "<string>", "id": 0, "issuer": {}, "issuerID": 0, "name": "<string>", "permissions": [ {} ], "updatedAt": "<string>", "users": [ {} ] }, "groupID": 0, "id": 0, "isActive": true, "isRequiredToSetPassword": true, "lastLogin": "<string>", "notificationsReadAt": "<string>", "passwordLength": 0, "realName": "<string>", "updatedAt": "<string>" }, "issuerID": 0, "layers": [ { "params": { "<key>": {} }, "type": "<string>" } ], "name": "<string>", "serverAgent": { "caps": [ "<string>" ], "cores": 0, "createdAt": "<string>", "hostname": "<string>", "id": 0, "interfaces": [ { "address": "<string>", "deviceId": "<string>", "driver": "<string>", "name": "<string>", "vendor": "<string>" } ], "ip": "<string>", "online": true, "port": 0, "synced": true, "updatedAt": "<string>" }, "serverAgentId": 0, "updatedAt": "<string>" } ] }{ "data": {}, "error": "<string>" }{ "data": {}, "error": "<string>" }{ "data": {}, "error": "<string>" }