Updated on 2024-12-25 GMT+08:00

API Overview

Table 1 lists the APIs provided by the VPN service. For details about API permissions, see Permission Policies and Supported Actions.

Table 1 VPN APIs

API Type

Description

S2C VPN API

VPN Gateway

APIs for creating, querying, updating, and deleting S2C VPN gateways, and querying AZs of S2C VPN gateways.

Customer Gateway

APIs for creating, querying, updating, and deleting customer gateways.

VPN Connection

APIs for creating, querying, updating, and deleting VPN connections.

VPN Connection Monitor

APIs for creating, querying, and deleting VPN connection health checks.

P2C VPN API

VPN Gateway

APIs for querying and modifying P2C VPN gateways, querying AZs of P2C VPN gateways, and querying the P2C VPN connection list.

Server

APIs for creating, querying, modifying, and exporting the client configuration on the server, as well as importing, querying, modifying, and deleting client CA certificates.

User Management

APIs for creating, querying, modifying, and deleting VPN users, as well as changing and resetting user passwords; and APIs for creating/batch creating, querying, modifying, and deleting/batch deleting VPN user groups, adding VPN users to groups, removing VPN users from groups, and querying VPN users in groups.

Access Policy

APIs for creating, querying, modifying, and deleting VPN access policies.

Public Service APIs

VPN Quota

API for querying quotas.

VPN Tag

APIs for querying, adding, and deleting tags.