Skip to content

Commit 4d18fa6

Browse files
[MCONN] Refined adding apps through API (#21854)
* added explanation * removed incorrect links * added new h2 * corrected names * corrected names * refined text * refined text * refined text * refined text * refined text
1 parent 8cede37 commit 4d18fa6

File tree

3 files changed

+42
-7
lines changed

3 files changed

+42
-7
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { Render } from "~/components";
1212
product="networking-services"
1313
params={{
1414
magicWord: "breakout",
15-
featureName: "Breakout traffic",
15+
featureName: "breakout traffic",
1616
whatHappensApp: "will now go directly to the Internet and bypass Cloudflare's filtering",
1717
jsonType: "breakout"
1818
}} />

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { Render } from "~/components";
1212
product="networking-services"
1313
params={{
1414
magicWord: "prioritized",
15-
featureName: "Prioritized traffic",
15+
featureName: "prioritized traffic",
1616
whatHappensApp: "is now processed first by Connector",
1717
jsonType: "priority"
1818
}} />

src/content/partials/networking-services/mconn/app-aware-policies/breakout-prioritized.mdx

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,42 @@ import { APIRequest, Aside, AnchorHeading, CURL, Markdown, Render, TabItem, Tabs
5454
)
5555
}
5656

57-
## Add an application
57+
## Add an application to your account
5858

59-
You need to configure {props.featureName} for each of your existing sites, as it is a per-site configuration.
59+
Before you can add or remove {props.featureName} applications to your Connector, you need to create an account-level list with the applications that you want to configure. Currently, adding to or modifying this list is only possible via API, through the [`managed_app_id`](/api/resources/magic_transit/subresources/apps/methods/create/) endpoint.
60+
61+
To add applications to your account:
62+
63+
Send a `POST` request to add new apps to your account.
64+
65+
<APIRequest
66+
path="/accounts/{account_id}/magic/apps"
67+
method="POST"
68+
json={{
69+
"managed_app_id": "<APP_ID>",
70+
"name": "<APP_NAME>",
71+
"type": "<APP_TYPE>",
72+
}}
73+
/>
74+
75+
```json output
76+
{
77+
"result": {
78+
"account_app_id": "eb09v665c0784618a3e4ba9809258fd4",
79+
"name": "<APP_NAME>",
80+
"type": "<APP_TYPE>",
81+
},
82+
"success": true,
83+
"errors": [],
84+
"messages": []
85+
}
86+
```
87+
88+
You can now add this new app to the {props.featureName} list in your Connector.
89+
90+
### Add an application to Connector
91+
92+
You need to configure {props.featureName} applications for each of your existing sites, as this is a per-site configuration.
6093

6194
<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
6295

@@ -99,7 +132,7 @@ The traffic for the application you chose {props.whatHappensApp}.
99132

100133
Take note of the `"managed_app_id"` value for any application you want to add.
101134

102-
2. Send a [`POST` request](/api/resources/magic_transit/subresources/apps/methods/create/) to add new apps to the breakout traffic policy.
135+
2. Send a `POST` request to add new apps to the {props.featureName} policy.
103136

104137
<APIRequest
105138
path="/accounts/{account_id}/magic/sites/{site_id}/app_configs"
@@ -125,7 +158,7 @@ The traffic for the application you chose {props.whatHappensApp}.
125158

126159
</TabItem> </Tabs>
127160

128-
## Delete an application
161+
### Delete an application from Connector
129162

130163
<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
131164

@@ -141,6 +174,8 @@ The traffic for the application you chose {props.whatHappensApp}.
141174

142175
<Render file="account-id-api-key" product="networking-services" />
143176

177+
You need to delete {props.featureName} applications for each of your existing sites, as this is a per-site configuration.
178+
144179
1. Send a [`GET` request](/api/resources/magic_transit/subresources/apps/methods/list/) to list the applications associated with a site.
145180

146181
<APIRequest
@@ -163,7 +198,7 @@ The traffic for the application you chose {props.whatHappensApp}.
163198

164199
Take note of the `"id"` value for the application that want to delete.
165200

166-
2. Send a [`DELETE` request](/api/resources/magic_transit/subresources/apps/methods/delete/) to delete an application from the breakout traffic policy.
201+
2. Send a `DELETE` request to delete an application from the {props.featureName} policy.
167202

168203
<CURL
169204
url="https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/sites/{site_id}/app_configs/{id}"

0 commit comments

Comments
 (0)