Skip to content

Commit 121206e

Browse files
marciocloudflarehyperlint-ai[bot]
authored and
RebeccaTamachiro
committed
[MWAN] APIRequest + partial (#20720)
* added apirequest * deleted old api * updated response example * added post request * deteled unecessary step * deleted old example * added new response example * removed extra space * added delete apirequest * deleted old example * added response example * update var name * added delete apirequest * deleted old api * added response example * deleted 1st old step * added new apirequest * changed name example * added example * added list apirequest * deleted old api example * added new response example * corrected var name * added new examples deleted old * added test * removed test * created partial added content * added content * corrected problems for breakout * added render file prioritized * changed note to h2 * moved the aside to breaktout only * moved warp title to breakout * removed markdown import * removed old partials * removed extra var * removed extra var * readded step 1 list apps * added jsontype * refined commands * deleted message * deleted list * deleted example * Update src/content/partials/magic-wan/connector/app-aware-policies/breakout-prioritized.mdx Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> * indented line * added json output * added props.jsontype * added json type * changed type * idented json * added output --------- Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
1 parent b7c82ce commit 121206e

File tree

5 files changed

+208
-354
lines changed

5 files changed

+208
-354
lines changed

‎src/content/docs/magic-wan/configuration/connector/network-options/application-based-policies/breakout-traffic.mdx‎

Lines changed: 8 additions & 176 deletions
Original file line numberDiff line numberDiff line change
@@ -6,179 +6,11 @@ description: Breakout traffic allows you to define which applications should
66
bypass Cloudflare's security filtering.
77
---
88

9-
import { Render, TabItem, Tabs } from "~/components";
10-
11-
Breakout traffic allows you to define which applications should bypass Cloudflare's security filtering, and go directly to the Internet. It works via DNS requests inspection. This means that if your network is caching DNS requests, Breakout traffic will only take effect after you cache entries expire and your client issues a new DNS request that the Magic WAN Connector can detect. This can take several minutes.
12-
13-
:::caution
14-
Breakout traffic will not work for applications that use DNS-over-HTTPs.
15-
:::
16-
17-
<br />
18-
19-
```mermaid
20-
flowchart LR
21-
accTitle: In this example, the applications go directly to the Internet, skipping Cloudflare's security. filtering
22-
a(Magic WAN Connector) --> b(Cloudflare) -->|Filtered traffic|c(Internet)
23-
24-
a-- Breakout traffic ---d(Application1) & e(Application2) --> c
25-
26-
classDef orange fill:#f48120,color: black
27-
class a,b orange
28-
```
29-
30-
_In the graph above, Applications 1 and 2 are configured to bypass Cloudflare's security filtering, and go straight to the Internet_
31-
32-
:::note[A note on security]
33-
We recommend [routing](https://www.cloudflare.com/learning/network-layer/what-is-routing/) all traffic through our global network for comprehensive security filtering and access controls. However, there may be specific cases where you want a subset of traffic to bypass Cloudflare's security filtering and route it directly to the Internet. You can scope this breakout traffic to specific applications from the Cloudflare dashboard.
34-
35-
Refer to [Traffic steering](/magic-wan/reference/traffic-steering/) to learn how Cloudflare routes traffic.
36-
:::
37-
38-
## Add an application
39-
40-
You need to configure Breakout traffic for each of your existing sites, as it is a per-site configuration.
41-
42-
<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
43-
44-
<Render
45-
file="connector/app-aware-policies/add-app"
46-
params={{ featureName: "Breakout traffic" }}
47-
/>
48-
6. Select one or more applications that should bypass Cloudflare filtering from the list. You can also use the search box.
49-
7. Select **Add applications**.
50-
51-
The traffic for that application will now go directly to the Internet and bypass Cloudflare's filtering.
52-
53-
</TabItem> <TabItem label="API">
54-
55-
<Render file="connector/account-id-api-key" />
56-
57-
1. Send a [`GET` request](/api/resources/magic_transit/subresources/apps/methods/list/) to list the applications associated with an account.
58-
59-
Example:
60-
61-
```bash
62-
curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/apps \
63-
--header "X-Auth-Email: <EMAIL>" \
64-
--header "X-Auth-Key: <API_KEY>"
65-
```
66-
67-
```json output
68-
{
69-
"result": [
70-
{
71-
"managed_app_id": "<MANAGED_APP_ID>",
72-
"name": "<APP_NAME>",
73-
"type": "<TYPE_OF_APP>",
74-
"hostnames": ["<HOSTNAME1.com>", "<HOSTNAME2.info>"]
75-
}
76-
],
77-
"success": true,
78-
"errors": [],
79-
"messages": []
80-
}
81-
```
82-
83-
Take note of the `"managed_app_id"` value for any application you want to configure.
84-
85-
2. Send a [`POST` request](/api/resources/magic_transit/subresources/apps/methods/create/) to add new apps the breakout traffic policy.
86-
87-
Example:
88-
89-
```bash
90-
curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/sites/{site_id}/app_configs \
91-
--header "X-Auth-Email: <EMAIL>" \
92-
--header "X-Auth-Key: <API_KEY>" \
93-
--header "Content-Type: application/json" \
94-
--data '{
95-
"managed_app_id": "<MANAGED_APP_ID>",
96-
"breakout": true
97-
}'
98-
```
99-
100-
```json output
101-
{
102-
"result": {
103-
"id": "023e105f4ecef8ad9ca31a8372d0c353",
104-
"site_id": "023e105f4ecef8ad9ca31a8372d0c353",
105-
"managed_app_id": "<MANAGED_APP_ID>",
106-
"breakout": true
107-
},
108-
"success": true,
109-
"errors": [],
110-
"messages": []
111-
}
112-
```
113-
114-
</TabItem> </Tabs>
115-
116-
## Delete an application
117-
118-
<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
119-
120-
<Render
121-
file="connector/app-aware-policies/delete-app"
122-
params={{ featureName: "Breakout traffic" }}
123-
/>
124-
125-
</TabItem> <TabItem label="API">
126-
127-
<Render file="connector/account-id-api-key" />
128-
129-
1. Send a [`GET` request](/api/resources/magic_transit/subresources/apps/methods/list/) to list the applications associated with a site.
130-
131-
Example:
132-
133-
```bash
134-
curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/sites/{site_id}/app_configs \
135-
--header "X-Auth-Email: <EMAIL>" \
136-
--header "X-Auth-Key: <API_KEY>"
137-
```
138-
139-
```json output
140-
{
141-
"result": [
142-
{
143-
"id": "023e105f4ecef8ad9ca31a8372d0c353",
144-
"site_id": "023e105f4ecef8ad9ca31a8372d0c353",
145-
"managed_app_id": "<MANAGED_APP_ID>",
146-
"breakout": true
147-
}
148-
],
149-
"success": true,
150-
"errors": [],
151-
"messages": []
152-
}
153-
```
154-
155-
Take note of the `"id"` value for the application that want to delete.
156-
157-
2. Send a [`DELETE` request](/api/resources/magic_transit/subresources/apps/methods/delete/) to delete an application from the breakout traffic policy.
158-
159-
```bash
160-
curl --request DELETE \
161-
https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/sites/{site_id}/app_configs/{id} \
162-
--header "X-Auth-Email: <EMAIL>" \
163-
--header "X-Auth-Key: <API_KEY>"
164-
```
165-
166-
```json output
167-
{
168-
"result": {
169-
"id": "023e105f4ecef8ad9ca31a8372d0c353",
170-
"site_id": "023e105f4ecef8ad9ca31a8372d0c353",
171-
"managed_app_id": "<MANAGED_APP_ID>",
172-
"breakout": true
173-
},
174-
"success": true,
175-
"errors": [],
176-
"messages": []
177-
}
178-
```
179-
180-
</TabItem> </Tabs>
181-
182-
## WARP traffic
183-
184-
<Render file="connector/app-aware-policies/warp-traffic" />
9+
import { Render } from "~/components";
10+
11+
<Render file="connector/app-aware-policies/breakout-prioritized" params={{
12+
magicWord: "breakout",
13+
featureName: "Breakout traffic",
14+
whatHappensApp: "will now go directly to the Internet and bypass Cloudflare's filtering",
15+
jsonType: "breakout"
16+
}} />

‎src/content/docs/magic-wan/configuration/connector/network-options/application-based-policies/prioritized-traffic.mdx‎

Lines changed: 8 additions & 152 deletions
Original file line numberDiff line numberDiff line change
@@ -6,155 +6,11 @@ description: Prioritized traffic allows you to define which applications are
66
processed first by Magic WAN Connector.
77
---
88

9-
import { Render, TabItem, Tabs } from "~/components";
10-
11-
Prioritized traffic allows you to define which applications Magic WAN Connector should process first. Applications not in the list will be queued behind prioritized traffic.
12-
13-
Similarly to breakout traffic, prioritized traffic also works via DNS requests inspection.
14-
15-
:::caution
16-
Prioritized traffic will not work for applications that use DNS-over-HTTPS.
17-
:::
18-
19-
## Add an application
20-
21-
You need to configure Prioritized traffic for each of your existing sites, as it is a per-site configuration.
22-
23-
<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
24-
25-
<Render
26-
file="connector/app-aware-policies/add-app"
27-
params={{ featureName: "Prioritized traffic" }}
28-
/>
29-
30-
6. Select one or more applications that should take precedence over other traffic. You can also use the search box.
31-
7. Select **Add applications**.
32-
33-
The traffic for the applications you chose are now processed first by Connector.
34-
35-
</TabItem> <TabItem label="API">
36-
37-
<Render file="connector/account-id-api-key" />
38-
39-
1. Send a [`GET` request](/api/resources/magic_transit/subresources/apps/methods/list/) to list the applications associated with an account.
40-
41-
Example:
42-
43-
```bash
44-
curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/apps \
45-
--header "X-Auth-Email: <EMAIL>" \
46-
--header "X-Auth-Key: <API_KEY>"
47-
```
48-
49-
```json output
50-
{
51-
"result": [
52-
{
53-
"managed_app_id": "<MANAGED_APP_ID>",
54-
"name": "<APP_NAME>",
55-
"type": "<TYPE_OF_APP>",
56-
"hostnames": ["<HOSTNAME1.com>", "<HOSTNAME2.info>"]
57-
}
58-
],
59-
"success": true,
60-
"errors": [],
61-
"messages": []
62-
}
63-
```
64-
65-
Take note of the `"managed_app_id"` value for any application you want to configure.
66-
67-
2. Send a [`POST` request](/api/resources/magic_transit/subresources/apps/methods/create/) to add new apps the priority traffic policy.
68-
69-
Example:
70-
71-
```bash
72-
curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/sites/{site_id}/app_configs \
73-
--header "X-Auth-Email: <EMAIL>" \
74-
--header "X-Auth-Key: <API_KEY>" \
75-
--header "Content-Type: application/json" \
76-
--data '{
77-
"managed_app_id": "<MANAGED_APP_ID>",
78-
"priority": 1
79-
}'
80-
```
81-
82-
```json output
83-
{
84-
"result": {
85-
"id": "023e105f4ecef8ad9ca31a8372d0c353",
86-
"site_id": "023e105f4ecef8ad9ca31a8372d0c353",
87-
"managed_app_id": "<MANAGED_APP_ID>",
88-
"breakout": true
89-
},
90-
"success": true,
91-
"errors": [],
92-
"messages": []
93-
}
94-
```
95-
96-
</TabItem> </Tabs>
97-
98-
## Delete an application
99-
100-
<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
101-
102-
<Render
103-
file="connector/app-aware-policies/delete-app"
104-
params={{ featureName: "Prioritized traffic" }}
105-
/>
106-
107-
</TabItem> <TabItem label="API">
108-
109-
1. Send a [`GET` request](/api/resources/magic_transit/subresources/apps/methods/list/) to list the applications associated with a site.
110-
111-
Example:
112-
113-
```bash
114-
curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/sites/{site_id}/app_configs \
115-
--header "X-Auth-Email: <EMAIL>" \
116-
--header "X-Auth-Key: <API_KEY>"
117-
```
118-
119-
```json output
120-
{
121-
"result": [
122-
{
123-
"id": "023e105f4ecef8ad9ca31a8372d0c353",
124-
"site_id": "023e105f4ecef8ad9ca31a8372d0c353",
125-
"managed_app_id": "<MANAGED_APP_ID>",
126-
"breakout": true
127-
}
128-
],
129-
"success": true,
130-
"errors": [],
131-
"messages": []
132-
}
133-
```
134-
135-
Take note of the `"id"` value for the application that want to delete.
136-
137-
2. Send a `DELETE` request [using the API](/api/resources/magic_transit/subresources/apps/methods/delete/) to delete an application from the breakout traffic policy.
138-
139-
```bash
140-
curl --request DELETE \
141-
https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/sites/{site_id}/app_configs/{id} \
142-
--header "X-Auth-Email: <EMAIL>" \
143-
--header "X-Auth-Key: <API_KEY>"
144-
```
145-
146-
```json output
147-
{
148-
"result": {
149-
"id": "023e105f4ecef8ad9ca31a8372d0c353",
150-
"site_id": "023e105f4ecef8ad9ca31a8372d0c353",
151-
"managed_app_id": "<MANAGED_APP_ID>",
152-
"breakout": true
153-
},
154-
"success": true,
155-
"errors": [],
156-
"messages": []
157-
}
158-
```
159-
160-
</TabItem> </Tabs>
9+
import { Render } from "~/components";
10+
11+
<Render file="connector/app-aware-policies/breakout-prioritized" params={{
12+
magicWord: "prioritized",
13+
featureName: "Prioritized traffic",
14+
whatHappensApp: "is now processed first by Connector",
15+
jsonType: "priority"
16+
}} />

‎src/content/partials/magic-wan/connector/app-aware-policies/add-app.mdx‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)