PUT /accounts/{account_id}/magic/cf_interconnects/{cf_interconnect_id}

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

Servers

Path parameters

Name Type Required Description
cf_interconnect_id String Yes
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

x-magic-new-hc-target Boolean No

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

Request body fields

Name Type Required Description
mtu Integer No

The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576.

Default value: 1476

health_check Object No
health_check.rate String No

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

Possible values:

  • "low"
  • "high"
  • "mid"

Default value: "mid"

health_check.target Object No

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.

health_check.enabled Boolean No

Determines whether to run healthchecks for a tunnel.

Default value: true

health_check.type String No

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

Possible values:

  • "request"
  • "reply"

Default value: "reply"

description String No

An optional description of the interconnect.

gre Object No

The configuration specific to GRE interconnects.

gre.cloudflare_endpoint String No

The IP address assigned to the Cloudflare side of the GRE tunnel created as part of the Interconnect.

interface_address String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.