Update IPsec Tunnel

PUT

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}

Last modified:2022-12-16 13:48:33

Updates a specific IPsec tunnel associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

Request

Path Params

tunnel_identifier

string

required

account_identifier

string

required

Body Params application/json

cloudflare_endpoint

string

cloudflare_ipsec_endpoint

required

The IP address assigned to the Cloudflare side of the IPsec tunnel.

Example:

203.0.113.1

customer_endpoint

string

customer_ipsec_endpoint

optional

The IP address assigned to the customer side of the IPsec tunnel.

Example:

203.0.113.1

description

string

ipsec-tunnel_components-schemas-description

optional

An optional description forthe IPsec tunnel.

Example:

Tunnel for ISP X

interface_address

string

interface_address

required

A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.

Example:

192.0.2.0/31

name

string

ipsec-tunnel_components-schemas-name

required

The name of the IPsec tunnel. The name cannot share a name with other tunnels.

Example:

IPsec_1

psk

string

psk

optional

A randomly generated or provided string for use in the IPsec tunnel.

Example:

O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy

Example

{
    "cloudflare_endpoint": "203.0.113.1",
    "customer_endpoint": "203.0.113.1",
    "description": "Tunnel for ISP X",
    "interface_address": "192.0.2.0/31",
    "name": "IPsec_1",
    "psk": "O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/accounts//magic/ipsec_tunnels/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cloudflare_endpoint": "203.0.113.1",
    "customer_endpoint": "203.0.113.1",
    "description": "Tunnel for ISP X",
    "interface_address": "192.0.2.0/31",
    "name": "IPsec_1",
    "psk": "O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy"
}'

Responses

🟢200Update IPsec Tunnel response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "modified": true,
        "modified_ipsec_tunnel": {}
    },
    "success": true
}

🟢200Update IPsec Tunnel response failure

Modified at 2022-12-16 13:48:33

List IPsec tunnel details

Generate Pre Shared Key (PSK) for IPsec tunnels