Skip to content

Commit 90b6637

Browse files
committed
update API documentation links
Updates all previous documentation links with the new structure
1 parent 6ed8bac commit 90b6637

File tree

398 files changed

+794
-794
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

398 files changed

+794
-794
lines changed

src/content/docs/ai-gateway/api-reference.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
pcx_content_type: navigation
33
title: REST API reference
4-
external_link: /api/operations/aig-config-list-gateway
4+
external_link: /api/resources/ai_gateway/methods/list/
55
sidebar:
66
order: 8
77

src/content/docs/ai-gateway/configuration/caching.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ To set the default caching configuration using the API:
4141
- `AI Gateway - Edit`
4242

4343
2. Get your [Account ID](/fundamentals/setup/find-account-and-zone-ids/).
44-
3. Using that API token and Account ID, send a [`POST` request](/api/operations/aig-config-create-gateway) to create a new Gateway and include a value for the `cache_ttl`.
44+
3. Using that API token and Account ID, send a [`POST` request](/api/resources/ai_gateway/methods/create/) to create a new Gateway and include a value for the `cache_ttl`.
4545

4646
</TabItem> </Tabs>
4747

src/content/docs/ai-gateway/configuration/rate-limiting.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ To set the default rate limiting configuration using the API:
4343
- `AI Gateway - Edit`
4444

4545
2. Get your [Account ID](/fundamentals/setup/find-account-and-zone-ids/).
46-
3. Using that API token and Account ID, send a [`POST` request](/api/operations/aig-config-create-gateway) to create a new Gateway and include a value for the `rate_limiting_interval`, `rate_limiting_limit`, and `rate_limiting_technique`.
46+
3. Using that API token and Account ID, send a [`POST` request](/api/resources/ai_gateway/methods/create/) to create a new Gateway and include a value for the `rate_limiting_interval`, `rate_limiting_limit`, and `rate_limiting_technique`.
4747

4848
</TabItem> </Tabs>
4949

