From 7090d636eef1f3dd0ecccf85d449f53a28a2af33 Mon Sep 17 00:00:00 2001 From: Patricia Loraine Santa Ana Date: Thu, 29 May 2025 12:07:35 -0700 Subject: [PATCH 1/6] API Gateway update --- src/content/docs/api-shield/api-gateway.mdx | 46 ++++++++++++++++++--- 1 file changed, 41 insertions(+), 5 deletions(-) diff --git a/src/content/docs/api-shield/api-gateway.mdx b/src/content/docs/api-shield/api-gateway.mdx index 3498e62641b371e..9ecfa92acdc2e77 100644 --- a/src/content/docs/api-shield/api-gateway.mdx +++ b/src/content/docs/api-shield/api-gateway.mdx @@ -7,10 +7,46 @@ sidebar: --- -API Gateway is a package of features that will do everything for your APIs, including: +Cloudflare API Shield empowers you to use Cloudflare as your API Gateway, providing robust security features, streamlined management tools, and integration with the Cloudflare Developer Platform for building new APIs.​ -- **Security**: Protect your API from malicious traffic with [API Discovery](/api-shield/security/api-discovery/), [Schema validation](/api-shield/security/schema-validation/), [mTLS validation](/api-shield/security/mtls/), and more. -- **Management and monitoring**: Streamline API management with [Endpoint Management](/api-shield/management-and-monitoring/) and [tools](https://blog.cloudflare.com/api-gateway/) like analytics, routing, and authentication. -- **Logging, quota management, and more**: All of Cloudflare's [established features](https://blog.cloudflare.com/api-gateway/), like caching, load balancing, and log integrations work natively with API Gateway. +APIs are fundamental to modern applications but are increasingly targeted by malicious actors. Cloudflare API Shield offers a comprehensive solution to protect, manage, and build your APIs. -For more details about API Gateway, refer to the [introductory blog post](https://blog.cloudflare.com/api-gateway/). +- **Enhanced security**: Implement robust runtime protection such as JWT validation, mutual TLS (mTLS) authentication, schema validation, and protection against the OWASP Top 10 API Security risks. + +- **Efficient management and monitoring**: Utilize tools for endpoint management, analytics, and routing to streamline API operations. Highlight risks with Posture Management, and gain visibility with Security Analytics and Security Center Insights. + +- **Integrated development**: Leverage the Cloudflare Developer Platform to build and deploy new APIs with ease, taking advantage of scalable infrastructure and a suite of developer tools. + +## Cloudflare as your API Gateway + +### API Security Features + +- **Protection Against OWASP Top 10 API Security Risks**: Mitigate common API vulnerabilities, including injection attacks and improper asset management. + +### Management and Monitoring tools + +- **Endpoint Management**: Gain visibility into your API endpoints, including discovery of shadow APIs and monitoring of active endpoints. + +- **Analytics and Logging**: Access detailed analytics and logs to monitor API usage, performance, and security events. + +- **API Routing**: Optimize API performance and reliability with secure routing. + +- **Posture Management**: Monitor API Authentication status and receive alerts for common API risks. + +## Build APIs with Cloudflare’s Developer Platform + +The Cloudflare Developer Platform offers a serverless execution environment, allowing you to build and deploy new APIs without the need to manage infrastructure. Benefits include: + +- **Global Scalability**: Deploy your APIs across Cloudflare's extensive global network, ensuring low latency and high availability. ​ + +- **Integrated Services**: Access a suite of services, including storage, databases, and AI tools, to enhance your API functionality. ​Connect, protect, and build everywhere + +- **Developer-Friendly Tools**: Utilize modern development tools and frameworks to streamline the API development process. ​ + +## Get started + +To begin using Cloudflare API Shield, refer to our Get started guide. + +For detailed instructions and additional resources, refer to the Cloudflare API Shield documentation and the Cloudflare Developer Platform documentation. + +By integrating API security, management, and development into a single platform, Cloudflare API Shield provides a comprehensive solution to protect, manage, and build APIs. From 1f826af2dee17165538c6b15941021ad9adf0aa8 Mon Sep 17 00:00:00 2001 From: Patricia Loraine Santa Ana Date: Thu, 29 May 2025 13:49:16 -0700 Subject: [PATCH 2/6] ordering and links --- src/content/docs/api-shield/api-gateway.mdx | 20 +++++++++---------- .../management-and-monitoring/index.mdx | 2 +- .../docs/api-shield/reference/index.mdx | 2 +- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/content/docs/api-shield/api-gateway.mdx b/src/content/docs/api-shield/api-gateway.mdx index 9ecfa92acdc2e77..99c8ac202cd2427 100644 --- a/src/content/docs/api-shield/api-gateway.mdx +++ b/src/content/docs/api-shield/api-gateway.mdx @@ -3,7 +3,7 @@ pcx_content_type: concept type: overview title: API Gateway sidebar: - order: 5 + order: 7 --- @@ -11,7 +11,7 @@ Cloudflare API Shield empowers you to use Cloudflare as your API Gateway, provid APIs are fundamental to modern applications but are increasingly targeted by malicious actors. Cloudflare API Shield offers a comprehensive solution to protect, manage, and build your APIs. -- **Enhanced security**: Implement robust runtime protection such as JWT validation, mutual TLS (mTLS) authentication, schema validation, and protection against the OWASP Top 10 API Security risks. +- **Enhanced security**: Implement robust runtime protection such as JWT validation, mutual TLS (mTLS) authentication, schema validation, and protection against the [OWASP Top 10 API Security risks](https://owasp.org/www-project-api-security/). - **Efficient management and monitoring**: Utilize tools for endpoint management, analytics, and routing to streamline API operations. Highlight risks with Posture Management, and gain visibility with Security Analytics and Security Center Insights. @@ -25,28 +25,28 @@ APIs are fundamental to modern applications but are increasingly targeted by mal ### Management and Monitoring tools -- **Endpoint Management**: Gain visibility into your API endpoints, including discovery of shadow APIs and monitoring of active endpoints. +- **[Endpoint Management](/api-shield/management-and-monitoring/endpoint-management/)**: Gain visibility into your API endpoints, including discovery of shadow APIs and monitoring of active endpoints. -- **Analytics and Logging**: Access detailed analytics and logs to monitor API usage, performance, and security events. +- **[Analytics and Logging](/api-shield/security/sequence-analytics/)**: Access detailed analytics and logs to monitor API usage, performance, and security events. -- **API Routing**: Optimize API performance and reliability with secure routing. +- **[API Routing](/api-shield/management-and-monitoring/api-routing/)**: Optimize API performance and reliability with secure routing. -- **Posture Management**: Monitor API Authentication status and receive alerts for common API risks. +- **[Posture Management](/api-shield/security/authentication-posture/)**: Monitor API Authentication status and receive alerts for common API risks. ## Build APIs with Cloudflare’s Developer Platform -The Cloudflare Developer Platform offers a serverless execution environment, allowing you to build and deploy new APIs without the need to manage infrastructure. Benefits include: +The [Cloudflare Developer Platform](https://www.cloudflare.com/developer-platform/) offers a serverless execution environment, allowing you to build and deploy new APIs without the need to manage infrastructure. Benefits include: - **Global Scalability**: Deploy your APIs across Cloudflare's extensive global network, ensuring low latency and high availability. ​ -- **Integrated Services**: Access a suite of services, including storage, databases, and AI tools, to enhance your API functionality. ​Connect, protect, and build everywhere +- **Integrated Services**: Access a suite of services, including storage, databases, and AI tools, to enhance your API functionality. - **Developer-Friendly Tools**: Utilize modern development tools and frameworks to streamline the API development process. ​ ## Get started -To begin using Cloudflare API Shield, refer to our Get started guide. +To begin using Cloudflare API Shield, refer to our [Get started](/api-shield/get-started/) guide. -For detailed instructions and additional resources, refer to the Cloudflare API Shield documentation and the Cloudflare Developer Platform documentation. +For detailed instructions and additional resources, refer to the Cloudflare [API Shield documentation](/api-shield/). By integrating API security, management, and development into a single platform, Cloudflare API Shield provides a comprehensive solution to protect, manage, and build APIs. diff --git a/src/content/docs/api-shield/management-and-monitoring/index.mdx b/src/content/docs/api-shield/management-and-monitoring/index.mdx index 37cfdd03e852e83..52cbfb40244e164 100644 --- a/src/content/docs/api-shield/management-and-monitoring/index.mdx +++ b/src/content/docs/api-shield/management-and-monitoring/index.mdx @@ -2,7 +2,7 @@ pcx_content_type: reference title: Management and Monitoring sidebar: - order: 6 + order: 5 group: hideIndex: true diff --git a/src/content/docs/api-shield/reference/index.mdx b/src/content/docs/api-shield/reference/index.mdx index 440e14d60c687ed..9d018516c283ec0 100644 --- a/src/content/docs/api-shield/reference/index.mdx +++ b/src/content/docs/api-shield/reference/index.mdx @@ -2,7 +2,7 @@ pcx_content_type: reference title: Reference sidebar: - order: 7 + order: 6 group: hideIndex: true From d40e306b586f81e5c160b8b19f86661bbe82f69b Mon Sep 17 00:00:00 2001 From: Patricia Loraine Santa Ana Date: Thu, 29 May 2025 13:51:44 -0700 Subject: [PATCH 3/6] copy --- src/content/docs/api-shield/api-gateway.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/content/docs/api-shield/api-gateway.mdx b/src/content/docs/api-shield/api-gateway.mdx index 99c8ac202cd2427..56f39523764af97 100644 --- a/src/content/docs/api-shield/api-gateway.mdx +++ b/src/content/docs/api-shield/api-gateway.mdx @@ -27,7 +27,7 @@ APIs are fundamental to modern applications but are increasingly targeted by mal - **[Endpoint Management](/api-shield/management-and-monitoring/endpoint-management/)**: Gain visibility into your API endpoints, including discovery of shadow APIs and monitoring of active endpoints. -- **[Analytics and Logging](/api-shield/security/sequence-analytics/)**: Access detailed analytics and logs to monitor API usage, performance, and security events. +- **[Analytics and logging](/api-shield/security/sequence-analytics/)**: Access detailed analytics and logs to monitor API usage, performance, and security events. - **[API Routing](/api-shield/management-and-monitoring/api-routing/)**: Optimize API performance and reliability with secure routing. @@ -35,13 +35,13 @@ APIs are fundamental to modern applications but are increasingly targeted by mal ## Build APIs with Cloudflare’s Developer Platform -The [Cloudflare Developer Platform](https://www.cloudflare.com/developer-platform/) offers a serverless execution environment, allowing you to build and deploy new APIs without the need to manage infrastructure. Benefits include: +The [Cloudflare Developer Platform](https://www.cloudflare.com/developer-platform/) offers a serverless execution environment, allowing you to build and deploy new APIs without the need to manage infrastructure. Its benefits include: -- **Global Scalability**: Deploy your APIs across Cloudflare's extensive global network, ensuring low latency and high availability. ​ +- **Global scalability**: Deploy your APIs across Cloudflare's extensive global network, ensuring low latency and high availability. ​ -- **Integrated Services**: Access a suite of services, including storage, databases, and AI tools, to enhance your API functionality. +- **Integrated services**: Access a suite of services, including storage, databases, and AI tools, to enhance your API functionality. -- **Developer-Friendly Tools**: Utilize modern development tools and frameworks to streamline the API development process. ​ +- **Developer-friendly tools**: Utilize modern development tools and frameworks to streamline the API development process. ​ ## Get started From e3f20631f4a549313dff8939d6596735f7a280c1 Mon Sep 17 00:00:00 2001 From: Patricia Loraine Santa Ana Date: Fri, 30 May 2025 08:15:34 -0700 Subject: [PATCH 4/6] tiny edit --- src/content/docs/api-shield/api-gateway.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/api-shield/api-gateway.mdx b/src/content/docs/api-shield/api-gateway.mdx index 56f39523764af97..b8630126cff331f 100644 --- a/src/content/docs/api-shield/api-gateway.mdx +++ b/src/content/docs/api-shield/api-gateway.mdx @@ -21,7 +21,7 @@ APIs are fundamental to modern applications but are increasingly targeted by mal ### API Security Features -- **Protection Against OWASP Top 10 API Security Risks**: Mitigate common API vulnerabilities, including injection attacks and improper asset management. +- **Protection Against OWASP Top 10 API Security risks**: Mitigate common API vulnerabilities, including injection attacks and improper asset management. ### Management and Monitoring tools From 9622be993b164a0f947e91fa8b667139c29a563f Mon Sep 17 00:00:00 2001 From: Patricia Loraine Santa Ana Date: Fri, 30 May 2025 11:01:02 -0700 Subject: [PATCH 5/6] fix headers --- src/content/docs/api-shield/api-gateway.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/api-shield/api-gateway.mdx b/src/content/docs/api-shield/api-gateway.mdx index b8630126cff331f..43b1551e71e7285 100644 --- a/src/content/docs/api-shield/api-gateway.mdx +++ b/src/content/docs/api-shield/api-gateway.mdx @@ -33,7 +33,7 @@ APIs are fundamental to modern applications but are increasingly targeted by mal - **[Posture Management](/api-shield/security/authentication-posture/)**: Monitor API Authentication status and receive alerts for common API risks. -## Build APIs with Cloudflare’s Developer Platform +### Build APIs with Cloudflare’s Developer Platform The [Cloudflare Developer Platform](https://www.cloudflare.com/developer-platform/) offers a serverless execution environment, allowing you to build and deploy new APIs without the need to manage infrastructure. Its benefits include: From fb7a0ed5969c4416966ef04e826efbb5a71a1cf9 Mon Sep 17 00:00:00 2001 From: Patricia Santa Ana <103445940+patriciasantaana@users.noreply.github.com> Date: Fri, 30 May 2025 12:24:24 -0700 Subject: [PATCH 6/6] Update src/content/docs/api-shield/api-gateway.mdx Co-authored-by: ranbel <101146722+ranbel@users.noreply.github.com> --- src/content/docs/api-shield/api-gateway.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/api-shield/api-gateway.mdx b/src/content/docs/api-shield/api-gateway.mdx index 43b1551e71e7285..22e0b7d9382ee39 100644 --- a/src/content/docs/api-shield/api-gateway.mdx +++ b/src/content/docs/api-shield/api-gateway.mdx @@ -19,7 +19,7 @@ APIs are fundamental to modern applications but are increasingly targeted by mal ## Cloudflare as your API Gateway -### API Security Features +### API security features - **Protection Against OWASP Top 10 API Security risks**: Mitigate common API vulnerabilities, including injection attacks and improper asset management.