Skip to content
Start here

Apps

List Apps
client.magicTransit.apps.list(AppListParams { account_id } params, RequestOptionsoptions?): SinglePage<AppListResponse>
GET/accounts/{account_id}/magic/apps
Create a new App
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
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
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
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.

hostnames?: Array<string>

FQDNs to associate with traffic decisions.

ip_subnets?: Array<string>

IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported)

name?: string

Display name for the app.

source_subnets?: Array<string>

IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported)

type?: string

Category of the app.

MagicManagedApp { managed_app_id, hostnames, ip_subnets, 3 more }

Managed app defined by Cloudflare.

managed_app_id: string

Managed app ID.

hostnames?: Array<string>

FQDNs to associate with traffic decisions.

ip_subnets?: Array<string>

IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported)

name?: string

Display name for the app.

source_subnets?: Array<string>

IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported)

type?: string

Category of the app.

AppCreateResponse { account_app_id, hostnames, ip_subnets, 3 more }

Custom app defined for an account.

account_app_id: string

Magic account app ID.

hostnames?: Array<string>

FQDNs to associate with traffic decisions.

ip_subnets?: Array<string>

IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported)

name?: string

Display name for the app.

source_subnets?: Array<string>

IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported)

type?: string

Category of the app.

AppUpdateResponse { account_app_id, hostnames, ip_subnets, 3 more }

Custom app defined for an account.

account_app_id: string

Magic account app ID.

hostnames?: Array<string>

FQDNs to associate with traffic decisions.

ip_subnets?: Array<string>

IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported)

name?: string

Display name for the app.

source_subnets?: Array<string>

IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported)

type?: string

Category of the app.

AppEditResponse { account_app_id, hostnames, ip_subnets, 3 more }

Custom app defined for an account.

account_app_id: string

Magic account app ID.

hostnames?: Array<string>

FQDNs to associate with traffic decisions.

ip_subnets?: Array<string>

IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported)

name?: string

Display name for the app.

source_subnets?: Array<string>

IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported)

type?: string

Category of the app.

AppDeleteResponse { account_app_id, hostnames, ip_subnets, 3 more }

Custom app defined for an account.

account_app_id: string

Magic account app ID.

hostnames?: Array<string>

FQDNs to associate with traffic decisions.

ip_subnets?: Array<string>

IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported)

name?: string

Display name for the app.

source_subnets?: Array<string>

IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently unsupported)

type?: string

Category of the app.