Skip to main content

Update a Private Network Connection

Update a saved private-network connection. This API requires data source module permissions.

Endpoint: /openapi/v1/tunnel/modify

Method: POST

Except for tunnelId, all fields are optional. Field definitions are the same as in Create a Private Network Connection.

ParameterTypeRequiredDescription
tunnelIdStringYesID of the private-network connection to update.

Request example

{"tunnelId": "<tunnelId>", "name": "renamed-tunnel"}

Response parameters

The response contains success, requestId, and Boolean data.

Success response

{"success": true, "requestId": "<requestId>", "data": true}