## List interconnects

`client.MagicTransit.CfInterconnects.List(ctx, params) (*CfInterconnectListResponse, error)`

**get** `/accounts/{account_id}/magic/cf_interconnects`

Lists interconnects associated with an account.

### Parameters

- `params CfInterconnectListParams`

  - `AccountID param.Field[string]`

    Path param: Identifier

  - `XMagicNewHcTarget param.Field[bool]`

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

### Returns

- `type CfInterconnectListResponse struct{…}`

  - `Interconnects []CfInterconnectListResponseInterconnect`

    - `ID string`

      Identifier

    - `AutomaticReturnRouting bool`

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

    - `ColoName string`

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

    - `CreatedOn Time`

      The date and time the tunnel was created.

    - `Description string`

      An optional description of the interconnect.

    - `GRE CfInterconnectListResponseInterconnectsGRE`

      The configuration specific to GRE interconnects.

      - `CloudflareEndpoint string`

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

    - `HealthCheck HealthCheck`

      - `Enabled bool`

        Determines whether to run healthchecks for a tunnel.

      - `Rate HealthCheckRate`

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

        - `const HealthCheckRateLow HealthCheckRate = "low"`

        - `const HealthCheckRateMid HealthCheckRate = "mid"`

        - `const HealthCheckRateHigh HealthCheckRate = "high"`

      - `Target HealthCheckTargetUnion`

        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.

        - `type HealthCheckTargetMagicHealthCheckTarget 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 string`

            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 string`

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

        - `UnionString`

      - `Type HealthCheckType`

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

        - `const HealthCheckTypeReply HealthCheckType = "reply"`

        - `const HealthCheckTypeRequest HealthCheckType = "request"`

    - `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.

    - `InterfaceAddress6 string`

      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 Time`

      The date and time the tunnel was last modified.

    - `Mtu int64`

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

    - `Name string`

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

    - `VirtualPortReservationID string`

      An identifier that correlates this interconnect with the corresponding V2 CNI interconnect resource.

### Example

```go
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"),
  )
  cfInterconnects, err := client.MagicTransit.CfInterconnects.List(context.TODO(), magic_transit.CfInterconnectListParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", cfInterconnects.Interconnects)
}
```

#### Response

```json
{
  "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": {
    "interconnects": [
      {
        "id": "c4a7362d577a6c3019a474fd6f485821",
        "automatic_return_routing": true,
        "colo_name": "pni_ord",
        "created_on": "2017-06-14T00:00:00Z",
        "description": "Tunnel for Interconnect to ORD",
        "gre": {
          "cloudflare_endpoint": "203.0.113.1"
        },
        "health_check": {
          "enabled": true,
          "rate": "low",
          "target": {
            "effective": "203.0.113.1",
            "saved": "203.0.113.1"
          },
          "type": "request"
        },
        "interface_address": "192.0.2.0/31",
        "interface_address6": "2606:54c1:7:0:a9fe:12d2:1:200/127",
        "modified_on": "2017-06-14T05:20:00Z",
        "mtu": 0,
        "name": "pni_ord",
        "virtual_port_reservation_id": "c4a7362d577a6c3019a474fd6f485821"
      }
    ]
  },
  "success": true
}
```