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

Share VPN API 1.5.0

Состояние и настройка общего VPN-доступа.

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.5.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела​

МетодПуть
GET/share_vpn
GET/share_vpn/status
POST/share_vpn

GET /share_vpn​

Раздел: Share VPN.

Возвращает идентификатор сеанса сетевой связи для авторизации в кластере.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/share_vpn" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/share_vpn" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/share_vpn"
  }
}

GET /share_vpn/status​

Раздел: Share VPN.

Возвращает текущий статус vpn соединения.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/share_vpn/status" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/share_vpn/status" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "ready",
  "active": true
}

POST /share_vpn​

Раздел: Share VPN.

Добавляет контроллер в кластер.

Пример запроса​

curl -k -X POST "https://{IP_контроллера}/api/v1/share_vpn" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "enabled": true,
  "comment": "temporary support access"
}'

Пример тела запроса​

{
  "enabled": true,
  "comment": "temporary support access"
}

Пример получения ответа​

curl -k -sS -X POST "https://{IP_контроллера}/api/v1/share_vpn" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}