Help Center/ Virtual Private Network/ API Reference/ API/ S2C VPN APIs/ VPN Connection/ Deleting a VPN Connection
Updated on 2024-04-03 GMT+08:00
View PDF

Deleting a VPN Connection

Function

This API is used to delete a VPN connection with a specified connection ID.

Calling Method

For details, see Calling APIs.

URI

DELETE /v5/{project_id}/vpn-connection/{vpn_connection_id}

Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

String

Yes

Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID.

vpn_connection_id

String

Yes

Specifies a VPN connection ID.

Request

  • Request parameters

    None

  • Example request 
    DELETE https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id}

Response

  • Response parameters

    Returned status code 204: successful deletion

  • Example response
    Response returned when a frozen VPN connection fails to be deleted 
    DELETE https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id}

{
    "error_code":"VPN.0001",
    "error_msg":"invalid request: ILLEGAL not allowed delete vpnConnection",
    "request_id":"76b771cb-3b2a-151a-5bed-fdf5df12ff82"
}

Status Codes

For details, see Status Codes.

Parent topic: VPN Connection