src/content/docs/ai-gateway/evaluations/add-human-feedback-api.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ If you prefer to add human feedback via the dashboard, refer to [Add Human Feedb
1717
- `AI Gateway - Edit`
1818

1919
2. Get your [Account ID](/fundamentals/setup/find-account-and-zone-ids/).
20-
3. Using that API token and Account ID, send a [`POST` request](/api/operations/aig-config-create-gateway) to the Cloudflare API.
20+
3. Using that API token and Account ID, send a [`POST` request](/api/resources/ai_gateway/methods/create/) to the Cloudflare API.
2121

2222
## 2. Using the API Token
2323

@@ -62,7 +62,7 @@ In the example below, the `cf-aig-log-id` is `01JADMCQQQBWH3NXZ5GCRN98DP`.
6262

6363
### Method 2: Retrieve the `cf-aig-log-id` via API (GET request)
6464

65-
If you don't have the `cf-aig-log-id` in the response body or you need to access it after the fact, you can retrieve it by querying the logs using the [Cloudflare API](/api/operations/aig-config-list-gateway-logs).
65+
If you don't have the `cf-aig-log-id` in the response body or you need to access it after the fact, you can retrieve it by querying the logs using the [Cloudflare API](/api/resources/ai_gateway/subresources/logs/methods/list/).
6666

6767
The steps below outline how to do this.
6868

src/content/docs/api-shield/get-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ You can import the learned schema of an entire hostname using the [Cloudflare da
9191

9292
Learned schemas will always include the listed hostname in the servers section, all endpoints by host, method, and path, and detected path variables. They can also potentially include detected query parameters and their format. You can optionally include API Shield’s rate limit threshold recommendations.
9393

94-
You can export your learned schemas in the [Cloudflare dashboard](/api-shield/management-and-monitoring/#export-a-schema) or via the [API](/api/operations/api-shield-endpoint-management-retrieve-operations-and-features-as-open-api-schemas).
94+
You can export your learned schemas in the [Cloudflare dashboard](/api-shield/management-and-monitoring/#export-a-schema) or via the [API](/api/resources/api_gateway/subresources/schemas/methods/list/).
9595

9696
## View and configure Sequence Analytics
9797

src/content/docs/api-shield/management-and-monitoring/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Customers viewing analytics have the ability to toggle detailed metrics view bet
150150

151151
## Using the Cloudflare API
152152

153-
You can interact with Endpoint Management through the Cloudflare API. Refer to [Endpoint Management’s API documentation](/api/operations/api-shield-api-discovery-retrieve-discovered-operations-on-a-zone) for more information.
153+
You can interact with Endpoint Management through the Cloudflare API. Refer to [Endpoint Management’s API documentation](/api/resources/api_gateway/subresources/discovery/subresources/operations/methods/list/) for more information.
154154

155155
## Sensitive Data Detection
156156

src/content/docs/api-shield/security/jwt-validation/configure.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ If you only need JWT Validation on specific hostnames or subdomains of your apex
170170

171171
If you need to exclude endpoints from JWT validation that never have valid JWTs used with them (by design), such as a path and method used to establish a valid JWT in the first place, you must use the endpoint’s operation ID to exclude the endpoint in a selector.
172172

173-
To find the operation ID, refer to [Endpoint Management](/api-shield/management-and-monitoring/) or use the [Cloudflare API](/api/operations/api-shield-endpoint-management-retrieve-information-about-all-operations-on-a-zone).
173+
To find the operation ID, refer to [Endpoint Management](/api-shield/management-and-monitoring/) or use the [Cloudflare API](/api/resources/api_gateway/subresources/operations/methods/list/).
174174

175175
## Define a security policy
176176

src/content/docs/api-shield/security/jwt-validation/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,4 +69,4 @@ JWT Validation is available for all API Shield customers. Enterprise customers w
6969
Currently, the following known limitations exist:
7070

7171
1. JWT Validation only operates on JWTs sent in client request headers or cookies. If your clients send in JWTs in a `POST` body, direct that feedback to your account team.
72-
2. JWT Validation only operates for <GlossaryTooltip term="API endpoint">endpoints</GlossaryTooltip> (host, method, and path) added to Endpoint Management. You can add all of your endpoints to endpoint management through [API Discovery](/api-shield/management-and-monitoring/#add-endpoints-from-api-discovery), [Schema Validation](/api-shield/management-and-monitoring/#add-endpoints-from-schema-validation), [manually via the Cloudflare dashboard](/api-shield/management-and-monitoring/#add-endpoints-manually), or via the [API](/api/operations/api-shield-endpoint-management-add-operations-to-a-zone).
72+
2. JWT Validation only operates for <GlossaryTooltip term="API endpoint">endpoints</GlossaryTooltip> (host, method, and path) added to Endpoint Management. You can add all of your endpoints to endpoint management through [API Discovery](/api-shield/management-and-monitoring/#add-endpoints-from-api-discovery), [Schema Validation](/api-shield/management-and-monitoring/#add-endpoints-from-schema-validation), [manually via the Cloudflare dashboard](/api-shield/management-and-monitoring/#add-endpoints-manually), or via the [API](/api/resources/api_gateway/subresources/operations/methods/create/).

src/content/docs/api-shield/security/sequence-mitigation/configure.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Otherwise, the request to endpoint `b704ab4d-5be0-46e0-9875-b2b3d1ab42f9` is blo
4343
| `last_updated` | When this rule was last changed. | A date string | `2023-05-02T12:06:51.796286Z` |
4444
| `created_at` | When this rule was created. | A date string | `2023-05-02T12:06:51.796286Z` |
4545

46-
You can find an endpoint's operation ID by exporting the schema in [Endpoint Management](/api-shield/management-and-monitoring/#export-a-schema) or via the [API](/api/operations/api-shield-endpoint-management-retrieve-information-about-all-operations-on-a-zone).
46+
You can find an endpoint's operation ID by exporting the schema in [Endpoint Management](/api-shield/management-and-monitoring/#export-a-schema) or via the [API](/api/resources/api_gateway/subresources/operations/methods/list/).
4747

4848
### List sequence rules
4949

src/content/docs/api-shield/security/volumetric-abuse-detection.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ To create rate limits:
6767

6868
## API
6969

70-
[Rate limit recommendations are available via the API](/api/operations/api-shield-endpoint-management-retrieve-information-about-an-operation) if you would like to dynamically update rate limits over time.
70+
[Rate limit recommendations are available via the API](/api/resources/api_gateway/subresources/operations/methods/get/) if you would like to dynamically update rate limits over time.
7171

7272
## Limitations
7373

0 commit comments

Comments
 (0)