Skip to content

Commit 79e6e41

Browse files
Adjust formatting and add accepted RIRs list
1 parent b4d0a6b commit 79e6e41

File tree

1 file changed

+36
-19
lines changed

1 file changed

+36
-19
lines changed

src/content/docs/byoip/get-started.mdx

Lines changed: 36 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,44 @@ Once your account configurations are in place, consider the sections below to le
1313

1414
## Before you begin
1515

16-
* Verify that your [Internet Routing Registry (IRR)](/byoip/concepts/irr-entries/) records are up to date and contain:
16+
- Your prefix must be registered under one of the following Regional Internet Registries (RIRs):
1717

18-
* `route` or `route6` objects matching the exact prefixes you want to onboard
19-
* `origin` matching the correct ASN you want to onboard
18+
- ARIN
19+
- RIPE
20+
- APNIC
21+
- AFRINIC
22+
- LACNIC
23+
24+
- Also verify that your [Internet Routing Registry (IRR)](/byoip/concepts/irr-entries/) records are are up to date and contain:
25+
26+
- `route` or `route6` objects matching the exact prefixes you want to onboard
27+
- `origin` matching the correct ASN you want to onboard
2028

2129
:::note
2230
The process described on this page only supports using Cloudflare's ASN (AS13335). If you must announce the prefixes under your own ASN, contact your account team.
2331
:::
2432

25-
* You must use Resource Public Key Infrastructure (RPKI) validation and make sure your ROAs are accurate. You can use [Cloudflare's RPKI Portal](https://rpki.cloudflare.com/?view=validator) and a second source such as [Routinator](https://rpki-validator.ripe.net/ui/) to double-check your prefixes.
33+
- You must use Resource Public Key Infrastructure (RPKI) validation and make sure your ROAs are accurate. You can use [Cloudflare's RPKI Portal](https://rpki.cloudflare.com/?view=validator) and a second source such as [Routinator](https://rpki-validator.ripe.net/ui/) to double-check your prefixes.
2634

27-
* If you are not familiar with how Cloudflare API works, refer to [Fundamentals](/fundamentals/api/). Make sure you have the necessary permissions and that you have your account ID.
35+
- If you are not familiar with how Cloudflare API works, refer to [Fundamentals](/fundamentals/api/). Make sure you have the necessary permissions and that you have your account ID.
2836

2937
## 1. Set up your prefixes
3038

3139
1. Use the [Add Prefix endpoint](/api/resources/addressing/subresources/prefixes/methods/create/) to create a prefix in the Cloudflare account that should own the BYOIP prefix.
3240

33-
(Add codeblock as example)
41+
```bash
42+
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/addressing/prefixes \
43+
-H 'Content-Type: application/json' \
44+
-H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
45+
-H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
46+
-X POST \
47+
-d '{"cidr": "162.159.211.0/24",
48+
"asn": 13335,
49+
"ownership_validation" : { "delegate_loa_creation": true }
50+
}
51+
```
3452
35-
```json title="Response" {11,12}
53+
```json title="Response" {15-19}
3654
3755
"result": {
3856
"id": "72823e95d6c64d48a8111fec81179816",
@@ -48,13 +66,11 @@ Once your account configurations are in place, consider the sections below to le
4866
"advertised_modified_at": null,
4967
"loa_document_id": null,
5068
"asn": 13335,
69+
"ownership_validation_token": "<OWNERSHIP_VALIDATION_TOKEN>",
70+
"delegate_loa_creation" : true,
5171
"irr_validation_state": "pending",
52-
"rpki_validation_state": "pending"
53-
"prefix_ownership_validation": {
54-
"state" : "pending",
55-
"token": "<>",
56-
"delegate_loa_creation" : true
57-
}
72+
"rpki_validation_state": "pending",
73+
"ownership_validation_state": "pending",
5874
}
5975
6076
```
@@ -63,18 +79,18 @@ Once your account configurations are in place, consider the sections below to le
6379
6480
<Tabs> <TabItem label="Modify IRR record">
6581
66-
1. Copy the token returned by the API call.
82+
1. Copy the `ownership_validation_token` returned by the API call.
6783
2. On the IRR record of the prefix you are onboarding, add the following string in either a `description` or `remarks` field. Replace `<TOKEN>` by the actual token you copied in the previous step.
6884
6985
```
7086
cf-validation: <TOKEN>
7187
```
7288
73-
:::note
89+
:::note
7490
75-
The exact steps to update your IRR record will depend on the registry you are using. Refer to [Internet Routing Registry (IRR)](/byoip/concepts/irr-entries/) for details.
91+
The exact steps to update your IRR record will depend on the registry you are using. Refer to [Internet Routing Registry (IRR)](/byoip/concepts/irr-entries/best-practices/) for details.
7692
77-
:::
93+
:::
7894
7995
</TabItem> <TabItem label="Reverse DNS zone and TXT record">
8096
@@ -93,10 +109,11 @@ cf-validation.<REVERSE_ZONE_ADDRESS> IN TXT <TOKEN>
93109
94110
4. Update nameservers at your Regional Internet Registry (RIR).The exact steps to update your nameservers will depend on the registry you are using.
95111
96-
Once the ownership validation is successful, and if the RPKI and IRR validations also pass, the `approved` field in your prefix will return "V". This means you can proceed to create IP address service bindings[^1].
97-
98112
</TabItem> </Tabs>
99113
114+
115+
Once the ownership validation is successful, and if the RPKI and IRR validations also pass, the `approved` field in your prefix will return `"V"`. This means you can proceed to create IP address service bindings[^1].
116+
100117
3. (Optional) Use the [Prefix Details endpoint](/api/resources/addressing/subresources/prefixes/methods/get/) to check if any issues were found during validation. If so, proceed with the necessary changes and make a request to restart validation.
101118
<APIRequest path= "/accounts/{account_id}/addressing/prefixes/{prefix_id}" method="GET" />
102119

0 commit comments

Comments
 (0)