Skip to content
Cloudflare API
Start here
API Reference
Magic Transit
IPSEC Tunnels

Update multiple IPsec tunnels

client.MagicTransit.IPSECTunnels.BulkUpdate(ctx, params) (*IPSECTunnelBulkUpdateResponse, error)
PUT/accounts/{account_id}/magic/ipsec_tunnels

Update multiple IPsec tunnels associated with an account. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Magic WAN WriteMagic Transit Write
ParametersExpand Collapse
params IPSECTunnelBulkUpdateParams
AccountID param.Field[string]

Path param: Identifier

maxLength32
Body param.Field[unknown]

Body param

XMagicNewHcTarget param.Field[bool]optional

Header param: If true, the health check target in the request and response bodies will be presented using the new object format. Defaults to false.

ReturnsExpand Collapse
type IPSECTunnelBulkUpdateResponse struct{…}
Modified booloptional
ModifiedIPSECTunnels []IPSECTunnelBulkUpdateResponseModifiedIPSECTunneloptional
ID string

Identifier

maxLength32
CloudflareEndpoint string

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

InterfaceAddress string

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.

Name string

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

AllowNullCipher booloptional

When true, the tunnel can use a null-cipher (ENCR_NULL) in the ESP tunnel (Phase 2).

AutomaticReturnRouting booloptional

True if automatic stateful return routing should be enabled for a tunnel, false otherwise.

BGP IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsBGPoptional
CustomerASN int64

ASN used on the customer end of the BGP session

formatint32
minimum0
ExtraPrefixes []stringoptional

Prefixes in this list will be advertised to the customer device, in addition to the routes in the Magic routing table.

Md5Key stringoptional

MD5 key to use for session authentication.

Note that this is not a security measure. MD5 is not a valid security mechanism, and the key is not treated as a secret value. This is only supported for preventing misconfiguration, not for defending against malicious attacks.

The MD5 key, if set, must be of non-zero length and consist only of the following types of character:

  • ASCII alphanumerics: [a-zA-Z0-9]
  • Special characters in the set '!@#$%^&*()+[]{}<>/.,;:_-~= |`

