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
bgp Object No
bgp.import_filter_id String No

ID of the BGP filter profile applied to routes received from the customer.

bgp.md5_key String No

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.

bgp.customer_endpoint String No

Read-only for v1.5; derived from interface_address.

bgp.cloudflare_endpoint String No

Read-only for v1.5; derived from interface_address.

bgp.extra_prefixes[] Array No

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

bgp.as_no Integer No

Deprecated. Use customer_asn.

bgp.customer_asn Integer No

ASN used on the customer end of the BGP session.

bgp.export_filter_id String No

ID of the BGP filter profile applied to routes advertised to the customer.

mtu Integer No

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

Default value: 1476

name String No

The name of the interconnect. The name cannot share a name with other tunnels.

description String No

An optional description of the interconnect.

automatic_return_routing Boolean No

True if automatic stateful return routing should be enabled for a tunnel, false otherwise. Requires the coupler_integration account flag to be enabled; requests setting this to true without that flag will be rejected.

Default value: false

interface_address6 String No

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

interface_address String No

The IPv4 interface address for the interconnect. For MPLS Interconnects, use a /30 or /31 prefix. For GRE Interconnects, a /30 or /31 prefix may be used. Version 1.5 interconnects require a /31 prefix and may also use a prefix from the account's authorized prefixes; otherwise, select the subnet from RFC 1918 or the approved link-local ranges.

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.