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

HealthCheck {enabled, rate, target, type }

enabled?: boolean Determines whether to run healthchecks for a tunnel. Link to this property rate?: HealthCheckRate How frequent the health check is run. The default value is mid. Link to this property

target?: MagicHealthCheckTarget {effective, saved } | string 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:

MagicHealthCheckTarget {effective, saved } 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. Link to this property saved?: string 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 string Link to this property

Link to this property type?: HealthCheckType 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)>)

HealthCheckRate = "low"| "mid"| "high" How frequent the health check is run. The default value is mid.

One of the following: "low" Link to this property "mid" Link to this property "high" Link to this property

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

HealthCheckType = "reply"| "request" The type of healthcheck to run, reply or request. The default value is reply.

One of the following: "reply" Link to this property "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/typescript/resources/magic_transit/subresources/apps/methods/list) client.magicTransit.apps.list(AppListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [AppListResponse]()> GET/accounts/{account\_id}/magic/apps ##### [Create a new App](https://developers.cloudflare.com/api/typescript/resources/magic_transit/subresources/apps/methods/create) client.magicTransit.apps.create(AppCreateParams {account\_id, name, type, 3 more } params, RequestOptionsoptions?): [AppCreateResponse]() {account\_app\_id, hostnames, ip\_subnets, 3 more } | null POST/accounts/{account\_id}/magic/apps ##### [Update an App](https://developers.cloudflare.com/api/typescript/resources/magic_transit/subresources/apps/methods/update) client.magicTransit.apps.update(stringaccountAppID, AppUpdateParams {account\_id, hostnames, ip\_subnets, 3 more } params, RequestOptionsoptions?): [AppUpdateResponse]() {account\_app\_id, hostnames, ip\_subnets, 3 more } | null PUT/accounts/{account\_id}/magic/apps/{account\_app\_id} ##### [Update an App](https://developers.cloudflare.com/api/typescript/resources/magic_transit/subresources/apps/methods/edit) client.magicTransit.apps.edit(stringaccountAppID, AppEditParams {account\_id, hostnames, ip\_subnets, 3 more } params, RequestOptionsoptions?): [AppEditResponse]() {account\_app\_id, hostnames, ip\_subnets, 3 more } | null PATCH/accounts/{account\_id}/magic/apps/{account\_app\_id} ##### [Delete Account App](https://developers.cloudflare.com/api/typescript/resources/magic_transit/subresources/apps/methods/delete) client.magicTransit.apps.delete(stringaccountAppID, AppDeleteParams {account\_id } params, RequestOptionsoptions?): [AppDeleteResponse]() {account\_app\_id, hostnames, ip\_subnets, 3 more } | null DELETE/accounts/{account\_id}/magic/apps/{account\_app\_id} ##### ModelsExpand Collapse

AppListResponse = MagicAccountApp {account\_app\_id, hostnames, ip\_subnets, 3 more } | MagicManagedApp {managed\_app\_id, hostnames, ip\_subnets, 3 more } Collection of Hostnames and/or IP Subnets to associate with traffic decisions.

One of the following:

MagicAccountApp {account\_app\_id, hostnames, ip\_subnets, 3 more } Custom app defined for an account.

account\_app\_id: string Magic account app ID. Link to this property hostnames?: Array<string> FQDNs to associate with traffic decisions. Link to this property ip\_subnets?: Array<string> IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported) Link to this property name?: string Display name for the app. Link to this property source\_subnets?: Array<string> IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported) Link to this property type?: string Category of the app. Link to this property