--- title: Magic Transit --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Magic Transit ##### ModelsExpand Collapse

type HealthCheck struct{…}

Enabled boolOptional Determines whether to run healthchecks for a tunnel. Link to this property Rate HealthCheckRateOptional How frequent the health check is run. The default value is mid. Link to this property

Target HealthCheckTargetUnionOptional 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:

HealthCheckTargetMagicHealthCheckTarget

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. Link to this property Saved stringOptional The saved health check target. Setting the value to the empty string indicates that the calculated default value will be used. Link to this property

Link to this property UnionString Link to this property

Link to this property Type HealthCheckTypeOptional The type of healthcheck to run, reply or request. The default value is reply. Link to this property

[Link to this property](<#(resource)%20magic_transit%20%3E%20(model)%20health_check%20%3E%20(schema)>)

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

One of the following: const HealthCheckRateLow HealthCheckRate = "low" Link to this property const HealthCheckRateMid HealthCheckRate = "mid" Link to this property const HealthCheckRateHigh HealthCheckRate = "high" Link to this property

[Link to this property](<#(resource)%20magic_transit%20%3E%20(model)%20health_check_rate%20%3E%20(schema)>)

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

One of the following: const HealthCheckTypeReply HealthCheckType = "reply" Link to this property const HealthCheckTypeRequest HealthCheckType = "request" Link to this property

[Link to this property](<#(resource)%20magic_transit%20%3E%20(model)%20health_check_type%20%3E%20(schema)>) #### Magic TransitApps ##### [List Apps](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/apps/methods/list) client.MagicTransit.Apps.List(ctx, query) (\*SinglePage\[[AppListResponse]()], error) GET/accounts/{account\_id}/magic/apps ##### [Create a new App](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/apps/methods/create) client.MagicTransit.Apps.New(ctx, params) (\*[AppNewResponse](), error) POST/accounts/{account\_id}/magic/apps ##### [Update an App](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/apps/methods/update) client.MagicTransit.Apps.Update(ctx, accountAppID, params) (\*[AppUpdateResponse](), error) PUT/accounts/{account\_id}/magic/apps/{account\_app\_id} ##### [Update an App](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/apps/methods/edit) client.MagicTransit.Apps.Edit(ctx, accountAppID, params) (\*[AppEditResponse](), error) PATCH/accounts/{account\_id}/magic/apps/{account\_app\_id} ##### [Delete Account App](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/apps/methods/delete) client.MagicTransit.Apps.Delete(ctx, accountAppID, body) (\*[AppDeleteResponse](), error) DELETE/accounts/{account\_id}/magic/apps/{account\_app\_id} #### Magic TransitCf Interconnects ##### [List interconnects](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/cf_interconnects/methods/list) client.MagicTransit.CfInterconnects.List(ctx, params) (\*[CfInterconnectListResponse](), error) GET/accounts/{account\_id}/magic/cf\_interconnects ##### [List interconnect Details](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/cf_interconnects/methods/get) client.MagicTransit.CfInterconnects.Get(ctx, cfInterconnectID, params) (\*[CfInterconnectGetResponse](), error) GET/accounts/{account\_id}/magic/cf\_interconnects/{cf\_interconnect\_id} ##### [Update interconnect](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/cf_interconnects/methods/update) client.MagicTransit.CfInterconnects.Update(ctx, cfInterconnectID, params) (\*[CfInterconnectUpdateResponse](), error) PUT/accounts/{account\_id}/magic/cf\_interconnects/{cf\_interconnect\_id} ##### [Update multiple interconnects](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/cf_interconnects/methods/bulk_update) client.MagicTransit.CfInterconnects.BulkUpdate(ctx, params) (\*[CfInterconnectBulkUpdateResponse](), error) PUT/accounts/{account\_id}/magic/cf\_interconnects #### Magic TransitGRE Tunnels ##### [List GRE tunnels](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/gre_tunnels/methods/list) client.MagicTransit.GRETunnels.List(ctx, params) (\*[GRETunnelListResponse](), error) GET/accounts/{account\_id}/magic/gre\_tunnels ##### [List GRE Tunnel Details](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/gre_tunnels/methods/get) client.MagicTransit.GRETunnels.Get(ctx, greTunnelID, params) (\*[GRETunnelGetResponse](), error) GET/accounts/{account\_id}/magic/gre\_tunnels/{gre\_tunnel\_id} ##### [Create a GRE tunnel](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/gre_tunnels/methods/create) client.MagicTransit.GRETunnels.New(ctx, params) (\*[GRETunnelNewResponse](), error) POST/accounts/{account\_id}/magic/gre\_tunnels ##### [Update GRE Tunnel](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/gre_tunnels/methods/update) client.MagicTransit.GRETunnels.Update(ctx, greTunnelID, params) (\*[GRETunnelUpdateResponse](), error) PUT/accounts/{account\_id}/magic/gre\_tunnels/{gre\_tunnel\_id} ##### [Delete GRE Tunnel](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/gre_tunnels/methods/delete) client.MagicTransit.GRETunnels.Delete(ctx, greTunnelID, params) (\*[GRETunnelDeleteResponse](), error) DELETE/accounts/{account\_id}/magic/gre\_tunnels/{gre\_tunnel\_id} ##### [Update multiple GRE tunnels](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/gre_tunnels/methods/bulk_update) client.MagicTransit.GRETunnels.BulkUpdate(ctx, params) (\*[GRETunnelBulkUpdateResponse](), error) PUT/accounts/{account\_id}/magic/gre\_tunnels #### Magic TransitIPSEC Tunnels ##### [List IPsec tunnels](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/ipsec_tunnels/methods/list) client.MagicTransit.IPSECTunnels.List(ctx, params) (\*[IPSECTunnelListResponse](), error) GET/accounts/{account\_id}/magic/ipsec\_tunnels ##### [List IPsec tunnel details](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/ipsec_tunnels/methods/get) client.MagicTransit.IPSECTunnels.Get(ctx, ipsecTunnelID, params) (\*[IPSECTunnelGetResponse](), error) GET/accounts/{account\_id}/magic/ipsec\_tunnels/{ipsec\_tunnel\_id} ##### [Create an IPsec tunnel](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/ipsec_tunnels/methods/create) client.MagicTransit.IPSECTunnels.New(ctx, params) (\*[IPSECTunnelNewResponse](), error) POST/accounts/{account\_id}/magic/ipsec\_tunnels ##### [Update IPsec Tunnel](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/ipsec_tunnels/methods/update) client.MagicTransit.IPSECTunnels.Update(ctx, ipsecTunnelID, params) (\*[IPSECTunnelUpdateResponse](), error) PUT/accounts/{account\_id}/magic/ipsec\_tunnels/{ipsec\_tunnel\_id} ##### [Delete IPsec Tunnel](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/ipsec_tunnels/methods/delete) client.MagicTransit.IPSECTunnels.Delete(ctx, ipsecTunnelID, params) (\*[IPSECTunnelDeleteResponse](), error) DELETE/accounts/{account\_id}/magic/ipsec\_tunnels/{ipsec\_tunnel\_id} ##### [Update multiple IPsec tunnels](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/ipsec_tunnels/methods/bulk_update) client.MagicTransit.IPSECTunnels.BulkUpdate(ctx, params) (\*[IPSECTunnelBulkUpdateResponse](), error) PUT/accounts/{account\_id}/magic/ipsec\_tunnels ##### [Generate Pre-Shared Key (PSK) for IPsec tunnels](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/ipsec_tunnels/methods/psk_generate) client.MagicTransit.IPSECTunnels.PSKGenerate(ctx, ipsecTunnelID, body) (\*[IPSECTunnelPSKGenerateResponse](), error) POST/accounts/{account\_id}/magic/ipsec\_tunnels/{ipsec\_tunnel\_id}/psk\_generate ##### [Set Pre-Shared Keys (PSK) for IPsec tunnels](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/ipsec_tunnels/methods/psk_set) client.MagicTransit.IPSECTunnels.PSKSet(ctx, params) (\*[IPSECTunnelPSKSetResponse](), error) POST/accounts/{account\_id}/magic/ipsec\_tunnels/psk ##### ModelsExpand Collapse

type PSKMetadata struct{…} The PSK metadata that includes when the PSK was generated.

LastGeneratedOn TimeOptional The date and time the tunnel was last modified. formatdate-time Link to this property

[Link to this property](<#(resource)%20magic_transit.ipsec_tunnels%20%3E%20(model)%20psk_metadata%20%3E%20(schema)>) #### Magic TransitRoutes ##### [List Routes](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/routes/methods/list) client.MagicTransit.Routes.List(ctx, query) (\*[RouteListResponse](), error) GET/accounts/{account\_id}/magic/routes ##### [Route Details](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/routes/methods/get) client.MagicTransit.Routes.Get(ctx, routeID, query) (\*[RouteGetResponse](), error) GET/accounts/{account\_id}/magic/routes/{route\_id} ##### [Create a Route](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/routes/methods/create) client.MagicTransit.Routes.New(ctx, params) (\*[RouteNewResponse](), error) POST/accounts/{account\_id}/magic/routes ##### [Update Route](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/routes/methods/update) client.MagicTransit.Routes.Update(ctx, routeID, params) (\*[RouteUpdateResponse](), error) PUT/accounts/{account\_id}/magic/routes/{route\_id} ##### [Delete Route](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/routes/methods/delete) client.MagicTransit.Routes.Delete(ctx, routeID, body) (\*[RouteDeleteResponse](), error) DELETE/accounts/{account\_id}/magic/routes/{route\_id} ##### [Update Many Routes](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/routes/methods/bulk_update) client.MagicTransit.Routes.BulkUpdate(ctx, params) (\*[RouteBulkUpdateResponse](), error) PUT/accounts/{account\_id}/magic/routes ##### [Delete Many Routes](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/routes/methods/empty) client.MagicTransit.Routes.Empty(ctx, body) (\*[RouteEmptyResponse](), error) DELETE/accounts/{account\_id}/magic/routes ##### ModelsExpand Collapse

type Scope struct{…} Used only for ECMP routes.

ColoNames \[]stringOptional List of colo names for the ECMP scope. Link to this property ColoRegions \[]stringOptional List of colo regions for the ECMP scope. Link to this property

[Link to this property](<#(resource)%20magic_transit.routes%20%3E%20(model)%20scope%20%3E%20(schema)>) #### Magic TransitBGP Filter Profiles ##### [List BGP Filter Profiles](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/bgp_filter_profiles/methods/list) client.MagicTransit.BGPFilterProfiles.List(ctx, query) (\*SinglePage\[[BGPFilterProfileListResponse]()], error) GET/accounts/{account\_id}/magic/bgp/filter\_profiles ##### [Get BGP Filter Profile](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/bgp_filter_profiles/methods/get) client.MagicTransit.BGPFilterProfiles.Get(ctx, profileID, query) (\*[BGPFilterProfileGetResponse](), error) GET/accounts/{account\_id}/magic/bgp/filter\_profiles/{profile\_id} ##### [Create BGP Filter Profile](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/bgp_filter_profiles/methods/create) client.MagicTransit.BGPFilterProfiles.New(ctx, params) (\*[BGPFilterProfileNewResponse](), error) POST/accounts/{account\_id}/magic/bgp/filter\_profiles ##### [Update BGP Filter Profile](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/bgp_filter_profiles/methods/update) client.MagicTransit.BGPFilterProfiles.Update(ctx, profileID, params) (\*[BGPFilterProfileUpdateResponse](), error) PUT/accounts/{account\_id}/magic/bgp/filter\_profiles/{profile\_id} ##### [Delete BGP Filter Profile](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/bgp_filter_profiles/methods/delete) client.MagicTransit.BGPFilterProfiles.Delete(ctx, profileID, body) (\*[BGPFilterProfileDeleteResponse](), error) DELETE/accounts/{account\_id}/magic/bgp/filter\_profiles/{profile\_id} #### Magic TransitSites ##### [List Sites](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/methods/list) client.MagicTransit.Sites.List(ctx, params) (\*SinglePage\[[Site]()], error) GET/accounts/{account\_id}/magic/sites ##### [Site Details](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/methods/get) client.MagicTransit.Sites.Get(ctx, siteID, params) (\*[Site](), error) GET/accounts/{account\_id}/magic/sites/{site\_id} ##### [Create a new Site](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/methods/create) client.MagicTransit.Sites.New(ctx, params) (\*[Site](), error) POST/accounts/{account\_id}/magic/sites ##### [Update Site](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/methods/update) client.MagicTransit.Sites.Update(ctx, siteID, params) (\*[Site](), error) PUT/accounts/{account\_id}/magic/sites/{site\_id} ##### [Patch Site](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/methods/edit) client.MagicTransit.Sites.Edit(ctx, siteID, params) (\*[Site](), error) PATCH/accounts/{account\_id}/magic/sites/{site\_id} ##### [Delete Site](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/methods/delete) client.MagicTransit.Sites.Delete(ctx, siteID, body) (\*[Site](), error) DELETE/accounts/{account\_id}/magic/sites/{site\_id} ##### ModelsExpand Collapse

type Site struct{…}

ID stringOptional Identifier maxLength32 Link to this property ConnectorID stringOptional Magic Connector identifier tag. Link to this property Description stringOptional Link to this property HaMode boolOptional Site high availability mode. If set to true, the site can have two connectors and runs in high availability mode. Link to this property Location SiteLocationOptional Location of site in latitude and longitude. Link to this property Name stringOptional The name of the site. Link to this property SecondaryConnectorID stringOptional Magic Connector identifier tag. Used when high availability mode is on. Link to this property

[Link to this property](<#(resource)%20magic_transit.sites%20%3E%20(model)%20site%20%3E%20(schema)>)

type SiteLocation struct{…} Location of site in latitude and longitude.

Lat stringOptional Latitude Link to this property Lon stringOptional Longitude Link to this property

[Link to this property](<#(resource)%20magic_transit.sites%20%3E%20(model)%20site_location%20%3E%20(schema)>) #### Magic TransitSitesApp Configuration #### Magic TransitSitesACLs ##### [List Site ACLs](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/acls/methods/list) client.MagicTransit.Sites.ACLs.List(ctx, siteID, query) (\*SinglePage\[[ACL]()], error) GET/accounts/{account\_id}/magic/sites/{site\_id}/acls ##### [Site ACL Details](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/acls/methods/get) client.MagicTransit.Sites.ACLs.Get(ctx, siteID, aclID, query) (\*[ACL](), error) GET/accounts/{account\_id}/magic/sites/{site\_id}/acls/{acl\_id} ##### [Create a new Site ACL](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/acls/methods/create) client.MagicTransit.Sites.ACLs.New(ctx, siteID, params) (\*[ACL](), error) POST/accounts/{account\_id}/magic/sites/{site\_id}/acls ##### [Update Site ACL](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/acls/methods/update) client.MagicTransit.Sites.ACLs.Update(ctx, siteID, aclID, params) (\*[ACL](), error) PUT/accounts/{account\_id}/magic/sites/{site\_id}/acls/{acl\_id} ##### [Patch Site ACL](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/acls/methods/edit) client.MagicTransit.Sites.ACLs.Edit(ctx, siteID, aclID, params) (\*[ACL](), error) PATCH/accounts/{account\_id}/magic/sites/{site\_id}/acls/{acl\_id} ##### [Delete Site ACL](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/acls/methods/delete) client.MagicTransit.Sites.ACLs.Delete(ctx, siteID, aclID, body) (\*[ACL](), error) DELETE/accounts/{account\_id}/magic/sites/{site\_id}/acls/{acl\_id} ##### ModelsExpand Collapse

type ACL struct{…} Bidirectional ACL policy for network traffic within a site.

ID stringOptional Identifier maxLength32 Link to this property Description stringOptional Description for the ACL. Link to this property ForwardLocally boolOptional The desired forwarding action for this ACL policy. If set to “false”, the policy will forward traffic to Cloudflare. If set to “true”, the policy will forward traffic locally on the Magic Connector. If not included in request, will default to false. Link to this property LAN1 ACLConfigurationOptional Link to this property LAN2 ACLConfigurationOptional Link to this property Name stringOptional The name of the ACL. Link to this property

Protocols \[]AllowedProtocolOptional

One of the following: const AllowedProtocolTCP AllowedProtocol = "tcp" Link to this property const AllowedProtocolUdp AllowedProtocol = "udp" Link to this property const AllowedProtocolIcmp AllowedProtocol = "icmp" Link to this property

Link to this property Unidirectional boolOptional The desired traffic direction for this ACL policy. If set to “false”, the policy will allow bidirectional traffic. If set to “true”, the policy will only allow traffic in one direction. If not included in request, will default to false. Link to this property

[Link to this property](<#(resource)%20magic_transit.sites.acls%20%3E%20(model)%20acl%20%3E%20(schema)>)

type ACLConfiguration struct{…}

LANID string The identifier for the LAN you want to create an ACL policy with. Link to this property LANName stringOptional The name of the LAN based on the provided lan\_id. Link to this property PortRanges \[]stringOptional Array of port ranges on the provided LAN that will be included in the ACL. If no ports or port rangess are provided, communication on any port on this LAN is allowed. Link to this property Ports \[]int64Optional Array of ports on the provided LAN that will be included in the ACL. If no ports or port ranges are provided, communication on any port on this LAN is allowed. Link to this property Subnets \[]SubnetOptional Array of subnet IPs within the LAN that will be included in the ACL. If no subnets are provided, communication on any subnets on this LAN are allowed. Link to this property

[Link to this property](<#(resource)%20magic_transit.sites.acls%20%3E%20(model)%20acl_configuration%20%3E%20(schema)>)

type AllowedProtocol string Array of allowed communication protocols between configured LANs. If no protocols are provided, all protocols are allowed.

[Link to this property](<#(resource)%20magic_transit.sites.acls%20%3E%20(model)%20allowed_protocol%20%3E%20(schema)>) type Subnet string A valid IPv4 address. [Link to this property](<#(resource)%20magic_transit.sites.acls%20%3E%20(model)%20subnet%20%3E%20(schema)>) #### Magic TransitSitesLANs ##### [List Site LANs](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/lans/methods/list) client.MagicTransit.Sites.LANs.List(ctx, siteID, query) (\*SinglePage\[[LAN]()], error) GET/accounts/{account\_id}/magic/sites/{site\_id}/lans ##### [Site LAN Details](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/lans/methods/get) client.MagicTransit.Sites.LANs.Get(ctx, siteID, lanID, query) (\*[LAN](), error) GET/accounts/{account\_id}/magic/sites/{site\_id}/lans/{lan\_id} ##### [Create a new Site LAN](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/lans/methods/create) client.MagicTransit.Sites.LANs.New(ctx, siteID, params) (\*SinglePage\[[LAN]()], error) POST/accounts/{account\_id}/magic/sites/{site\_id}/lans ##### [Update Site LAN](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/lans/methods/update) client.MagicTransit.Sites.LANs.Update(ctx, siteID, lanID, params) (\*[LAN](), error) PUT/accounts/{account\_id}/magic/sites/{site\_id}/lans/{lan\_id} ##### [Patch Site LAN](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/lans/methods/edit) client.MagicTransit.Sites.LANs.Edit(ctx, siteID, lanID, params) (\*[LAN](), error) PATCH/accounts/{account\_id}/magic/sites/{site\_id}/lans/{lan\_id} ##### [Delete Site LAN](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/lans/methods/delete) client.MagicTransit.Sites.LANs.Delete(ctx, siteID, lanID, body) (\*[LAN](), error) DELETE/accounts/{account\_id}/magic/sites/{site\_id}/lans/{lan\_id} ##### ModelsExpand Collapse

type DHCPRelay struct{…}

ServerAddresses \[]stringOptional List of DHCP server IPs. Link to this property

[Link to this property](<#(resource)%20magic_transit.sites.lans%20%3E%20(model)%20dhcp_relay%20%3E%20(schema)>)

type DHCPServer struct{…}

DHCPOptions \[]DHCPServerDHCPOptionOptional Optional list of custom DHCP options to include in DHCP responses. Only valid when DHCP server is enabled.

Code int64 DHCP option number (1-254). Options 0 and 255 are reserved by RFC 2132. Options 3, 6, and 51 are not allowed because they conflict with connector-managed configuration. maximum254 minimum1 Link to this property

Type DHCPServerDHCPOptionsType The type of the option value. text: a string (max 255 bytes). hex: colon-separated hex bytes (e.g. “01:04:aa:bb:cc”, max 255 bytes). ip: an IPv4 address (e.g. “10.20.30.40”). byte: an unsigned integer 0-255 (1 byte). short: an unsigned integer 0-65535 (2 bytes). integer: an unsigned integer 0-4294967295 (4 bytes).

One of the following: const DHCPServerDHCPOptionsTypeText DHCPServerDHCPOptionsType = "text" Link to this property const DHCPServerDHCPOptionsTypeHex DHCPServerDHCPOptionsType = "hex" Link to this property const DHCPServerDHCPOptionsTypeIP DHCPServerDHCPOptionsType = "ip" Link to this property const DHCPServerDHCPOptionsTypeByte DHCPServerDHCPOptionsType = "byte" Link to this property const DHCPServerDHCPOptionsTypeShort DHCPServerDHCPOptionsType = "short" Link to this property const DHCPServerDHCPOptionsTypeInteger DHCPServerDHCPOptionsType = "integer" Link to this property

Link to this property Value string The option value, interpreted according to the type field. Link to this property

Link to this property DHCPPoolEnd stringOptional A valid IPv4 address. Link to this property DHCPPoolStart stringOptional A valid IPv4 address. Link to this property DeprecatedDNSServer stringOptional A valid IPv4 address. Link to this property DNSServers \[]stringOptional Link to this property Reservations map\[string, string]Optional Mapping of MAC addresses to IP addresses Link to this property

[Link to this property](<#(resource)%20magic_transit.sites.lans%20%3E%20(model)%20dhcp_server%20%3E%20(schema)>)

type LAN struct{…}

ID stringOptional Identifier maxLength32 Link to this property BondID int64Optional Link to this property HaLink boolOptional mark true to use this LAN for HA probing. only works for site with HA turned on. only one LAN can be set as the ha\_link. Link to this property IsBreakout boolOptional mark true to use this LAN for source-based breakout traffic Link to this property IsPrioritized boolOptional mark true to use this LAN for source-based prioritized traffic Link to this property Name stringOptional Link to this property Nat NatOptional Link to this property Physport int64Optional Link to this property

RoutedSubnets \[]RoutedSubnetOptional

NextHop string A valid IPv4 address. Link to this property Prefix string A valid CIDR notation representing an IP range. Link to this property Nat NatOptional Link to this property

Link to this property SiteID stringOptional Identifier maxLength32 Link to this property StaticAddressing LANStaticAddressingOptional If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP). However, if in high availability mode, static\_address is required along with secondary and virtual address. Link to this property VlanTag int64Optional VLAN ID. Use zero for untagged. Link to this property

[Link to this property](<#(resource)%20magic_transit.sites.lans%20%3E%20(model)%20lan%20%3E%20(schema)>)

type LANStaticAddressing struct{…} If the site is not configured in high availability mode, this configuration is optional (if omitted, use DHCP). However, if in high availability mode, static\_address is required along with secondary and virtual address.

Address string A valid CIDR notation representing an IP range. Link to this property DHCPRelay DHCPRelayOptional Link to this property DHCPServer DHCPServerOptional Link to this property SecondaryAddress stringOptional A valid CIDR notation representing an IP range. Link to this property VirtualAddress stringOptional A valid CIDR notation representing an IP range. Link to this property

[Link to this property](<#(resource)%20magic_transit.sites.lans%20%3E%20(model)%20lan_static_addressing%20%3E%20(schema)>)

type Nat struct{…}

StaticPrefix stringOptional A valid CIDR notation representing an IP range. Link to this property

[Link to this property](<#(resource)%20magic_transit.sites.lans%20%3E%20(model)%20nat%20%3E%20(schema)>)

type RoutedSubnet struct{…}

NextHop string A valid IPv4 address. Link to this property Prefix string A valid CIDR notation representing an IP range. Link to this property Nat NatOptional Link to this property

[Link to this property](<#(resource)%20magic_transit.sites.lans%20%3E%20(model)%20routed_subnet%20%3E%20(schema)>) #### Magic TransitSitesWANs ##### [List Site WANs](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/wans/methods/list) client.MagicTransit.Sites.WANs.List(ctx, siteID, query) (\*SinglePage\[[WAN]()], error) GET/accounts/{account\_id}/magic/sites/{site\_id}/wans ##### [Site WAN Details](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/wans/methods/get) client.MagicTransit.Sites.WANs.Get(ctx, siteID, wanID, query) (\*[WAN](), error) GET/accounts/{account\_id}/magic/sites/{site\_id}/wans/{wan\_id} ##### [Create a new Site WAN](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/wans/methods/create) client.MagicTransit.Sites.WANs.New(ctx, siteID, params) (\*SinglePage\[[WAN]()], error) POST/accounts/{account\_id}/magic/sites/{site\_id}/wans ##### [Update Site WAN](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/wans/methods/update) client.MagicTransit.Sites.WANs.Update(ctx, siteID, wanID, params) (\*[WAN](), error) PUT/accounts/{account\_id}/magic/sites/{site\_id}/wans/{wan\_id} ##### [Patch Site WAN](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/wans/methods/edit) client.MagicTransit.Sites.WANs.Edit(ctx, siteID, wanID, params) (\*[WAN](), error) PATCH/accounts/{account\_id}/magic/sites/{site\_id}/wans/{wan\_id} ##### [Delete Site WAN](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/sites/subresources/wans/methods/delete) client.MagicTransit.Sites.WANs.Delete(ctx, siteID, wanID, body) (\*[WAN](), error) DELETE/accounts/{account\_id}/magic/sites/{site\_id}/wans/{wan\_id} ##### ModelsExpand Collapse

type WAN struct{…}

ID stringOptional Identifier maxLength32 Link to this property

HealthCheckRate WANHealthCheckRateOptional Magic WAN health check rate for tunnels created on this link. The default value is mid.

One of the following: const WANHealthCheckRateLow WANHealthCheckRate = "low" Link to this property const WANHealthCheckRateMid WANHealthCheckRate = "mid" Link to this property const WANHealthCheckRateHigh WANHealthCheckRate = "high" Link to this property

Link to this property LoadBalanceInnerFlows boolOptional Link to this property Name stringOptional Link to this property Physport int64Optional Link to this property Priority int64Optional Priority of WAN for traffic loadbalancing. Link to this property SiteID stringOptional Identifier maxLength32 Link to this property StaticAddressing WANStaticAddressingOptional (optional) if omitted, use DHCP. Submit secondary\_address when site is in high availability mode. Link to this property VlanTag int64Optional VLAN ID. Use zero for untagged. Link to this property

[Link to this property](<#(resource)%20magic_transit.sites.wans%20%3E%20(model)%20wan%20%3E%20(schema)>)

type WANStaticAddressing struct{…} (optional) if omitted, use DHCP. Submit secondary\_address when site is in high availability mode.

Address string A valid CIDR notation representing an IP range. Link to this property GatewayAddress string A valid IPv4 address. Link to this property SecondaryAddress stringOptional A valid CIDR notation representing an IP range. Link to this property

[Link to this property](<#(resource)%20magic_transit.sites.wans%20%3E%20(model)%20wan_static_addressing%20%3E%20(schema)>) #### Magic TransitConnectors ##### [List Connectors](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/connectors/methods/list) client.MagicTransit.Connectors.List(ctx, params) (\*SinglePage\[[ConnectorListResponse]()], error) GET/accounts/{account\_id}/magic/connectors ##### [Get Connector](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/connectors/methods/get) client.MagicTransit.Connectors.Get(ctx, connectorID, query) (\*[ConnectorGetResponse](), error) GET/accounts/{account\_id}/magic/connectors/{connector\_id} ##### [Create Connector](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/connectors/methods/create) client.MagicTransit.Connectors.New(ctx, params) (\*[ConnectorNewResponse](), error) POST/accounts/{account\_id}/magic/connectors ##### [Update Connector](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/connectors/methods/update) client.MagicTransit.Connectors.Update(ctx, connectorID, params) (\*[ConnectorUpdateResponse](), error) PUT/accounts/{account\_id}/magic/connectors/{connector\_id} ##### [Edit Connector](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/connectors/methods/edit) client.MagicTransit.Connectors.Edit(ctx, connectorID, params) (\*[ConnectorEditResponse](), error) PATCH/accounts/{account\_id}/magic/connectors/{connector\_id} ##### [Delete Connector](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/connectors/methods/delete) client.MagicTransit.Connectors.Delete(ctx, connectorID, body) (\*[ConnectorDeleteResponse](), error) DELETE/accounts/{account\_id}/magic/connectors/{connector\_id} #### Magic TransitConnectorsInterrupts ##### [List Interrupts](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/connectors/subresources/interrupts/methods/list) client.MagicTransit.Connectors.Interrupts.List(ctx, connectorID, query) (\*SinglePage\[[ConnectorInterruptListResponse]()], error) GET/accounts/{account\_id}/magic/connectors/{connector\_id}/interrupts ##### [Create Interrupt](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/connectors/subresources/interrupts/methods/create) client.MagicTransit.Connectors.Interrupts.New(ctx, connectorID, params) (\*[ConnectorInterruptNewResponse](), error) POST/accounts/{account\_id}/magic/connectors/{connector\_id}/interrupts #### Magic TransitConnectorsEvents ##### [List Events](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/connectors/subresources/events/methods/list) client.MagicTransit.Connectors.Events.List(ctx, connectorID, params) (\*[ConnectorEventListResponse](), error) GET/accounts/{account\_id}/magic/connectors/{connector\_id}/telemetry/events ##### [Get Event](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/connectors/subresources/events/methods/get) client.MagicTransit.Connectors.Events.Get(ctx, connectorID, eventT, eventN, query) (\*[ConnectorEventGetResponse](), error) GET/accounts/{account\_id}/magic/connectors/{connector\_id}/telemetry/events/{event\_t}.{event\_n} #### Magic TransitConnectorsEventsLatest ##### [Get latest Events](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/connectors/subresources/events/subresources/latest/methods/list) client.MagicTransit.Connectors.Events.Latest.List(ctx, connectorID, query) (\*[ConnectorEventLatestListResponse](), error) GET/accounts/{account\_id}/magic/connectors/{connector\_id}/telemetry/events/latest #### Magic TransitConnectorsSnapshots ##### [List Snapshots](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/connectors/subresources/snapshots/methods/list) client.MagicTransit.Connectors.Snapshots.List(ctx, connectorID, params) (\*[ConnectorSnapshotListResponse](), error) GET/accounts/{account\_id}/magic/connectors/{connector\_id}/telemetry/snapshots ##### [Get Snapshot](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/connectors/subresources/snapshots/methods/get) client.MagicTransit.Connectors.Snapshots.Get(ctx, connectorID, snapshotT, query) (\*[ConnectorSnapshotGetResponse](), error) GET/accounts/{account\_id}/magic/connectors/{connector\_id}/telemetry/snapshots/{snapshot\_t} #### Magic TransitConnectorsSnapshotsLatest ##### [Get latest Snapshots](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/connectors/subresources/snapshots/subresources/latest/methods/list) client.MagicTransit.Connectors.Snapshots.Latest.List(ctx, connectorID, query) (\*[ConnectorSnapshotLatestListResponse](), error) GET/accounts/{account\_id}/magic/connectors/{connector\_id}/telemetry/snapshots/latest #### Magic TransitCf1 Sites ##### [List CF1 Sites](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/cf1_sites/methods/list) client.MagicTransit.Cf1Sites.List(ctx, query) (\*SinglePage\[[Cf1Site]()], error) GET/accounts/{account\_id}/magic/cf1\_sites ##### [Get CF1 Site](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/cf1_sites/methods/get) client.MagicTransit.Cf1Sites.Get(ctx, cf1SiteID, query) (\*[Cf1Site](), error) GET/accounts/{account\_id}/magic/cf1\_sites/{cf1\_site\_id} ##### [Create CF1 Sites](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/cf1_sites/methods/create) client.MagicTransit.Cf1Sites.New(ctx, params) (\*SinglePage\[[Cf1Site]()], error) POST/accounts/{account\_id}/magic/cf1\_sites ##### [Update CF1 Site](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/cf1_sites/methods/update) client.MagicTransit.Cf1Sites.Update(ctx, cf1SiteID, params) (\*[Cf1Site](), error) PATCH/accounts/{account\_id}/magic/cf1\_sites/{cf1\_site\_id} ##### [Delete CF1 Site](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/cf1_sites/methods/delete) client.MagicTransit.Cf1Sites.Delete(ctx, cf1SiteID, body) (\*[Cf1Site](), error) DELETE/accounts/{account\_id}/magic/cf1\_sites/{cf1\_site\_id} ##### ModelsExpand Collapse

type Cf1Site struct{…}

Name string A human-provided name describing the CF1 Site that should be unique within the account. Link to this property ID stringOptional Identifier maxLength32 Link to this property CreatedOn TimeOptional formatdate-time Link to this property Description stringOptional A human-provided description of the CF1 Site. Link to this property Location Cf1SiteLocationOptional Link to this property ModifiedOn TimeOptional formatdate-time Link to this property

[Link to this property](<#(resource)%20magic_transit.cf1_sites%20%3E%20(model)%20cf1_site%20%3E%20(schema)>)

type Cf1SiteLocation struct{…}

Lat float64Optional Latitude of the CF1 Site. formatfloat Link to this property Long float64Optional Longitude of the CF1 Site. formatfloat Link to this property Name stringOptional Name of nearest town, city, or village. Link to this property

[Link to this property](<#(resource)%20magic_transit.cf1_sites%20%3E%20(model)%20cf1_site_location%20%3E%20(schema)>) #### Magic TransitCf1 SitesRamps ##### [List CF1 Site Ramps](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/cf1_sites/subresources/ramps/methods/list) client.MagicTransit.Cf1Sites.Ramps.List(ctx, cf1SiteID, query) (\*SinglePage\[[Ramp]()], error) GET/accounts/{account\_id}/magic/cf1\_sites/{cf1\_site\_id}/ramps ##### [Get CF1 Site Ramp](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/cf1_sites/subresources/ramps/methods/get) client.MagicTransit.Cf1Sites.Ramps.Get(ctx, cf1SiteID, rampID, query) (\*[Ramp](), error) GET/accounts/{account\_id}/magic/cf1\_sites/{cf1\_site\_id}/ramps/{ramp\_id} ##### [Create CF1 Site Ramps](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/cf1_sites/subresources/ramps/methods/create) client.MagicTransit.Cf1Sites.Ramps.New(ctx, cf1SiteID, params) (\*SinglePage\[[Ramp]()], error) POST/accounts/{account\_id}/magic/cf1\_sites/{cf1\_site\_id}/ramps ##### [Delete CF1 Site Ramp](https://developers.cloudflare.com/api/go/resources/magic_transit/subresources/cf1_sites/subresources/ramps/methods/delete) client.MagicTransit.Cf1Sites.Ramps.Delete(ctx, cf1SiteID, rampID, body) (\*[Ramp](), error) DELETE/accounts/{account\_id}/magic/cf1\_sites/{cf1\_site\_id}/ramps/{ramp\_id} ##### ModelsExpand Collapse

type Ramp struct{…}

ID string Identifier maxLength32 Link to this property CreatedOn Time formatdate-time Link to this property ModifiedOn Time formatdate-time Link to this property Name string A human-provided name describing the ramp that should be unique within the CF1 Site. Link to this property Type RampType The type of network connection (ramp) linking a CF1 Site to Cloudflare’s network. Link to this property Description stringOptional A human-provided description of the ramp. Link to this property

GRE RampGREOptional