Skip to content

Commit 95197ea

Browse files
Add dedicated page for setup with requirements and API example
1 parent 2ff268c commit 95197ea

File tree

3 files changed

+34
-2
lines changed

3 files changed

+34
-2
lines changed

src/content/docs/aegis/configuration-options/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Configuration options
33
pcx_content_type: navigation
44
sidebar:
5-
order: 2
5+
order: 5
66
group:
77
hideIndex: true
88
---

src/content/docs/aegis/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Leverage dedicated IPs to improve your origin security and implement Zero Trust.
1919

2020
Cloudflare Aegis provides dedicated egress IPs (from Cloudflare to your origin) for your layer 7 [WAF](/waf/) and <GlossaryTooltip term="content delivery network (CDN)">CDN</GlossaryTooltip> services, as well as [Spectrum](/spectrum/). The egress IPs are reserved exclusively for your account so that you can increase your origin security by only allowing traffic from a small list of IP addresses.
2121

22-
Both [BYOIP](/byoip) and Cloudflare-leased IPs are supported by Cloudflare Aegis. Refer to [Setup](TBD) for details.
22+
Both [BYOIP](/byoip) and Cloudflare-leased IPs are supported by Cloudflare Aegis.
2323

2424
***
2525

src/content/docs/aegis/setup.mdx

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Setup
3+
pcx_content_type: how-to
4+
sidebar:
5+
order: 2
6+
group:
7+
hideIndex: true
8+
---
9+
10+
You can control Aegis enablement on your zones via API.
11+
12+
## Requirements
13+
14+
- The Aegis zone setting endpoint is only available within Cloudflare accounts that own leased IPs, or accounts to which a BYOIP prefix has been delegated. If you wish to use Aegis for zones that do not meet this criteria, contact your account team.
15+
- Each Aegis pool can consist of either IPs from a [BYOIP prefix](/byoip/) or Cloudflare-leased IPs. A single dedicated egress pool cannot contain both BYOIPs and leased IPs.
16+
17+
## Steps
18+
19+
1. Contact your account team to get the ID for your dedicated egress pool.
20+
2. Make a `PATCH` request to the [Edit Zone Setting](/api/resources/zones/subresources/settings/methods/edit/) endpoint:
21+
- Specify `aegis` as the setting ID in the URL.
22+
- In the request body, set `enabled` to `true` and use the ID from the previous step as `pool_id`.
23+
24+
```bash
25+
--data '{
26+
"id": "aegis",
27+
"value": {
28+
"enabled": true,
29+
"pool_id": "<YOUR_EGRESS_POOL_ID>"
30+
},
31+
}'
32+
```

0 commit comments

Comments
 (0)