In other words, MD5 keys may contain any printable ASCII character aside from newline (0x0A), quotation mark ("), vertical tab (0x0B), carriage return (0x0D), tab (0x09), form feed (0x0C), and the question mark (?). Requests specifying an MD5 key with one or more of these disallowed characters will be rejected.

BGPStatus IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsBGPStatusoptional
State IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsBGPStatusState
One of the following:
const IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsBGPStatusStateBGPDown IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsBGPStatusState = "BGP_DOWN"
const IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsBGPStatusStateBGPUp IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsBGPStatusState = "BGP_UP"
const IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsBGPStatusStateBGPEstablishing IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsBGPStatusState = "BGP_ESTABLISHING"
TCPEstablished bool
UpdatedAt Time
formatdate-time
BGPState stringoptional
CfSpeakerIP stringoptional
formatipv4
CfSpeakerPort int64optional
maximum65535
minimum1
CustomerSpeakerIP stringoptional
formatipv4
CustomerSpeakerPort int64optional
maximum65535
minimum1
CreatedOn Timeoptional

The date and time the tunnel was created.

formatdate-time
CustomRemoteIdentities IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsCustomRemoteIdentitiesoptional
FqdnID stringoptional

A custom IKE ID of type FQDN that may be used to identity the IPsec tunnel. The generated IKE IDs can still be used even if this custom value is specified.

Must be of the form <custom label>.<account ID>.custom.ipsec.cloudflare.com.

This custom ID does not need to be unique. Two IPsec tunnels may have the same custom fqdn_id. However, if another IPsec tunnel has the same value then the two tunnels cannot have the same cloudflare_endpoint.

CustomerEndpoint stringoptional

The IP address assigned to the customer side of the IPsec tunnel. Not required, but must be set for proactive traceroutes to work.

Description stringoptional

An optional description forthe IPsec tunnel.

HealthCheck IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckoptional
Direction IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirectionoptional

The direction of the flow of the healthcheck. Either unidirectional, where the probe comes to you via the tunnel and the result comes back to Cloudflare via the open Internet, or bidirectional where both the probe and result come and go via the tunnel.

One of the following:
const IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirectionUnidirectional IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection = "unidirectional"
const IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirectionBidirectional IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection = "bidirectional"
Enabled booloptional

Determines whether to run healthchecks for a tunnel.

Rate HealthCheckRateoptional

How frequent the health check is run. The default value is mid.

One of the following:
const HealthCheckRateLow HealthCheckRate = "low"
const HealthCheckRateMid HealthCheckRate = "mid"
const HealthCheckRateHigh HealthCheckRate = "high"
Target IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetUnionoptional

The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to customer_gre_endpoint address. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target. Must be in object form if the x-magic-new-hc-target header is set to true and string form if x-magic-new-hc-target is absent or set to false.

One of the following:
type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget struct{…}

The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to customer_gre_endpoint address. This field is ignored for bidirectional healthchecks as the interface_address (not assigned to the Cloudflare side of the tunnel) is used as the target.

Effective stringoptional

The effective health check target. If 'saved' is empty, then this field will be populated with the calculated default value on GET requests. Ignored in POST, PUT, and PATCH requests.

Saved stringoptional

The saved health check target. Setting the value to the empty string indicates that the calculated default value will be used.

UnionString
Type HealthCheckTypeoptional

The type of healthcheck to run, reply or request. The default value is reply.

One of the following:
const HealthCheckTypeReply HealthCheckType = "reply"
const HealthCheckTypeRequest HealthCheckType = "request"
InterfaceAddress6 stringoptional

A 127 bit IPV6 prefix from within the virtual_subnet6 prefix space with the address being the first IP of the subnet and not same as the address of virtual_subnet6. Eg if virtual_subnet6 is 2606:54c1:7:0:a9fe:12d2::/127 , interface_address6 could be 2606:54c1:7:0:a9fe:12d2:1:200/127

ModifiedOn Timeoptional

The date and time the tunnel was last modified.

formatdate-time
PSKMetadata PSKMetadataoptional

The PSK metadata that includes when the PSK was generated.

LastGeneratedOn Timeoptional

The date and time the tunnel was last modified.

formatdate-time
ReplayProtection booloptional

If true, then IPsec replay protection will be supported in the Cloudflare-to-customer direction.

Update multiple IPsec tunnels

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/magic_transit"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.MagicTransit.IPSECTunnels.BulkUpdate(context.TODO(), magic_transit.IPSECTunnelBulkUpdateParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    Body: map[string]interface{}{
    },
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Modified)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "modified": true,
    "modified_ipsec_tunnels": [
      {
        "id": "c4a7362d577a6c3019a474fd6f485821",
        "cloudflare_endpoint": "203.0.113.1",
        "interface_address": "192.0.2.0/31",
        "name": "IPsec_1",
        "allow_null_cipher": true,
        "automatic_return_routing": true,
        "bgp": {
          "customer_asn": 0,
          "extra_prefixes": [
            "string"
          ],
          "md5_key": "md5_key"
        },
        "bgp_status": {
          "state": "BGP_DOWN",
          "tcp_established": true,
          "updated_at": "2019-12-27T18:11:19.117Z",
          "bgp_state": "bgp_state",
          "cf_speaker_ip": "192.168.1.1",
          "cf_speaker_port": 1,
          "customer_speaker_ip": "192.168.1.1",
          "customer_speaker_port": 1
        },
        "created_on": "2017-06-14T00:00:00Z",
        "custom_remote_identities": {
          "fqdn_id": "fqdn_id"
        },
        "customer_endpoint": "203.0.113.1",
        "description": "Tunnel for ISP X",
        "health_check": {
          "direction": "bidirectional",
          "enabled": true,
          "rate": "low",
          "target": {
            "effective": "203.0.113.1",
            "saved": "203.0.113.1"
          },
          "type": "request"
        },
        "interface_address6": "2606:54c1:7:0:a9fe:12d2:1:200/127",
        "modified_on": "2017-06-14T05:20:00Z",
        "psk_metadata": {
          "last_generated_on": "2017-06-14T05:20:00Z"
        },
        "replay_protection": false
      }
    ]
  },
  "success": true
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "modified": true,
    "modified_ipsec_tunnels": [
      {
        "id": "c4a7362d577a6c3019a474fd6f485821",
        "cloudflare_endpoint": "203.0.113.1",
        "interface_address": "192.0.2.0/31",
        "name": "IPsec_1",
        "allow_null_cipher": true,
        "automatic_return_routing": true,
        "bgp": {
          "customer_asn": 0,
          "extra_prefixes": [
            "string"
          ],
          "md5_key": "md5_key"
        },
        "bgp_status": {
          "state": "BGP_DOWN",
          "tcp_established": true,
          "updated_at": "2019-12-27T18:11:19.117Z",
          "bgp_state": "bgp_state",
          "cf_speaker_ip": "192.168.1.1",
          "cf_speaker_port": 1,
          "customer_speaker_ip": "192.168.1.1",
          "customer_speaker_port": 1
        },
        "created_on": "2017-06-14T00:00:00Z",
        "custom_remote_identities": {
          "fqdn_id": "fqdn_id"
        },
        "customer_endpoint": "203.0.113.1",
        "description": "Tunnel for ISP X",
        "health_check": {
          "direction": "bidirectional",
          "enabled": true,
          "rate": "low",
          "target": {
            "effective": "203.0.113.1",
            "saved": "203.0.113.1"
          },
          "type": "request"
        },
        "interface_address6": "2606:54c1:7:0:a9fe:12d2:1:200/127",
        "modified_on": "2017-06-14T05:20:00Z",
        "psk_metadata": {
          "last_generated_on": "2017-06-14T05:20:00Z"
        },
        "replay_protection": false
      }
    ]
  },
  "success": true
}