Перейти к основному содержимому

Список туннелей (с пагинацией)

GET
/tunnels

Контракт

Параметр
Значение
Разделtunnels
АвторизацияCookieAuth
Принимаетне требуется
Возвращаетapplication/json

Параметры

6 параметров

Имя
Где
Обязательный
Тип
Описание
inputqueryнетstringСтрока поиска
group_idqueryнетstringФильтр по ID группы
countqueryдаintegerРазмер страницы
pagequeryдаintegerНомер страницы, начиная с 1
keyqueryдаstringПоле сортировки
orderqueryда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>"
    }