Skip to content
Start here

Apps

List Apps
GET/accounts/{account_id}/magic/apps
Create a new App
POST/accounts/{account_id}/magic/apps
Update an App
PUT/accounts/{account_id}/magic/apps/{account_app_id}
Update an App
PATCH/accounts/{account_id}/magic/apps/{account_app_id}
Delete Account App
DELETE/accounts/{account_id}/magic/apps/{account_app_id}
ModelsExpand Collapse
AppListResponse = object { account_app_id, hostnames, ip_subnets, 3 more } or object { 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 = object { account_app_id, hostnames, ip_subnets, 3 more }

Custom app defined for an account.

account_app_id: string

Magic account app ID.

hostnames: optional array of string

FQDNs to associate with traffic decisions.

ip_subnets: optional array of string

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

name: optional string

Display name for the app.

source_subnets: optional array of string

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

type: optional string

Category of the app.

MagicManagedApp = object { managed_app_id, hostnames, ip_subnets, 3 more }

Managed app defined by Cloudflare.

managed_app_id: string

Managed app ID.

hostnames: optional array of string

FQDNs to associate with traffic decisions.

ip_subnets: optional array of string

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

name: optional string

Display name for the app.

source_subnets: optional array of string

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

type: optional string

Category of the app.

AppCreateResponse = object { account_app_id, hostnames, ip_subnets, 3 more }

Custom app defined for an account.

account_app_id: string

Magic account app ID.

hostnames: optional array of string

FQDNs to associate with traffic decisions.

ip_subnets: optional array of string

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

name: optional string

Display name for the app.

source_subnets: optional array of string

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

type: optional string

Category of the app.

AppUpdateResponse = object { account_app_id, hostnames, ip_subnets, 3 more }

Custom app defined for an account.

account_app_id: string

Magic account app ID.

hostnames: optional array of string

FQDNs to associate with traffic decisions.

ip_subnets: optional array of string

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

name: optional string

Display name for the app.

source_subnets: optional array of string

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

type: optional string

Category of the app.

AppEditResponse = object { account_app_id, hostnames, ip_subnets, 3 more }

Custom app defined for an account.

account_app_id: string

Magic account app ID.

hostnames: optional array of string

FQDNs to associate with traffic decisions.

ip_subnets: optional array of string

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

name: optional string

Display name for the app.

source_subnets: optional array of string

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

type: optional string

Category of the app.

AppDeleteResponse = object { account_app_id, hostnames, ip_subnets, 3 more }

Custom app defined for an account.

account_app_id: string

Magic account app ID.

hostnames: optional array of string

FQDNs to associate with traffic decisions.

ip_subnets: optional array of string

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

name: optional string

Display name for the app.

source_subnets: optional array of string

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

type: optional string

Category of the app.