Skip to content
Start here

App Configuration

List App Configs
GET/accounts/{account_id}/magic/sites/{site_id}/app_configs
Create a new App Config
POST/accounts/{account_id}/magic/sites/{site_id}/app_configs
Update an App Config
PUT/accounts/{account_id}/magic/sites/{site_id}/app_configs/{app_config_id}
Update an App Config
PATCH/accounts/{account_id}/magic/sites/{site_id}/app_configs/{app_config_id}
Delete App Config
DELETE/accounts/{account_id}/magic/sites/{site_id}/app_configs/{app_config_id}
ModelsExpand Collapse
AppConfigurationListResponse = object { account_app_id, id, breakout, 3 more } or object { managed_app_id, id, breakout, 3 more }

Traffic decision configuration for an app.

One of the following:
AccountApp object { account_app_id, id, breakout, 3 more }
account_app_id: string

Magic account app ID.

id: optional string

Identifier

maxLength32
breakout: optional boolean

Whether to breakout traffic to the app’s endpoints directly. Null preserves default behavior.

preferred_wans: optional array of string

WAN interfaces to prefer over default WANs, highest-priority first. Can only be specified for breakout rules (breakout must be true).

priority: optional number

Priority of traffic. 0 is default, anything greater is prioritized. (Currently only 0 and 1 are supported)

maximum1
minimum0
site_id: optional string

Identifier

maxLength32
ManagedApp object { managed_app_id, id, breakout, 3 more }
managed_app_id: string

Managed app ID.

id: optional string

Identifier

maxLength32
breakout: optional boolean

Whether to breakout traffic to the app’s endpoints directly. Null preserves default behavior.

preferred_wans: optional array of string

WAN interfaces to prefer over default WANs, highest-priority first. Can only be specified for breakout rules (breakout must be true).

priority: optional number

Priority of traffic. 0 is default, anything greater is prioritized. (Currently only 0 and 1 are supported)

maximum1
minimum0
site_id: optional string

Identifier

maxLength32
AppConfigurationCreateResponse = object { account_app_id, id, breakout, 3 more } or object { managed_app_id, id, breakout, 3 more }

Traffic decision configuration for an app.

One of the following:
AccountApp object { account_app_id, id, breakout, 3 more }
account_app_id: string

Magic account app ID.

id: optional string

Identifier

maxLength32
breakout: optional boolean

Whether to breakout traffic to the app’s endpoints directly. Null preserves default behavior.

preferred_wans: optional array of string

WAN interfaces to prefer over default WANs, highest-priority first. Can only be specified for breakout rules (breakout must be true).

priority: optional number

Priority of traffic. 0 is default, anything greater is prioritized. (Currently only 0 and 1 are supported)

maximum1
minimum0
site_id: optional string

Identifier

maxLength32
ManagedApp object { managed_app_id, id, breakout, 3 more }
managed_app_id: string

Managed app ID.

id: optional string

Identifier

maxLength32
breakout: optional boolean

Whether to breakout traffic to the app’s endpoints directly. Null preserves default behavior.

preferred_wans: optional array of string

WAN interfaces to prefer over default WANs, highest-priority first. Can only be specified for breakout rules (breakout must be true).

priority: optional number

Priority of traffic. 0 is default, anything greater is prioritized. (Currently only 0 and 1 are supported)

maximum1
minimum0
site_id: optional string

Identifier

maxLength32
AppConfigurationUpdateResponse = object { account_app_id, id, breakout, 3 more } or object { managed_app_id, id, breakout, 3 more }

Traffic decision configuration for an app.

One of the following:
AccountApp object { account_app_id, id, breakout, 3 more }
account_app_id: string

Magic account app ID.

id: optional string

Identifier

maxLength32
breakout: optional boolean

Whether to breakout traffic to the app’s endpoints directly. Null preserves default behavior.

preferred_wans: optional array of string

WAN interfaces to prefer over default WANs, highest-priority first. Can only be specified for breakout rules (breakout must be true).

priority: optional number

Priority of traffic. 0 is default, anything greater is prioritized. (Currently only 0 and 1 are supported)

maximum1
minimum0
site_id: optional string

Identifier

maxLength32
ManagedApp object { managed_app_id, id, breakout, 3 more }
managed_app_id: string

Managed app ID.

id: optional string

Identifier

maxLength32
breakout: optional boolean

Whether to breakout traffic to the app’s endpoints directly. Null preserves default behavior.

preferred_wans: optional array of string

WAN interfaces to prefer over default WANs, highest-priority first. Can only be specified for breakout rules (breakout must be true).

priority: optional number

Priority of traffic. 0 is default, anything greater is prioritized. (Currently only 0 and 1 are supported)

maximum1
minimum0
site_id: optional string

Identifier

maxLength32
AppConfigurationEditResponse = object { account_app_id, id, breakout, 3 more } or object { managed_app_id, id, breakout, 3 more }

Traffic decision configuration for an app.

One of the following:
AccountApp object { account_app_id, id, breakout, 3 more }
account_app_id: string

Magic account app ID.

id: optional string

Identifier

maxLength32
breakout: optional boolean

Whether to breakout traffic to the app’s endpoints directly. Null preserves default behavior.

preferred_wans: optional array of string

WAN interfaces to prefer over default WANs, highest-priority first. Can only be specified for breakout rules (breakout must be true).

priority: optional number

Priority of traffic. 0 is default, anything greater is prioritized. (Currently only 0 and 1 are supported)

maximum1
minimum0
site_id: optional string

Identifier

maxLength32
ManagedApp object { managed_app_id, id, breakout, 3 more }
managed_app_id: string

Managed app ID.

id: optional string

Identifier

maxLength32
breakout: optional boolean

Whether to breakout traffic to the app’s endpoints directly. Null preserves default behavior.

preferred_wans: optional array of string

WAN interfaces to prefer over default WANs, highest-priority first. Can only be specified for breakout rules (breakout must be true).

priority: optional number

Priority of traffic. 0 is default, anything greater is prioritized. (Currently only 0 and 1 are supported)

maximum1
minimum0
site_id: optional string

Identifier

maxLength32
AppConfigurationDeleteResponse = object { account_app_id, id, breakout, 3 more } or object { managed_app_id, id, breakout, 3 more }

Traffic decision configuration for an app.

One of the following:
AccountApp object { account_app_id, id, breakout, 3 more }
account_app_id: string

Magic account app ID.

id: optional string

Identifier

maxLength32
breakout: optional boolean

Whether to breakout traffic to the app’s endpoints directly. Null preserves default behavior.

preferred_wans: optional array of string

WAN interfaces to prefer over default WANs, highest-priority first. Can only be specified for breakout rules (breakout must be true).

priority: optional number

Priority of traffic. 0 is default, anything greater is prioritized. (Currently only 0 and 1 are supported)

maximum1
minimum0
site_id: optional string

Identifier

maxLength32
ManagedApp object { managed_app_id, id, breakout, 3 more }
managed_app_id: string

Managed app ID.

id: optional string

Identifier

maxLength32
breakout: optional boolean

Whether to breakout traffic to the app’s endpoints directly. Null preserves default behavior.

preferred_wans: optional array of string

WAN interfaces to prefer over default WANs, highest-priority first. Can only be specified for breakout rules (breakout must be true).

priority: optional number

Priority of traffic. 0 is default, anything greater is prioritized. (Currently only 0 and 1 are supported)

maximum1
minimum0
site_id: optional string

Identifier

maxLength32