Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/content/docs/api-shield/api-gateway.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
pcx_content_type: concept
title: API Gateway
description: Use Cloudflare as your API gateway for security, management, and routing.
products:
- api-shield
sidebar:
order: 7

Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/api-shield/changelog.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
pcx_content_type: changelog
title: Changelog
description: Track the latest updates and changes to API Shield features.
products:
- api-shield
sidebar:
order: 10
---
Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/api-shield/get-started.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: Get started with API Shield
pcx_content_type: get-started
description: Set up API Shield to identify and address API security best practices.
products:
- api-shield
sidebar:
order: 2
label: Get started
Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/api-shield/glossary.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: Glossary
pcx_content_type: glossary
description: Definitions for terms used across API Shield documentation.
products:
- api-shield
sidebar:
order: 9

Expand Down
4 changes: 3 additions & 1 deletion src/content/docs/api-shield/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Cloudflare API Shield
pcx_content_type: overview

description: Identify and address API vulnerabilities with discovery, schema validation, and abuse detection.
products:
- api-shield
sidebar:
order: 1
head:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
pcx_content_type: how-to

description: Route API requests to different back-end services using API Shield Routing.
products:
- api-shield
title: API Routing
sidebar:
order: 4
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
pcx_content_type: how-to

description: Create interactive API documentation portals from saved endpoints or schemas.
products:
- api-shield
title: Build developer portals
sidebar:
order: 5
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
pcx_content_type: how-to

description: Organize API endpoints and address vulnerabilities with managed and custom labels.
products:
- api-shield
title: Endpoint labeling service
sidebar:
order: 2
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
pcx_content_type: concept

description: Save, organize, and monitor API endpoints in API Shield.
products:
- api-shield
title: Endpoint Management
sidebar:
order: 1
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
pcx_content_type: concept

description: Automatically learn API schema parameters from traffic and export in OpenAPI format.
products:
- api-shield
title: Schema learning
sidebar:
order: 2
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
pcx_content_type: reference
title: Management and Monitoring
description: Manage and monitor API endpoints, schemas, routing, and session identifiers.
products:
- api-shield
sidebar:
order: 5
group:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
pcx_content_type: how-to

description: Configure session identifiers to track authenticated API traffic per user.
products:
- api-shield
title: Session identifiers
sidebar:
order: 3
Expand Down
4 changes: 3 additions & 1 deletion src/content/docs/api-shield/plans.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Plans
pcx_content_type: overview

description: Compare API Shield feature availability and endpoint limits across Cloudflare plans.
products:
- api-shield
sidebar:
order: 3

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Classic Schema validation (deprecated)
pcx_content_type: how-to

description: Reference for the deprecated classic Schema validation feature in API Shield.
products:
- api-shield
head:
- tag: title
content: Configure Classic Schema validation (deprecated)
Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/api-shield/reference/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
pcx_content_type: reference
title: Reference
description: Reference information for API Shield, including Terraform and classic validation.
products:
- api-shield
sidebar:
order: 6
group:
Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/api-shield/reference/terraform.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
pcx_content_type: how-to
title: Terraform
description: Configure API Shield resources with Terraform, including endpoints and schemas.
products:
- api-shield

---

Expand Down
4 changes: 3 additions & 1 deletion src/content/docs/api-shield/security/api-discovery.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
pcx_content_type: concept

description: Map out and understand your API attack surface with API Discovery.
products:
- api-shield
title: API Discovery
sidebar:
order: 1
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
pcx_content_type: concept

description: Identify authentication misconfigurations for API endpoints with Authentication Posture.
products:
- api-shield
title: Authentication Posture
sidebar:
order: 9
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
pcx_content_type: concept

description: Detect endpoints at risk of Broken Object Level Authorization attacks.
products:
- api-shield
title: Broken Object Level Authorization vulnerability detection
sidebar:
order: 10
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Configure GraphQL malicious query protection via the API
pcx_content_type: how-to

