diff --git a/public/__redirects b/public/__redirects index 2f72555e57bbe7..07b6353bc3d7d9 100644 --- a/public/__redirects +++ b/public/__redirects @@ -210,6 +210,7 @@ # api-shield /api-shield/security/sequential-abuse-detection/ /api-shield/security/sequence-analytics/ 301 /api-shield/security/bola-attack-detection/ /api-shield/security/bola-vulnerability-detection/ 301 +/api-shield/management-and-monitoring/api-routing/configure/ /api-shield/management-and-monitoring/api-routing/ 301 #autorag /autorag/usage/recipes/ /autorag/how-to/ 301 diff --git a/src/content/docs/api-shield/management-and-monitoring/api-routing/index.mdx b/src/content/docs/api-shield/management-and-monitoring/api-routing.mdx similarity index 100% rename from src/content/docs/api-shield/management-and-monitoring/api-routing/index.mdx rename to src/content/docs/api-shield/management-and-monitoring/api-routing.mdx diff --git a/src/content/docs/api-shield/management-and-monitoring/api-routing/configure.mdx b/src/content/docs/api-shield/management-and-monitoring/api-routing/configure.mdx deleted file mode 100644 index c514ff4120eb46..00000000000000 --- a/src/content/docs/api-shield/management-and-monitoring/api-routing/configure.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -pcx_content_type: how-to -title: Configure -sidebar: - order: 1 - ---- - -import { Render } from "~/components" - -API Shield Routing enables customers to create a unified external-facing API that routes requests to different back-end services that may have different paths and hosts than the existing zone and DNS configuration. - -:::note - -The term **Source Endpoint** refers to the endpoint managed by API Shield in Endpoint Management. The term **Target Endpoint** refers to the ultimate destination the request is sent to by the Routing feature. -::: - -## Process - - - -Once your Source Endpoints are added to Endpoint Management, use the following API calls to create and verify routes on any given operation ID: - -### Create a route - -```bash title="cURL command" -curl --request PUT "https://api.cloudflare.com/client/v4/zones/{zoneID}/api_gateway/operations/{operationID}/route" \ ---header "Content-Type: application/json" \ ---data '{"route": "https://api.example.com/api/service"}' -``` - -```json title="Response" -{ - "result": { - "route": "https://api.example.com/api/service" - }, - "success": true, - "errors": [], - "messages": [] -} -``` - - - -### Verify a Route - -```bash title="cURL command" -curl --request GET "https://api.cloudflare.com/client/v4/zones/{zoneID}/api_gateway/operations/{operationID}/route" \ ---header "Content-Type: application/json" -``` - -```json title="Response" -{ - "result": { - "route": "https://api.example.com/api/service" - }, - "success": true, - "errors": [], - "messages": [] -} -``` - -### Remove a route - -```bash title="cURL command" -curl --request DELETE "https://api.cloudflare.com/client/v4/zones/{zoneID}/api_gateway/operations/{operationID}/route" \ ---header "Content-Type: application/json" -``` - -```json title="Response" -{ - "result":{}, - "success":true, - "errors":[], - "messages":[] -} -``` - -### Test a route - -After sending a request to your Source Endpoint, you should see the contents of the back-end service as if you called the Target Endpoint directly. - -If API Shield returns unexpected results, check your Source Endpoint host, method, and path and [verify the route](/api-shield/management-and-monitoring/api-routing/#verify-a-route) to ensure the Target Endpoint value is correct. - -:::note - -You may need to wait up to five minutes for route changes to synchronize across the Cloudflare network. -::: - -## Limitations - - diff --git a/src/content/docs/api-shield/security/sequence-analytics.mdx b/src/content/docs/api-shield/security/sequence-analytics.mdx index 35a645a2454ae7..9eeba4ff715a44 100644 --- a/src/content/docs/api-shield/security/sequence-analytics.mdx +++ b/src/content/docs/api-shield/security/sequence-analytics.mdx @@ -26,7 +26,7 @@ For example, a portion of a sequence made during a bank funds transfer could loo | 3 | `GET` | `/api/v1/accounts/{account_id}/balance` | `account_id` is a different account belonging to the user. | | 4 | `POST` | `/api/v1/transferFunds` | This contains a request body detailing an account to transfer funds from, an account to transfer funds to, and an amount of money to transfer. | -API Shield uses your configured session identifier to build a set of ordered API operations (HTTP host, method, and path) requested per session. We may surface sequences in various lengths depending how API Shield scores the sequences. +API Shield uses your configured session identifier and your saved endpoints to build a set of ordered API operations (HTTP host, method, and path) requested per session. We may surface sequences in various lengths depending how API Shield scores the sequences. ### Sequence scoring @@ -54,6 +54,6 @@ Sequence Analytics is available for all API Shield customers. Pro, Business, and ## Limitations -Sequence Analytics currently requires a session identifier in order to build and track sequences made by an API consumer. Ensure that you have set up your session identifier(s) in the Cloudflare dashboard by going to **API Shield** > **Settings**. +Sequence Analytics currently requires a session identifier and saved endpoints in order to build and track sequences made by an API consumer. Ensure that you have [set up your session identifier(s)](/api-shield/get-started/#session-identifiers) and [saved your endpoints](/api-shield/management-and-monitoring/endpoint-management/). Sequences are currently limited to nine operations in length. diff --git a/src/content/docs/api-shield/security/sequence-mitigation/custom-rules.mdx b/src/content/docs/api-shield/security/sequence-mitigation/custom-rules.mdx index 83478b4662c8b8..6593cb4c83ddec 100644 --- a/src/content/docs/api-shield/security/sequence-mitigation/custom-rules.mdx +++ b/src/content/docs/api-shield/security/sequence-mitigation/custom-rules.mdx @@ -12,7 +12,7 @@ API Shield sequence custom rules use the configured API Shield