Skip to main content

Share VPN API 1.6.0

Shared VPN and cluster connectivity operations.

Base path: https://{controller_ip}/api/v1. API description version: 1.6.0.

Examples use placeholder values for passwords, tokens, UUIDs, addresses and secrets. Replace them with values from your controller before sending requests.

Section methods​

MethodPath
GET/share_vpn
GET/share_vpn/status
POST/share_vpn

GET /share_vpn​

Section: Share VPN.

Returns data for the share VPN endpoint /share_vpn.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/share_vpn" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/share_vpn" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

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

GET /share_vpn/status​

Section: Share VPN.

Returns data for the share VPN endpoint /share_vpn/status.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/share_vpn/status" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/share_vpn/status" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

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

POST /share_vpn​

Section: Share VPN.

Creates a record or starts an operation for the share VPN endpoint /share_vpn.

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/share_vpn" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "enabled": true,
  "comment": "temporary support access"
}'

Request body example​

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

Response command example​

curl -k -sS -X POST "https://{controller_ip}/api/v1/share_vpn" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

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