description: Use the GraphQL API to configure query size and depth limits for your API.
products:
- api-shield
sidebar:
order: 2
label: API
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
pcx_content_type: concept
title: GraphQL malicious query protection
description: Scan GraphQL traffic and block queries that could overload your origin.
products:
- api-shield
sidebar:
order: 5

Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/api-shield/security/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
pcx_content_type: navigation
title: Security
description: Discover, validate, and protect API endpoints with API Shield security features.
products:
- api-shield
sidebar:
order: 4

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Configure JWT validation via the API
pcx_content_type: how-to

description: Create token configurations and validation rules for JWT validation using the API.
products:
- api-shield
sidebar:
order: 2
label: API
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
pcx_content_type: concept
title: JSON Web Tokens validation
description: Verify incoming JWTs to prevent replay attacks and token tampering at the edge.
products:
- api-shield
sidebar:
order: 6
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Configure the Worker
pcx_content_type: how-to

description: Use a Worker to keep your identity provider public keys updated for JWT validation.
products:
- api-shield
sidebar:
order: 3
head:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Enhance Transform Rules
pcx_content_type: how-to

description: Forward verified JWT claims to your origin using Transform Rules.
products:
- api-shield
sidebar:
order: 4
head:
Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/api-shield/security/mtls/byo-ca.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
pcx_content_type: navigation
title: Bring your own CA
description: Use your own certificate authority for mTLS client certificates.
products:
- api-shield
external_link: /ssl/client-certificates/byo-ca/
sidebar:
order: 3
Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/api-shield/security/mtls/configure.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: Configure mTLS
pcx_content_type: how-to
description: Set up mTLS authentication rules to require client certificates for API hosts.
products:
- api-shield
sidebar:
order: 2
head:
Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/api-shield/security/mtls/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
pcx_content_type: concept
title: Mutual TLS (mTLS)
description: Require client certificates to authenticate API requests with mutual TLS.
products:
- api-shield
sidebar:
order: 7

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Configure Schema validation via the API
pcx_content_type: how-to

description: Configure per-endpoint schema validation and mitigation actions using the API.
products:
- api-shield
sidebar:
label: API
head:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
pcx_content_type: concept
title: Schema validation
description: Validate API requests against OpenAPI schemas to block malformed or unexpected traffic.
products:
- api-shield
sidebar:
order: 8
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
pcx_content_type: concept

description: Track the order of API requests over time to discover user journeys and sequences.
products:
- api-shield
title: Sequence Analytics
sidebar:
order: 3
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Configure sequence mitigation via the API
pcx_content_type: how-to

description: Build and configure sequence mitigation rules using the Cloudflare API.
products:
- api-shield
sidebar:
order: 3
label: API
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
pcx_content_type: reference
title: Sequence mitigation custom rules
description: Write custom rules that match valid or invalid API request sequences.
products:
- api-shield
sidebar:
order: 4
label: Custom rules
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
pcx_content_type: concept
title: Sequence mitigation
description: Enforce expected API request patterns to detect and block malicious sequences.
products:
- api-shield
sidebar:
order: 4

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Manage sequence rules
pcx_content_type: how-to

description: Create and manage sequence rules in the dashboard or via WAF custom rules.
products:
- api-shield
sidebar:
order: 2
label: Manage sequence rules
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
pcx_content_type: concept

description: Set up adaptive, per-session rate limiting for API endpoints with Volumetric Abuse Detection.
products:
- api-shield
title: Volumetric Abuse Detection
sidebar:
order: 2
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
pcx_content_type: concept
title: Configure Vulnerability Scanner via the API
description: Test API endpoints for BOLA and other vulnerabilities using the Cloudflare API.
products:
- api-shield
sidebar:
order: 11
label: Vulnerability Scanner
Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/bots/account-abuse-protection.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
pcx_content_type: Concept
title: Account Abuse Protection (Early Access)
description: Detect and block automated abuse on login and registration endpoints.
products:
- bots
sidebar:
order: 6
label: Account Abuse Protection
Expand Down
Loading
Loading