diff --git a/public/_redirects b/public/_redirects index a889f52c3efa667..41cfd7a2d909eb7 100644 --- a/public/_redirects +++ b/public/_redirects @@ -644,7 +644,7 @@ /images/cloudflare-images/upload-images/custom-id/ /images/upload-images/upload-custom-path/ 301 /images/cloudflare-images/upload-images/dashboard-upload/ /images/upload-images/upload-dashboard/ 301 /images/cloudflare-images/upload-images/direct-creator-upload/ /images/upload-images/direct-creator-upload/ 301 -/images/cloudflare-images/upload-images/images-batch/ /api/operations/cloudflare-images-list-images 301 +/images/cloudflare-images/upload-images/images-batch/ /api/resources/images/subresources/v2/methods/list/ 301 /images/cloudflare-images/upload-images/upload-via-url/ /images/upload-images/upload-url/ 301 /images/faq/ /images/ 301 /images/image-resizing/ /images/manage-images/create-variants/ 301 @@ -1317,9 +1317,9 @@ /workers/about/tips/signing-requests/ /workers/examples/signing-requests/ 301 /workers/about/using-cache/ /workers/reference/how-the-cache-works/ 301 /workers/learning/how-the-cache-works/ /workers/reference/how-the-cache-works/ 301 -/workers/api/ /api/operations/worker-script-list-workers 301 +/workers/api/ /api/resources/workers/subresources/scripts/methods/list/ 301 /workers/learning/how-kv-works/ /kv/learning/how-kv-works/ 301 -/workers/api/resource-bindings/webassembly-modules/ /api/operations/worker-script-list-workers 301 +/workers/api/resource-bindings/webassembly-modules/ /api/resources/workers/subresources/scripts/methods/list/ 301 /workers/api/route-matching/ /workers/platform/routing/routes/ 301 /workers/cli-wrangler/ /workers/wrangler/ 301 /workers/cli-wrangler/configuration/ /workers/wrangler/configuration/ 301 @@ -1334,7 +1334,7 @@ /workers/learning/fetch-event-lifecycle/ /workers/runtime-apis/fetch-event/ 301 /workers/learning/getting-started/ /workers/get-started/guide/ 301 /workers/learning/profiling-workers/ /workers/reference/how-workers-works/ 301 -/workers/platform/scripts/ /api/operations/worker-script-list-workers 301 +/workers/platform/scripts/ /api/resources/workers/subresources/scripts/methods/list/ 301 /workers/platform/services/ /workers/runtime-apis/bindings/service-bindings/ 301 /workers/platform/web-assembly/ /workers/platform/webassembly/ 301 /workers/platform/web-assembly/rust/ /workers/platform/webassembly/rust/ 301 diff --git a/src/content/changelogs/ai-gateway.yaml b/src/content/changelogs/ai-gateway.yaml index 638296c089c1a0b..58e5f12e8155f17 100644 --- a/src/content/changelogs/ai-gateway.yaml +++ b/src/content/changelogs/ai-gateway.yaml @@ -92,7 +92,7 @@ entries: - publish_date: "2024-05-09" description: |- - * Added new endpoints to the [REST API](/api/operations/aig-config-create-gateway). + * Added new endpoints to the [REST API](/api/resources/ai_gateway/methods/create/). - publish_date: "2024-03-26" diff --git a/src/content/changelogs/api-deprecations.yaml b/src/content/changelogs/api-deprecations.yaml index 184571da870ed7f..909f5fee94f85c1 100644 --- a/src/content/changelogs/api-deprecations.yaml +++ b/src/content/changelogs/api-deprecations.yaml @@ -10,7 +10,7 @@ entries: description: |- Deprecation date: November 21, 2025 - The `self_hosted_domains` field for [Access applications](https://developers.cloudflare.com/api/operations/access-applications-update-an-access-application) is deprecated in favor of `destinations` to allow for more flexibility in defining different types of domains. + The `self_hosted_domains` field for [Access applications](https://developers.cloudflare.com/api/resources/zero_trust/subresources/access/subresources/applications/methods/update/) is deprecated in favor of `destinations` to allow for more flexibility in defining different types of domains. Before: ```json @@ -57,7 +57,7 @@ entries: Deprecation date: March 21, 2025 The Zone Settings API endpoints for managing zone-level CNAME flattening are deprecated. - Instead, use the [Show DNS Settings](/api/operations/dns-settings-for-a-zone-list-dns-settings) and [Update DNS Settings](/api/operations/dns-settings-for-a-zone-update-dns-settings) endpoints to manage this setting. + Instead, use the [Show DNS Settings](/api/resources/dns/subresources/settings/methods/get/) and [Update DNS Settings](/api/resources/dns/subresources/settings/methods/edit/) endpoints to manage this setting. Changes via the old endpoints will be reflected in the new ones, and vice versa, so there is no need to migrate existing zones. However, future API calls must use DNS Settings instead of the Zone Settings endpoints. @@ -80,7 +80,7 @@ entries: Deprecation date: March 14, 2025 The fields `"default_nameservers"` and `"use_account_custom_ns_by_default"` within the `"settings"` object of accounts are deprecated. - Instead, use the [Show DNS Settings](/api/operations/dns-settings-for-an-account-list-dns-settings) and [Update DNS Settings](/api/operations/dns-settings-for-an-account-update-dns-settings) endpoints to manage this setting. + Instead, use the [Show DNS Settings](/api/resources/dns/subresources/settings/methods/get/) and [Update DNS Settings](/api/resources/dns/subresources/settings/methods/edit/) endpoints to manage this setting. This setting is available in the new API as `.zone_defaults.nameservers.type`, with allowed values `"cloudflare.standard"`, `"cloudflare.standard.random"`, `"custom.account"` and `"custom.tenant"`. Changes via the old endpoints will be reflected in the new ones, and vice versa, so there is no need to migrate existing zones. However, future API calls must use DNS Settings instead of the Accounts endpoints. @@ -283,7 +283,7 @@ entries: The dedicated endpoints for DNS settings `use_apex_ns` and `secondary_overrides` are being deprecated. - Instead, use the [Show DNS Settings](/api/operations/dns-settings-for-a-zone-list-dns-settings) and [Update DNS Settings](/api/operations/dns-settings-for-a-zone-update-dns-settings) endpoints to manage these settings. + Instead, use the [Show DNS Settings](/api/resources/dns/subresources/settings/methods/get/) and [Update DNS Settings](/api/resources/dns/subresources/settings/methods/edit/) endpoints to manage these settings. - Instead of the `.../use_apex_ns` endpoint, use the `multi_provider` field. - Instead of the `.../secondary_overrides` endpoint, use the `secondary_overrides` field. @@ -371,7 +371,7 @@ entries: The complete name would then be, e.g., `_xmpp._tcp.example.com`. - When interacting with DNS records through the [API](/api/operations/dns-records-for-a-zone-create-dns-record), SRV records contain both a full `name` as well as a `data` map containing the individual components of the name: + When interacting with DNS records through the [API](/api/resources/dns/subresources/records/methods/create/), SRV records contain both a full `name` as well as a `data` map containing the individual components of the name: ```txt { diff --git a/src/content/changelogs/byoip.yaml b/src/content/changelogs/byoip.yaml index 9fe7d02f0add233..1d50e007c8784f0 100644 --- a/src/content/changelogs/byoip.yaml +++ b/src/content/changelogs/byoip.yaml @@ -7,4 +7,4 @@ productAreaLink: /fundamentals/reference/changelog/performance/ entries: - publish_date: "2024-07-02" title: Address Maps for BYOIP and Static IPs - description: Address Maps is available via [API](/api/operations/ip-address-management-address-maps-list-address-maps) and via [dashboard](https://dash.cloudflare.com/?to=/:account/ip-addresses/proxy-ips). Address Maps allows customers with BYOIP prefixes or account-level Static IPs to specify which IP addresses should be mapped to DNS records when they are proxied through Cloudflare. Refer to the [documentation](/byoip/address-maps/) for details. + description: Address Maps is available via [API](/api/resources/addressing/subresources/address_maps/methods/list/) and via [dashboard](https://dash.cloudflare.com/?to=/:account/ip-addresses/proxy-ips). Address Maps allows customers with BYOIP prefixes or account-level Static IPs to specify which IP addresses should be mapped to DNS records when they are proxied through Cloudflare. Refer to the [documentation](/byoip/address-maps/) for details. diff --git a/src/content/changelogs/d1.yaml b/src/content/changelogs/d1.yaml index f197aac7caaac02..143e89c00d02291 100644 --- a/src/content/changelogs/d1.yaml +++ b/src/content/changelogs/d1.yaml @@ -26,7 +26,7 @@ entries: - publish_date: "2024-06-17" title: HTTP API now returns a HTTP 429 error for overloaded D1 databases description: |- - Previously, D1's [HTTP API](/api/operations/cloudflare-d1-query-database) returned a HTTP `500 Internal Server` error for queries that came in while a D1 database was overloaded. These requests now correctly return a `HTTP 429 Too Many Requests` error. + Previously, D1's [HTTP API](/api/resources/d1/subresources/database/methods/query/) returned a HTTP `500 Internal Server` error for queries that came in while a D1 database was overloaded. These requests now correctly return a `HTTP 429 Too Many Requests` error. D1's [Workers API](/d1/worker-api/) is unaffected by this change. @@ -40,7 +40,7 @@ entries: - publish_date: "2024-04-12" title: HTTP API now returns a HTTP 400 error for invalid queries description: |- - Previously, D1's [HTTP API](/api/operations/cloudflare-d1-query-database) returned a HTTP `500 Internal Server` error for an invalid query. An invalid SQL query now correctly returns a `HTTP 400 Bad Request` error. + Previously, D1's [HTTP API](/api/resources/d1/subresources/database/methods/query/) returned a HTTP `500 Internal Server` error for an invalid query. An invalid SQL query now correctly returns a `HTTP 400 Bad Request` error. D1's [Workers API](/d1/worker-api/) is unaffected by this change. diff --git a/src/content/changelogs/gateway.yaml b/src/content/changelogs/gateway.yaml index f85e6207b202a09..66b658db5908c75 100644 --- a/src/content/changelogs/gateway.yaml +++ b/src/content/changelogs/gateway.yaml @@ -36,7 +36,7 @@ entries: - publish_date: "2024-06-25" title: Gateway DNS policy setting to ignore CNAME category matches description: |- - Gateway now offers the ability to selectively ignore CNAME domain categories in DNS policies via the [**Ignore CNAME domain categories** setting](/cloudflare-one/policies/gateway/domain-categories/#ignore-cname-domain-categories) in the policy builder and the [`ignore_cname_category_matches` setting](/api/operations/zero-trust-gateway-rules-create-zero-trust-gateway-rule) in the API. + Gateway now offers the ability to selectively ignore CNAME domain categories in DNS policies via the [**Ignore CNAME domain categories** setting](/cloudflare-one/policies/gateway/domain-categories/#ignore-cname-domain-categories) in the policy builder and the [`ignore_cname_category_matches` setting](/api/resources/zero_trust/subresources/gateway/subresources/rules/methods/create/) in the API. - publish_date: "2024-04-05" title: Gateway file type control improvements description: |- diff --git a/src/content/changelogs/kv.yaml b/src/content/changelogs/kv.yaml index 6ff47e6cad508cf..17fd25cdfa5bf90 100644 --- a/src/content/changelogs/kv.yaml +++ b/src/content/changelogs/kv.yaml @@ -9,7 +9,7 @@ entries: title: Workers KV REST API bulk operations provide granular errors description: |- - The REST API endpoints for bulk operations ([write](/api/operations/workers-kv-namespace-write-multiple-key-value-pairs), [delete](/api/operations/workers-kv-namespace-delete-multiple-key-value-pairs)) now return the keys of operations that failed during the bulk operation. The updated response bodies are documented in the [REST API documentation](/api/operations/workers-kv-namespace-list-namespaces) and contain the following information in the `result` field: + The REST API endpoints for bulk operations ([write](/api/resources/kv/subresources/namespaces/methods/bulk_update/), [delete](/api/resources/kv/subresources/namespaces/methods/bulk_delete/)) now return the keys of operations that failed during the bulk operation. The updated response bodies are documented in the [REST API documentation](/api/resources/kv/subresources/namespaces/methods/list/) and contain the following information in the `result` field: ``` { @@ -26,5 +26,5 @@ entries: Workers KV now has a new [metrics dashboard](/kv/observability/metrics-analytics/#view-metrics-in-the-dashboard) and [analytics API](/kv/observability/metrics-analytics/#query-via-the-graphql-api) that leverages the [GraphQL Analytics API](/analytics/graphql-api/) used by many other Cloudflare products. The new analytics API provides per-account and per-namespace metrics for both operations and storage, including latency metrics for read and write operations to Workers KV. - The legacy Workers KV [analytics REST API](/api/operations/workers-kv-request-analytics-query-request-analytics) will be turned off as of January 31st, 2025. + The legacy Workers KV [analytics REST API](/api/resources/kv/subresources/namespaces/subresources/analytics/methods/list/) will be turned off as of January 31st, 2025. Developers using this API will receive a series of email notifications prior to the shutdown of the legacy API. diff --git a/src/content/changelogs/r2.yaml b/src/content/changelogs/r2.yaml index 902878253166b5b..58b46936e3ef094 100644 --- a/src/content/changelogs/r2.yaml +++ b/src/content/changelogs/r2.yaml @@ -28,10 +28,10 @@ entries: - R2 [`bucket domain` command](/workers/wrangler/commands/#domain-add) added to Wrangler. Supports listing, adding, removing, and updating [R2 bucket custom domains](/r2/buckets/public-buckets/#custom-domains). - publish_date: "2024-11-01" description: |- - - Add `minTLS` to response of [list custom domains](/api/operations/r2-list-custom-domains) endpoint. + - Add `minTLS` to response of [list custom domains](/api/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/list/) endpoint. - publish_date: "2024-10-28" description: |- - - Add [get custom domain](/api/operations/r2-get-custom-domain-settings) endpoint. + - Add [get custom domain](/api/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/get/) endpoint. - publish_date: "2024-10-21" description: |- - Event notifications can now be configured for R2 buckets in [jurisdictions](/r2/reference/data-location/#jurisdictional-restrictions) (e.g., EU, FedRAMP). @@ -43,7 +43,7 @@ entries: - Add the ability to set and [update minimum TLS version](/r2/buckets/public-buckets/#minimum-tls-version) for R2 bucket custom domains. - publish_date: "2024-08-26" description: |- - - Added support for configuring R2 bucket custom domains via [API](/api/operations/r2-add-custom-domain). + - Added support for configuring R2 bucket custom domains via [API](/api/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/create/). - publish_date: "2024-08-21" description: |- - [Sippy](/r2/data-migration/sippy/) is now generally available. Metrics for ongoing migrations can now be found in the dashboard or via the GraphQL analytics API. @@ -64,7 +64,7 @@ entries: - Added support for [Infrequent Access](/r2/buckets/storage-classes/) storage class (beta). - publish_date: "2024-05-24" description: |- - - Added [create temporary access tokens](/api/operations/r2-create-temp-access-credentials) endpoint. + - Added [create temporary access tokens](/api/resources/r2/subresources/temporary_credentials/methods/create/) endpoint. - publish_date: "2024-04-03" description: |- - [Event notifications](/r2/buckets/event-notifications/) for R2 is now available as an open beta. @@ -79,7 +79,7 @@ entries: - The shape of the configuration object when modifying Sippy's configuration has changed. - publish_date: "2024-02-02" description: |- - - Updated [GetBucket](/api/operations/r2-get-bucket) endpoint: Now fetches by `bucket_name` instead of `bucket_id`. + - Updated [GetBucket](/api/resources/r2/subresources/buckets/methods/get/) endpoint: Now fetches by `bucket_name` instead of `bucket_id`. - publish_date: "2024-01-30" description: |- - Fixed a bug where the API would accept empty strings in the `AllowedHeaders` property of `PutBucketCors` actions. @@ -115,14 +115,14 @@ entries: hashes. - publish_date: "2023-06-16" description: |- - - Fixed a bug where calling [GetBucket](/api/operations/r2-get-bucket) on a non-existent bucket would return a 500 instead of a 404. + - Fixed a bug where calling [GetBucket](/api/resources/r2/subresources/buckets/methods/get/) on a non-existent bucket would return a 500 instead of a 404. - Improved S3 compatibility for ListObjectsV1, now nextmarker is only set when truncated is true. - The R2 worker bindings now support parsing conditional headers with multiple etags. These etags can now be strong, weak or a wildcard. Previously the bindings only accepted headers containing a single strong etag. - S3 putObject now supports sha256 and sha1 checksums. These were already supported by the R2 worker bindings. - CopyObject in the S3 compatible api now supports Cloudflare specific headers which allow the copy operation to be conditional on the state of the destination object. - publish_date: "2023-04-01" description: |- - - [GetBucket](/api/operations/r2-get-bucket) is now available for use through the Cloudflare API. + - [GetBucket](/api/resources/r2/subresources/buckets/methods/get/) is now available for use through the Cloudflare API. - [Location hints](https://developers.cloudflare.com/r2/reference/data-location/) can now be set when creating a bucket, both through the S3 API, and the dashboard. - publish_date: "2023-03-16" description: |- diff --git a/src/content/changelogs/radar.yaml b/src/content/changelogs/radar.yaml index 061f3488cade080..5b0a807c714b2a1 100644 --- a/src/content/changelogs/radar.yaml +++ b/src/content/changelogs/radar.yaml @@ -9,8 +9,8 @@ entries: title: Change TCP connection tampering API endpoints to TCP Resets Timeouts description: |- * Changed the connection tampering summary and timeseries API endpoints to - TCP resets timeouts [summary](/api/operations/radar-get-tcp-resets-timeouts-summary) - and [timeseries](/api/operations/radar-get-tcp-resets-timeouts-timeseries-group), + TCP resets timeouts [summary](/api/resources/radar/subresources/tcp_resets_timeouts/methods/summary/) + and [timeseries](/api/resources/radar/subresources/tcp_resets_timeouts/methods/timeseries_groups/), respectively. - publish_date: "2023-11-27" title: Add more meta information's @@ -20,83 +20,83 @@ entries: - publish_date: "2023-11-16" title: Add new Layer 3 endpoints and Layer 7 dimensions description: |- - * Added Layer 3 [top origin locations](/api/operations/radar-get-attacks-layer3-top-origin-locations) - and [top target location](/api/operations/radar-get-attacks-layer3-top-target-locations). + * Added Layer 3 [top origin locations](/api/resources/radar/subresources/attacks/subresources/layer3/subresources/top/subresources/locations/methods/origin/) + and [top target location](/api/resources/radar/subresources/attacks/subresources/layer3/subresources/top/subresources/locations/methods/target/). * Added Layer 7 Summaries by `http_method`, `http_version`, `ip_version`, `managed_rules`, `mitigation_product`. * Added Layer 7 Timeseries Groups by `http_method`, `http_version`, `ip_version`, `managed_rules`, `mitigation_product`, `industry`, `vertical`. * Added Layer 7 Top by `industry`, `vertical`. - * Deprecated Layer 7 [timeseries groups without dimension](/api/operations/radar-get-attacks-layer7-timeseries-group). + * Deprecated Layer 7 [timeseries groups without dimension](/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries/-group). * To continue getting this data, switch to the new - [timeseries group by mitigation_product](/api/operations/radar-get-attacks-layer7-timeseries-group-by-mitigation-product) + [timeseries group by mitigation_product](/api/resources/radar/subresources/attacks/subresources/layer7/methods/timeseries/-group-by-mitigation-product) endpoint. - * Deprecated Layer 7 [summary without dimension)](/api/operations/radar-get-attacks-layer7-summary). + * Deprecated Layer 7 [summary without dimension)](/api/resources/radar/subresources/attacks/subresources/layer7/subresources/summary/methods/get/). * To continue getting this data, switch to the new - [summary by mitigation_product](/api/operations/radar-get-attacks-layer7-summary-by-mitigation-product) + [summary by mitigation_product](/api/resources/radar/subresources/attacks/subresources/layer7/subresources/summary/methods/get/-by-mitigation-product) endpoint. * Added new [Error codes](/radar/get-started/error-codes/). - publish_date: "2023-10-31" title: Add new Layer 3 direction parameter description: |- * Added a `direction` parameter to all Layer 3 endpoints. Use together with `location` parameter to filter by origin or - target location [timeseries groups](/api/operations/radar-get-attacks-layer3-timeseries-group-by-vector). + target location [timeseries groups](/api/resources/radar/subresources/attacks/subresources/layer3/subresources/timeseries_groups/methods/vector/). - publish_date: "2023-09-08" title: Add Connection Tampering endpoints description: |- - * Added Connection Tampering [summary](/api/operations/radar-get-tcp-resets-timeouts-summary) - and [timeseries](/api/operations/radar-get-tcp-resets-timeouts-timeseries-group) endpoints. + * Added Connection Tampering [summary](/api/resources/radar/subresources/tcp_resets_timeouts/methods/summary/) + and [timeseries](/api/resources/radar/subresources/tcp_resets_timeouts/methods/timeseries_groups/) endpoints. - publish_date: "2023-08-14" title: Deprecate old layer 3 dataset description: |- * Added Regional Internet Registry (see field `source` in response) - to [get asn by id](/api/operations/radar-get-entities-asn-by-id) - and [get asn by ip](/api/operations/radar-get-entities-asn-by-ip) endpoints. + to [get asn by id](/api/resources/radar/subresources/entities/subresources/asns/methods/get/) + and [get asn by ip](/api/resources/radar/subresources/entities/subresources/asns/methods/ip/) endpoints. * Stopped collecting data in the old Layer 3 data source. * Updated Layer 3 - [timeseries](/api/operations/radar-get-attacks-layer3-timeseries-by-bytes) endpoint + [timeseries](/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries/) endpoint to start using the new Layer 3 data source by default, fetching the old data source now requires sending the parameter `metric=bytes_old`. * Deprecated Layer 3 - [summary](/api/operations/radar-get-attacks-layer3-summary) endpoint, this will stop + [summary](/api/resources/radar/subresources/attacks/subresources/layer3/subresources/summary/methods/get/) endpoint, this will stop receiving data after 2023-08-14. * To continue getting this data, switch to the - new [timeseries group protocol](/api/operations/radar-get-attacks-layer3-summary-by-protocol) + new [timeseries group protocol](/api/resources/radar/subresources/attacks/subresources/layer3/subresources/summary/methods/get/-by-protocol) endpoint. * Deprecated Layer 3 - [timeseries groups](/api/operations/radar-get-attacks-layer3-timeseries-groups) + [timeseries groups](/api/resources/radar/subresources/attacks/subresources/layer3/subresources/timeseries_groups/methods/get/) endpoint, this will stop receiving data after 2023-08-14. * To continue getting this data, switch to the - new [timeseries group protocol](/api/operations/radar-get-attacks-layer3-timeseries-group-by-protocol) + new [timeseries group protocol](/api/resources/radar/subresources/attacks/subresources/layer3/subresources/timeseries_groups/methods/protocol/) endpoint. - publish_date: "2023-07-31" title: Fix HTTP timeseries endpoint urls description: |- * Updated HTTP `timeseries` endpoints urls - to `timeseries_groups` ([example](/api/operations/radar-get-http-timeseries-group-by-browser-families)) + to `timeseries_groups` ([example](/api/resources/radar/subresources/http/methods/timeseries/-group-by-browser-families)) due to consistency. Old timeseries endpoints are still available, but will soon be removed. - publish_date: "2023-07-20" title: Add URL Scanner endpoints description: |- - * Added [urlscanner endpoints](/api/operations/urlscanner-search-scans). For more information, refer to [URL Scanner](/radar/investigate/url-scanner/). + * Added [urlscanner endpoints](/api/resources/url_scanner/subresources/scans/methods/list/). For more information, refer to [URL Scanner](/radar/investigate/url-scanner/). - publish_date: "2023-06-20" title: Add Quality endpoints description: |- - * Added [quality endpoints](/api/operations/radar-get-quality-index-summary). + * Added [quality endpoints](/api/resources/radar/subresources/quality/subresources/iqi/methods/summary/). - publish_date: "2023-06-07" title: Add BGP stats, pfx2as and moas endpoint description: |- - * Added BGP [stats](/api/operations/radar-get-bgp-routes-stats), - [pfx2as](/api/operations/radar-get-bgp-pfx2as) - and [moas](/api/operations/radar-get-bgp-pfx2as-moas) endpoints. + * Added BGP [stats](/api/resources/radar/subresources/bgp/subresources/routes/methods/stats/), + [pfx2as](/api/resources/radar/subresources/bgp/subresources/routes/methods/pfx2as/) + and [moas](/api/resources/radar/subresources/bgp/subresources/routes/methods/moas/) endpoints. - publish_date: "2023-05-10" title: Added `IOS` as an option for the OS parameter in all HTTP description: |- * Added `IOS` as an option for the OS parameter in all HTTP - endpoints ([example](/api/operations/radar-get-http-summary-by-bot-class)). + endpoints ([example](/api/resources/radar/subresources/http/subresources/summary/methods/bot_class/)). - publish_date: "2023-03-20" title: Add AS112 and email endpoints description: |- - * Added [AS112 endpoints](/api/operations/radar-get-dns-as112-timeseries-by-dnssec). - * Added [email endpoints](/api/operations/radar-get-email-security-summary-by-arc). + * Added [AS112 endpoints](/api/resources/radar/subresources/as112/subresources/summary/methods/dnssec/). + * Added [email endpoints](/api/resources/radar/subresources/email/subresources/security/subresources/summary/methods/arc/). - publish_date: "2023-01-23" title: Updated IPv6 calculation method description: |- @@ -107,11 +107,11 @@ entries: description: |- * Added new Layer 3 data source and related endpoints. * Updated Layer 3 - [timeseries](/api/operations/radar-get-attacks-layer3-timeseries-by-bytes) endpoint + [timeseries](/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries/) endpoint to support fetching both current and new data sources. For retro-compatibility reasons, fetching the new data source requires sending the parameter `metric=bytes` else the current data source will be returned. * Deprecated old Layer 3 endpoints - [TimeseriesGroups](/api/operations/radar-get-attacks-layer3-timeseries-groups) and - [Summary](/api/operations/radar-get-attacks-layer3-summary). + [TimeseriesGroups](/api/resources/radar/subresources/attacks/subresources/layer3/subresources/timeseries_groups/methods/get/) and + [Summary](/api/resources/radar/subresources/attacks/subresources/layer3/subresources/summary/methods/get/). Users should upgrade to newer endpoints. diff --git a/src/content/changelogs/ssl.yaml b/src/content/changelogs/ssl.yaml index 2684fd1f5b8e842..b0e4c49dd2d0fb0 100644 --- a/src/content/changelogs/ssl.yaml +++ b/src/content/changelogs/ssl.yaml @@ -7,7 +7,7 @@ productAreaLink: /fundamentals/reference/changelog/performance/ entries: - publish_date: "2024-10-18" title: New cloudflare_branding flag allows hostnames with over 64 characters for all CAs - description: To order certificates for hostnames longer than 64 characters, customers can now use the `cloudflare_branding` flag when ordering a certificate via [API](/api/operations/certificate-packs-order-advanced-certificate-manager-certificate-pack). Setting `cloudflare_branding` to `true` will cause `sni.cloudflaressl.com` to be used as the common name, while the long hostname is added as part of the subject alternative name (SAN). + description: To order certificates for hostnames longer than 64 characters, customers can now use the `cloudflare_branding` flag when ordering a certificate via [API](/api/resources/ssl/subresources/certificate_packs/methods/create/). Setting `cloudflare_branding` to `true` will cause `sni.cloudflaressl.com` to be used as the common name, while the long hostname is added as part of the subject alternative name (SAN). - publish_date: "2024-09-19" title: SSL.com available with ACM and SSL for SaaS description: SSL.com is one of the [certificate authorities](/ssl/reference/certificate-authorities/) that Cloudflare partners with. SSL.com is now available as an option to customers with Advanced Certificate Manager (ACM) or SSL for SaaS. Consider our [reference documentation](/ssl/reference/certificate-authorities/#sslcom) for details. diff --git a/src/content/changelogs/stream.yaml b/src/content/changelogs/stream.yaml index 70553b86f9dcd3b..c928623852c9cc8 100644 --- a/src/content/changelogs/stream.yaml +++ b/src/content/changelogs/stream.yaml @@ -121,7 +121,7 @@ entries: - publish_date: "2022-11-01" title: Create an unlimited number of live inputs description: |- - Cloudflare Stream now has no limit on the number of [live inputs](/api/operations/stream-live-inputs-retrieve-a-live-input) you can create. Stream is designed to allow your end-users to go live — live inputs can be created quickly on-demand via a single API request for each of user of your platform or app. + Cloudflare Stream now has no limit on the number of [live inputs](/api/resources/stream/subresources/live_inputs/methods/get/) you can create. Stream is designed to allow your end-users to go live — live inputs can be created quickly on-demand via a single API request for each of user of your platform or app. For more on creating and managing live inputs, get started with the [docs](/stream/stream-live/). - publish_date: "2022-10-20" @@ -174,7 +174,7 @@ entries: title: Live inputs description: The Live Inputs API now supports optional pagination, search, and filter - parameters. For more information, refer to the [Live Inputs API documentation](/api/operations/stream-live-inputs-list-live-inputs). + parameters. For more information, refer to the [Live Inputs API documentation](/api/resources/stream/subresources/live_inputs/methods/list/). - publish_date: "2022-05-24" title: Picture-in-Picture support description: diff --git a/src/content/changelogs/vectorize.yaml b/src/content/changelogs/vectorize.yaml index ab74658cbaecb32..0552b4ce625f781 100644 --- a/src/content/changelogs/vectorize.yaml +++ b/src/content/changelogs/vectorize.yaml @@ -14,8 +14,8 @@ entries: title: Improved query latency through REST API description: |- Vectorize now has a significantly improved query latency through REST API: - * [Query vectors](/api/operations/vectorize-query-vector). - * [Get vector by identifier](/api/operations/vectorize-get-vectors-by-id). + * [Query vectors](/api/resources/vectorize/subresources/indexes/methods/query/). + * [Get vector by identifier](/api/resources/vectorize/subresources/indexes/methods/get_by_ids/). - publish_date: "2024-10-24" title: Vectorize increased limits diff --git a/src/content/changelogs/workers.yaml b/src/content/changelogs/workers.yaml index ba9e7434719948e..aa9e8610c20fea1 100644 --- a/src/content/changelogs/workers.yaml +++ b/src/content/changelogs/workers.yaml @@ -67,7 +67,7 @@ entries: - [Exceptions](/durable-objects/best-practices/error-handling) thrown from Durable Object internal operations and tunneled to the caller may now be populated with a `.retryable: true` property if the exception was likely due to a transient failure, or populated with an `.overloaded: true` property if the exception was due to [overload](/durable-objects/observability/troubleshooting/#durable-object-is-overloaded). - publish_date: "2024-06-20" description: |- - - We now prompt for extra confirmation if attempting to rollback to a version of a Worker using the [Deployments API](/api/operations/worker-deployments-create-deployment) where the value of a secret is different than the currently deployed version. A `?force=true` query parameter can be specified to proceed with the rollback. + - We now prompt for extra confirmation if attempting to rollback to a version of a Worker using the [Deployments API](/api/resources/workers/subresources/scripts/subresources/deployments/methods/create/) where the value of a secret is different than the currently deployed version. A `?force=true` query parameter can be specified to proceed with the rollback. - publish_date: "2024-06-19" description: |- - When using [`nodejs_compat` compatibility flag](/workers/runtime-apis/nodejs/), the `buffer` module now has an implementation of `isAscii()` and `isUtf8()` methods. diff --git a/src/content/docs/ai-gateway/api-reference.mdx b/src/content/docs/ai-gateway/api-reference.mdx index cd97c39297691bd..c098a154fac34f2 100644 --- a/src/content/docs/ai-gateway/api-reference.mdx +++ b/src/content/docs/ai-gateway/api-reference.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: REST API reference -external_link: /api/operations/aig-config-list-gateway +external_link: /api/resources/ai_gateway/methods/list/ sidebar: order: 8 diff --git a/src/content/docs/ai-gateway/configuration/caching.mdx b/src/content/docs/ai-gateway/configuration/caching.mdx index 6d7a6851228400f..f894f7189904ec4 100644 --- a/src/content/docs/ai-gateway/configuration/caching.mdx +++ b/src/content/docs/ai-gateway/configuration/caching.mdx @@ -41,7 +41,7 @@ To set the default caching configuration using the API: - `AI Gateway - Edit` 2. Get your [Account ID](/fundamentals/setup/find-account-and-zone-ids/). -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`. +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`. diff --git a/src/content/docs/ai-gateway/configuration/rate-limiting.mdx b/src/content/docs/ai-gateway/configuration/rate-limiting.mdx index d026ecf1b08819d..5a7724946b8b937 100644 --- a/src/content/docs/ai-gateway/configuration/rate-limiting.mdx +++ b/src/content/docs/ai-gateway/configuration/rate-limiting.mdx @@ -43,7 +43,7 @@ To set the default rate limiting configuration using the API: - `AI Gateway - Edit` 2. Get your [Account ID](/fundamentals/setup/find-account-and-zone-ids/). -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`. +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`. diff --git a/src/content/docs/ai-gateway/evaluations/add-human-feedback-api.mdx b/src/content/docs/ai-gateway/evaluations/add-human-feedback-api.mdx index 7a36c96b6901e24..3a5dc89ca7c213d 100644 --- a/src/content/docs/ai-gateway/evaluations/add-human-feedback-api.mdx +++ b/src/content/docs/ai-gateway/evaluations/add-human-feedback-api.mdx @@ -17,7 +17,7 @@ If you prefer to add human feedback via the dashboard, refer to [Add Human Feedb - `AI Gateway - Edit` 2. Get your [Account ID](/fundamentals/setup/find-account-and-zone-ids/). -3. Using that API token and Account ID, send a [`POST` request](/api/operations/aig-config-create-gateway) to the Cloudflare API. +3. Using that API token and Account ID, send a [`POST` request](/api/resources/ai_gateway/methods/create/) to the Cloudflare API. ## 2. Using the API Token @@ -62,7 +62,7 @@ In the example below, the `cf-aig-log-id` is `01JADMCQQQBWH3NXZ5GCRN98DP`. ### Method 2: Retrieve the `cf-aig-log-id` via API (GET request) -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). +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/). The steps below outline how to do this. diff --git a/src/content/docs/analytics/analytics-integrations/datadog.mdx b/src/content/docs/analytics/analytics-integrations/datadog.mdx index 56b0ba83ebcdda6..9c1153ec52fcd74 100644 --- a/src/content/docs/analytics/analytics-integrations/datadog.mdx +++ b/src/content/docs/analytics/analytics-integrations/datadog.mdx @@ -13,7 +13,7 @@ This tutorial explains how to analyze Cloudflare metrics using the [Cloudflare I Before viewing the Cloudflare dashboard in Datadog, note that this integration: * Is available to all Cloudflare customer plans (Free, Pro, Business and Enterprise) -* Is based on the [Cloudflare Analytics API](/api/operations/zone-analytics-\(-deprecated\)-get-dashboard) +* Is based on the Cloudflare Analytics API * Provides Cloudflare web traffic and DNS metrics only * Does not feature data coming from request logs stored in Cloudflare Logs diff --git a/src/content/docs/analytics/graphql-api/migration-guides/index.mdx b/src/content/docs/analytics/graphql-api/migration-guides/index.mdx index 9e1479734e268d0..743eb170974a74d 100644 --- a/src/content/docs/analytics/graphql-api/migration-guides/index.mdx +++ b/src/content/docs/analytics/graphql-api/migration-guides/index.mdx @@ -12,7 +12,7 @@ If you are currently using the deprecated `httpRequests1mByColoGroups` or `httpR ## Zone Analytics migrations -If you are currently using the [Zone Analytics API](/api/operations/zone-analytics-\(-deprecated\)-get-dashboard), the following guide will help you migrate your queries to the new GraphQL Analytics API: +If you are currently using the Zone Analytics API, the following guide will help you migrate your queries to the new GraphQL Analytics API: * [Zone Analytics to GraphQL Analytics](/analytics/graphql-api/migration-guides/zone-analytics/) * [Zone Analytics Colos Endpoint to GraphQL Analytics](/analytics/graphql-api/migration-guides/zone-analytics-colos/) diff --git a/src/content/docs/analytics/graphql-api/migration-guides/zone-analytics.mdx b/src/content/docs/analytics/graphql-api/migration-guides/zone-analytics.mdx index 090309e74ff1642..73436a6782d15ea 100644 --- a/src/content/docs/analytics/graphql-api/migration-guides/zone-analytics.mdx +++ b/src/content/docs/analytics/graphql-api/migration-guides/zone-analytics.mdx @@ -8,7 +8,7 @@ sidebar: import { Details } from "~/components" -The [Zone Analytics API](/api/operations/zone-analytics-\(-deprecated\)-get-dashboard) allows you to get request data by zone. It offers optional `since` and `until` parameters to specify the request time period and a `continuous` parameter to indicate whether the time period should be moved backward to find a period with completely aggregated data. +The Zone Analytics API allows you to get request data by zone. It offers optional `since` and `until` parameters to specify the request time period and a `continuous` parameter to indicate whether the time period should be moved backward to find a period with completely aggregated data. For example, here is a sample curl call to get data for a two minute period: diff --git a/src/content/docs/analytics/types-of-analytics.mdx b/src/content/docs/analytics/types-of-analytics.mdx index 723065f45febe05..2682a129a26b585 100644 --- a/src/content/docs/analytics/types-of-analytics.mdx +++ b/src/content/docs/analytics/types-of-analytics.mdx @@ -59,4 +59,4 @@ Beyond the analytics provided for your properties, you can also access analytics ## GraphQL APIs -If you would like to have more control over how you visualize the analytic and log information available on the Cloudflare dashboard, use the [GraphQL Analytics API](/analytics/graphql-api/) to build customized views. This API replaces and expands on the previous [Zone Analytics API](/api/operations/zone-analytics-\(-deprecated\)-get-dashboard). +If you would like to have more control over how you visualize the analytic and log information available on the Cloudflare dashboard, use the [GraphQL Analytics API](/analytics/graphql-api/) to build customized views. This API replaces and expands on the previous Zone Analytics API. diff --git a/src/content/docs/api-shield/get-started.mdx b/src/content/docs/api-shield/get-started.mdx index 45e81dc140abeee..aebb682bcaa09ae 100644 --- a/src/content/docs/api-shield/get-started.mdx +++ b/src/content/docs/api-shield/get-started.mdx @@ -91,7 +91,7 @@ You can import the learned schema of an entire hostname using the [Cloudflare da 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. -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). +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/). ## View and configure Sequence Analytics 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 79a7123bd579f38..b044d7e4265d634 100644 --- a/src/content/docs/api-shield/management-and-monitoring/index.mdx +++ b/src/content/docs/api-shield/management-and-monitoring/index.mdx @@ -150,7 +150,7 @@ Customers viewing analytics have the ability to toggle detailed metrics view bet ## Using the Cloudflare API -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. +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. ## Sensitive Data Detection diff --git a/src/content/docs/api-shield/security/jwt-validation/configure.mdx b/src/content/docs/api-shield/security/jwt-validation/configure.mdx index 9919acb8ce195e1..b388a63e142da81 100644 --- a/src/content/docs/api-shield/security/jwt-validation/configure.mdx +++ b/src/content/docs/api-shield/security/jwt-validation/configure.mdx @@ -170,7 +170,7 @@ If you only need JWT Validation on specific hostnames or subdomains of your apex 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. -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). +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/). ## Define a security policy diff --git a/src/content/docs/api-shield/security/jwt-validation/index.mdx b/src/content/docs/api-shield/security/jwt-validation/index.mdx index b8cfbc00d16b7b2..b84c6daaac384cc 100644 --- a/src/content/docs/api-shield/security/jwt-validation/index.mdx +++ b/src/content/docs/api-shield/security/jwt-validation/index.mdx @@ -69,4 +69,4 @@ JWT Validation is available for all API Shield customers. Enterprise customers w Currently, the following known limitations exist: 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. -2. JWT Validation only operates for endpoints (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). +2. JWT Validation only operates for endpoints (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/). diff --git a/src/content/docs/api-shield/security/sequence-mitigation/configure.mdx b/src/content/docs/api-shield/security/sequence-mitigation/configure.mdx index 3e751e3856288a6..73ba3e2a51fc004 100644 --- a/src/content/docs/api-shield/security/sequence-mitigation/configure.mdx +++ b/src/content/docs/api-shield/security/sequence-mitigation/configure.mdx @@ -43,7 +43,7 @@ Otherwise, the request to endpoint `b704ab4d-5be0-46e0-9875-b2b3d1ab42f9` is blo | `last_updated` | When this rule was last changed. | A date string | `2023-05-02T12:06:51.796286Z` | | `created_at` | When this rule was created. | A date string | `2023-05-02T12:06:51.796286Z` | -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). +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/). ### List sequence rules diff --git a/src/content/docs/api-shield/security/volumetric-abuse-detection.mdx b/src/content/docs/api-shield/security/volumetric-abuse-detection.mdx index a045665b40cbfb2..15755d15d71327c 100644 --- a/src/content/docs/api-shield/security/volumetric-abuse-detection.mdx +++ b/src/content/docs/api-shield/security/volumetric-abuse-detection.mdx @@ -67,7 +67,7 @@ To create rate limits: ## API -[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. +[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. ## Limitations diff --git a/src/content/docs/argo-smart-routing/get-started.mdx b/src/content/docs/argo-smart-routing/get-started.mdx index 4058370e73b0345..312a4f81b0a917c 100644 --- a/src/content/docs/argo-smart-routing/get-started.mdx +++ b/src/content/docs/argo-smart-routing/get-started.mdx @@ -26,7 +26,7 @@ To enable [Argo Smart Routing](https://dash.cloudflare.com/?to=/:account/:zone/t -To enable or disable Argo Smart Routing with the API, send a [`PATCH`](/api/operations/argo-smart-routing-patch-argo-smart-routing-setting) request with the `value` parameter set to your desired setting (`"on"` or `"off"`). +To enable or disable Argo Smart Routing with the API, send a [`PATCH`](/api/resources/argo/subresources/smart_routing/methods/edit/) request with the `value` parameter set to your desired setting (`"on"` or `"off"`). You will need to already have a [billing profile](/fundamentals/subscriptions-and-billing/create-billing-profile/) on your account to enable Argo Smart Routing. diff --git a/src/content/docs/byoip/concepts/dynamic-advertisement/best-practices.mdx b/src/content/docs/byoip/concepts/dynamic-advertisement/best-practices.mdx index 860df6b730b55ef..e819f0fdf8e66ce 100644 --- a/src/content/docs/byoip/concepts/dynamic-advertisement/best-practices.mdx +++ b/src/content/docs/byoip/concepts/dynamic-advertisement/best-practices.mdx @@ -14,7 +14,7 @@ To prevent issues and simplify the advertisement process during an attack scenar - Assign appropriate user roles. Ensure that users assigned to manage the status of IP prefix advertisement have the **Administrator** or **Super Administrator** role in your Cloudflare account. For more information, refer to [Setting up Multi-user accounts on Cloudflare](/fundamentals/setup/manage-members/). -- Get a list of the prefix IDs that you want to manage. Maintain a list of Cloudflare prefix IDs to simplify dynamic advertisement management and operations. You can [obtain prefix IDs](#obtain-prefix-ids) via the Cloudflare dashboard or use the [list prefixes](/api/operations/ip-address-management-prefixes-list-prefixes) operation in the Cloudflare API. Refer to these prefix IDs when managing prefix advertisement. +- Get a list of the prefix IDs that you want to manage. Maintain a list of Cloudflare prefix IDs to simplify dynamic advertisement management and operations. You can [obtain prefix IDs](#obtain-prefix-ids) via the Cloudflare dashboard or use the [list prefixes](/api/resources/addressing/subresources/prefixes/methods/list/) operation in the Cloudflare API. Refer to these prefix IDs when managing prefix advertisement. ## Enable prefix advertisement @@ -55,7 +55,7 @@ After saving your changes, it takes between two to seven minutes to enable adver ### Via the API -To configure prefix advertisement with the Cloudflare API, use the [IP Address Management and Dynamic Advertisement](/api/operations/ip-address-management-dynamic-advertisement-get-advertisement-status) API. +To configure prefix advertisement with the Cloudflare API, use the [IP Address Management and Dynamic Advertisement](/api/resources/addressing/subresources/prefixes/subresources/bgp/subresources/statuses/methods/get/) API. Most dynamic advertisement operations require that you supply the Cloudflare ID for any prefix you want to access with the Cloudflare API. The following section outlines how to obtain prefix IDs. @@ -70,6 +70,6 @@ Most dynamic advertisement operations require that you supply the Cloudflare ID -To obtain prefix IDs using the API, refer to the [list prefixes](/api/operations/ip-address-management-prefixes-list-prefixes) operation in the Cloudflare API. +To obtain prefix IDs using the API, refer to the [list prefixes](/api/resources/addressing/subresources/prefixes/methods/list/) operation in the Cloudflare API. diff --git a/src/content/docs/byoip/concepts/prefix-delegations.mdx b/src/content/docs/byoip/concepts/prefix-delegations.mdx index b721b44156c09d2..863d1809a7fc1f6 100644 --- a/src/content/docs/byoip/concepts/prefix-delegations.mdx +++ b/src/content/docs/byoip/concepts/prefix-delegations.mdx @@ -18,7 +18,7 @@ In this example, Account A is using BYOIP + CDN and Cloudflare for SaaS. Account ## API calls for prefix delegations -API calls for delegations can be found at [Prefix Delegations](/api/operations/ip-address-management-prefix-delegation-list-prefix-delegations). +API calls for delegations can be found at [Prefix Delegations](/api/resources/addressing/subresources/prefixes/subresources/delegations/methods/list/). ## Configure prefix delegations diff --git a/src/content/docs/byoip/service-bindings/index.mdx b/src/content/docs/byoip/service-bindings/index.mdx index 8bfa9b51577fe36..35a48aeb7d037e3 100644 --- a/src/content/docs/byoip/service-bindings/index.mdx +++ b/src/content/docs/byoip/service-bindings/index.mdx @@ -12,12 +12,12 @@ description: In IP address management, service binding refers to the association Service bindings are mappings that control whether traffic destined for a given IP address is routed to [Magic Transit](/magic-transit/), the CDN pipeline [^1], or the Spectrum pipeline [^2]. :::note -Service binding operations are currently only available via API. You can find all endpoints and their specifications in the [Cloudflare API documentation](/api/operations/ip-address-management-service-bindings-list-service-bindings). +Service binding operations are currently only available via API. You can find all endpoints and their specifications in the [Cloudflare API documentation](/api/resources/addressing/subresources/prefixes/subresources/bgp/subresources/bindings/methods/list/). ::: ## Scope -Customers using BYOIP with Magic Transit can leverage the [service binding API endpoints](/api/operations/ip-address-management-service-bindings-list-service-bindings) to selectively route traffic through the CDN [^1] or Spectrum [^2] pipelines on a per-IP address basis. +Customers using BYOIP with Magic Transit can leverage the [service binding API endpoints](/api/resources/addressing/subresources/prefixes/subresources/bgp/subresources/bindings/methods/list/) to selectively route traffic through the CDN [^1] or Spectrum [^2] pipelines on a per-IP address basis. You can upgrade individual IPs within a Magic Transit prefix to either a CDN IP or a Spectrum IP. For example, if you have `203.0.113.0/24`, you can upgrade `203.0.113.1` to CDN and `203.0.113.2` to Spectrum. diff --git a/src/content/docs/byoip/service-bindings/magic-transit-with-cdn.mdx b/src/content/docs/byoip/service-bindings/magic-transit-with-cdn.mdx index f37f4abf7d303c1..85c8248bec674fd 100644 --- a/src/content/docs/byoip/service-bindings/magic-transit-with-cdn.mdx +++ b/src/content/docs/byoip/service-bindings/magic-transit-with-cdn.mdx @@ -48,8 +48,8 @@ This guide assumes that the prefix is tied to a single Cloudflare account that h ## 1. Get account information 1. Log in to your Cloudflare account and get your [account ID](/fundamentals/setup/find-account-and-zone-ids/) and [API token](/fundamentals/api/get-started/create-token/). The token permissions should include `Account` - `IP Prefixes` - `Edit`. -2. Make a `GET` request to the [List Services](/api/operations/ip-address-management-service-bindings-list-services) endpoint and take note of the `id` associated with the CDN service. -3. Use the [List Prefixes](/api/operations/ip-address-management-prefixes-list-prefixes) endpoint and take note of the `id` associated with the prefix (`cidr`) you will configure. +2. Make a `GET` request to the [List Services](/api/resources/addressing/subresources/services/methods/list/) endpoint and take note of the `id` associated with the CDN service. +3. Use the [List Prefixes](/api/resources/addressing/subresources/prefixes/methods/list/) endpoint and take note of the `id` associated with the prefix (`cidr`) you will configure. @@ -62,7 +62,7 @@ At this point, continuing the [example](#before-you-begin), you should have a ma -4. To confirm you currently only have a Magic Transit service binding and that it spans across your entire prefix, make a `GET` request to the [List Service Bindings](/api/operations/ip-address-management-service-bindings-list-service-bindings) endpoint. Replace the `{prefix_id}` in the URI path by the actual prefix ID you got from the previous step. +4. To confirm you currently only have a Magic Transit service binding and that it spans across your entire prefix, make a `GET` request to the [List Service Bindings](/api/resources/addressing/subresources/prefixes/subresources/bgp/subresources/bindings/methods/list/) endpoint. Replace the `{prefix_id}` in the URI path by the actual prefix ID you got from the previous step. @@ -79,7 +79,7 @@ curl https://api.cloudflare.com/client/v4/accounts/{account_id}/addressing/prefi Once a service binding is created (or deleted), it will take four to six hours to propagate across Cloudflare's global network. Services for the IP addresses in scope will likely be disrupted during this window. ::: -1. Make a `POST` request to the [Create service binding](/api/operations/ip-address-management-service-bindings-create-service-binding) endpoint, indicating the IP address you want to bind to the CDN. Specify the **corresponding network mask** as needed. +1. Make a `POST` request to the [Create service binding](/api/resources/addressing/subresources/prefixes/subresources/bgp/subresources/bindings/methods/create/) endpoint, indicating the IP address you want to bind to the CDN. Specify the **corresponding network mask** as needed. @@ -119,7 +119,7 @@ In the response body, the initial provisioning state should be `provisioning`. -You can periodically check the service binding status using the [List Service Bindings](/api/operations/ip-address-management-service-bindings-list-service-bindings) endpoint. +You can periodically check the service binding status using the [List Service Bindings](/api/resources/addressing/subresources/prefixes/subresources/bgp/subresources/bindings/methods/list/) endpoint. ## 3. Create address maps @@ -148,7 +148,7 @@ If you need to map only specific subdomains (and not all proxied DNS records) to -Use the [Create Address Map](/api/operations/ip-address-management-address-maps-create-address-map) endpoint. +Use the [Create Address Map](/api/resources/addressing/subresources/address_maps/methods/create/) endpoint. Make sure you have the correct Key/Token and permissions. @@ -173,7 +173,7 @@ To create a DNS record in the dashboard: -To create records with the API, use a [POST request](/api/operations/dns-records-for-a-zone-create-dns-record). For field definitions, select a record type under the request body specification. +To create records with the API, use a [POST request](/api/resources/dns/subresources/records/methods/create/). For field definitions, select a record type under the request body specification. diff --git a/src/content/docs/cache/advanced-configuration/cache-reserve.mdx b/src/content/docs/cache/advanced-configuration/cache-reserve.mdx index f775889a08daa7c..462912cbea0aa37 100644 --- a/src/content/docs/cache/advanced-configuration/cache-reserve.mdx +++ b/src/content/docs/cache/advanced-configuration/cache-reserve.mdx @@ -29,7 +29,7 @@ A paid Cache Reserve Plan is required for the enablement. -Refer to the [Change Cache Reserve setting API](/api/operations/zone-cache-settings-change-cache-reserve-setting) for more information. +Refer to the [Change Cache Reserve setting API](/api/resources/cache/subresources/cache_reserve/methods/edit/) for more information. @@ -199,7 +199,7 @@ Be aware that the deletion may take up to 24 hours to complete. -To delete Cache Reserve data via API use the following example requests. For more information, refer to the [API documentation](/api/operations/zone-cache-settings-start-cache-reserve-clear). +To delete Cache Reserve data via API use the following example requests. For more information, refer to the [API documentation](/api/resources/cache/subresources/cache_reserve/methods/clear/). ```bash title="Request 1: Get Cache Reserve status" curl https://api.cloudflare.com/client/v4/zones/{zone_id}/cache/cache_reserve \ diff --git a/src/content/docs/cache/cache-security/cors.mdx b/src/content/docs/cache/cache-security/cors.mdx index 1b33f0ed31b43ea..1cddf76e7806347 100644 --- a/src/content/docs/cache/cache-security/cors.mdx +++ b/src/content/docs/cache/cache-security/cors.mdx @@ -18,5 +18,5 @@ The `Access-Control-Allow-Origin` header allows servers to specify rules for sha If you add or change CORS configuration at your origin web server, purging the Cloudflare cache by URL does not update the CORS headers. Force Cloudflare to retrieve the new CORS headers via one of the following options: * Change the filename or URL to bypass cache to instruct Cloudflare to retrieve the latest CORS headers. -* Use the [single-file purge API](/api/operations/zone-purge#purge-cached-content-by-url) to specify the appropriate CORS headers along with the purge request. +* Use the [single-file purge API](/api/resources/cache/methods/purge/#purge-cached-content-by-url) to specify the appropriate CORS headers along with the purge request. * Update the resource’s last-modified time at your origin web server. Then, complete a [full purge](/cache/how-to/purge-cache/purge-everything/) to retrieve the latest version of your assets including updated CORS headers. diff --git a/src/content/docs/cache/how-to/cache-rules/create-api.mdx b/src/content/docs/cache/how-to/cache-rules/create-api.mdx index e1b5e8e748e9b39..cf022328cbf11c8 100644 --- a/src/content/docs/cache/how-to/cache-rules/create-api.mdx +++ b/src/content/docs/cache/how-to/cache-rules/create-api.mdx @@ -24,12 +24,12 @@ When creating a cache rule via API, make sure you: ## Procedure -1. Use the [List zone rulesets](/api/operations/listZoneRulesets) method to obtain the list of rules already present in the `http_request_cache_settings` phase entry point ruleset. -2. If the phase ruleset does not exist, create it using the [Create a zone ruleset](/api/operations/createZoneRuleset) operation. In the new ruleset properties, set the following values: +1. Use the [List zone rulesets](/api/resources/rulesets/methods/list/) method to obtain the list of rules already present in the `http_request_cache_settings` phase entry point ruleset. +2. If the phase ruleset does not exist, create it using the [Create a zone ruleset](/api/resources/rulesets/methods/create/) operation. In the new ruleset properties, set the following values: * kind: `zone` * phase: `http_request_cache_settings` -3. Use the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation to add a cache rule to the list of ruleset rules. Alternatively, include the rule in the [Create a zone ruleset](/api/operations/createZoneRuleset) request mentioned in the previous step. -4. (Optional) To update an existing cache rule, use the [Update a zone ruleset rule](/api/operations/updateZoneRulesetRule) operation. For an example, refer to the section below. +3. Use the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation to add a cache rule to the list of ruleset rules. Alternatively, include the rule in the [Create a zone ruleset](/api/resources/rulesets/methods/create/) request mentioned in the previous step. +4. (Optional) To update an existing cache rule, use the [Update a zone ruleset rule](/api/resources/rulesets/methods/update/) operation. For an example, refer to the section below. ## Example requests diff --git a/src/content/docs/cache/how-to/edge-browser-cache-ttl/set-browser-ttl.mdx b/src/content/docs/cache/how-to/edge-browser-cache-ttl/set-browser-ttl.mdx index 022b083d0220530..7de3391d9efb346 100644 --- a/src/content/docs/cache/how-to/edge-browser-cache-ttl/set-browser-ttl.mdx +++ b/src/content/docs/cache/how-to/edge-browser-cache-ttl/set-browser-ttl.mdx @@ -19,7 +19,7 @@ Nevertheless, the value you set via Cache Rule will be ignored if `Cache-Control ## Set Browser Cache TTL -The Cloudflare UI and [API](/api/operations/zone-settings-edit-single-setting) both prohibit setting Browser Cache TTL to 0 for non-Enterprise domains. +The Cloudflare UI and [API](/api/resources/zones/subresources/settings/methods/edit/) both prohibit setting Browser Cache TTL to 0 for non-Enterprise domains. :::note[Note] diff --git a/src/content/docs/cache/how-to/purge-cache/purge-by-hostname.mdx b/src/content/docs/cache/how-to/purge-cache/purge-by-hostname.mdx index f278c2c5bd9b7fc..6033667249f0e1a 100644 --- a/src/content/docs/cache/how-to/purge-cache/purge-by-hostname.mdx +++ b/src/content/docs/cache/how-to/purge-cache/purge-by-hostname.mdx @@ -22,7 +22,7 @@ Purging by hostname means that all assets at URLs with a host that matches one o :::note[API] -You can purge hostnames via the Cloudflare API. For more information, refer to the [API documentation](/api/operations/zone-purge). You can use up to 30 hostnames per API call and make up to 30,000 purge API calls in a 24-hour period. +You can purge hostnames via the Cloudflare API. For more information, refer to the [API documentation](/api/resources/cache/methods/purge/). You can use up to 30 hostnames per API call and make up to 30,000 purge API calls in a 24-hour period. ::: diff --git a/src/content/docs/cache/how-to/purge-cache/purge-by-single-file.mdx b/src/content/docs/cache/how-to/purge-cache/purge-by-single-file.mdx index 8cf8f3a2093690f..846e5fa326deaf8 100644 --- a/src/content/docs/cache/how-to/purge-cache/purge-by-single-file.mdx +++ b/src/content/docs/cache/how-to/purge-cache/purge-by-single-file.mdx @@ -22,7 +22,7 @@ A single-file purge performed through your Cloudflare dashboard does not clear o * `X-Rewrite-URL` * `Forwarded` -You can purge objects with these characteristics using an API call to ([purge files by URL](/api/operations/zone-purge#purge-cached-content-by-url)). In the data/header section of the API call, you must include all headers and cache keys contained in the cached resource, along with their matching values. +You can purge objects with these characteristics using an API call to ([purge files by URL](/api/resources/cache/methods/purge/#purge-cached-content-by-url)). In the data/header section of the API call, you must include all headers and cache keys contained in the cached resource, along with their matching values. :::caution[Warning] diff --git a/src/content/docs/cache/how-to/purge-cache/purge-by-tags.mdx b/src/content/docs/cache/how-to/purge-cache/purge-by-tags.mdx index de0be1ae83b88a1..96a17365440ffba 100644 --- a/src/content/docs/cache/how-to/purge-cache/purge-by-tags.mdx +++ b/src/content/docs/cache/how-to/purge-cache/purge-by-tags.mdx @@ -13,7 +13,7 @@ Cache-tag purging makes multi-file purging easier because you can instantly bulk 1. Add tags to the `Cache-Tag` HTTP response header from your origin web server for your web content, such as pages, static assets, etc. 2. [Ensure your web traffic is proxied](/dns/manage-dns-records/reference/proxied-dns-records/) through Cloudflare. 3. Cloudflare associates the tags in the `Cache-Tag` HTTP header with the content being cached. -4. Use specific cache-tags to instantly purge your Cloudflare CDN cache of all content containing that cache-tag from your dashboard or [using our API](/api/operations/zone-purge). +4. Use specific cache-tags to instantly purge your Cloudflare CDN cache of all content containing that cache-tag from your dashboard or [using our API](/api/resources/cache/methods/purge/). 5. Cloudflare forces a [cache MISS](/cache/concepts/cache-responses/#miss) on content with the purged cache-tag. :::caution[Warning] @@ -56,7 +56,7 @@ When your content reaches our edge network, Cloudflare: :::note[API] -You can purge using cache-tags via the Cloudflare API. For more information, refer to the [API documentation](/api/operations/zone-purge). You can purge up to 30 cache-tags per API call and up to 250,000 cache-tags per a 24-hour period. +You can purge using cache-tags via the Cloudflare API. For more information, refer to the [API documentation](/api/resources/cache/methods/purge/). You can purge up to 30 cache-tags per API call and up to 250,000 cache-tags per a 24-hour period. ::: diff --git a/src/content/docs/cache/how-to/purge-cache/purge-cache-key.mdx b/src/content/docs/cache/how-to/purge-cache/purge-cache-key.mdx index 5db7b46ab196b2b..e618c9b6de08620 100644 --- a/src/content/docs/cache/how-to/purge-cache/purge-cache-key.mdx +++ b/src/content/docs/cache/how-to/purge-cache/purge-cache-key.mdx @@ -6,11 +6,11 @@ sidebar: --- -Instantly purge resources that use Cache Keys via the [Cloudflare API](/api/operations/zone-purge). If you use [Cloudflare's Purge by URL](/api/operations/zone-purge#purge-cached-content-by-url), include the headers and query strings that are in your custom Cache Key. +Instantly purge resources that use Cache Keys via the [Cloudflare API](/api/resources/cache/methods/purge/). If you use [Cloudflare's Purge by URL](/api/resources/cache/methods/purge/#purge-cached-content-by-url), include the headers and query strings that are in your custom Cache Key. Currently, it is not possible to purge a URL stored through Cache API that uses a custom cache key set by a Worker. Instead, use a [custom key created by Cache Rules](/cache/how-to/cache-rules/settings/#cache-key). Alternatively, purge your assets using purge everything, purge by tag, purge by host or purge by prefix. -To instantly purge by `device_type`, `geo`, or `lang` use `CF-Device-Type`, `CF-IPCountry` or `accept-language`, respectively. [Purge by Tag / Host](/api/operations/zone-purge#purge-cached-content-by-tag-host-or-prefix) and [Purge Everything](/api/operations/zone-purge#purge-all-cached-content) are not impacted by the use of custom Cache Keys. +To instantly purge by `device_type`, `geo`, or `lang` use `CF-Device-Type`, `CF-IPCountry` or `accept-language`, respectively. [Purge by Tag / Host](/api/resources/cache/methods/purge/#purge-cached-content-by-tag-host-or-prefix) and [Purge Everything](/api/resources/cache/methods/purge/#purge-all-cached-content) are not impacted by the use of custom Cache Keys. ## Purge by device type diff --git a/src/content/docs/cache/how-to/purge-cache/purge_by_prefix.mdx b/src/content/docs/cache/how-to/purge-cache/purge_by_prefix.mdx index f495d6c8e9e4155..e736aa8270cb08e 100644 --- a/src/content/docs/cache/how-to/purge-cache/purge_by_prefix.mdx +++ b/src/content/docs/cache/how-to/purge-cache/purge_by_prefix.mdx @@ -33,7 +33,7 @@ Purging by prefix is useful in different scenarios, such as: :::note[API] -You can purge prefixes via the Cloudflare API. For more information, refer to the [API documentation](/api/operations/zone-purge). You can use up to 30 prefixes per API call and make up to 30,000 purge API calls in a 24-hour period. +You can purge prefixes via the Cloudflare API. For more information, refer to the [API documentation](/api/resources/cache/methods/purge/). You can use up to 30 prefixes per API call and make up to 30,000 purge API calls in a 24-hour period. ::: @@ -59,7 +59,7 @@ There are several limitations regarding purge by prefix: * Path separators are limited to 31 for a prefix `(example.com/a/b/c/d/e/f/g/h/i/j/k/l/m…)`. * Purge requests are limited to 30 prefixes per request. -* [Purge rate-limits apply](/api/operations/zone-purge). +* [Purge rate-limits apply](/api/resources/cache/methods/purge/). * URI query strings & fragments cannot purge by prefix: * `www.example.com/foo?a=b` (query string) * `www.example.com/foo#bar` (fragment) diff --git a/src/content/docs/cache/how-to/tiered-cache.mdx b/src/content/docs/cache/how-to/tiered-cache.mdx index 56f7ebb19d214c0..7d4b2a9099931cb 100644 --- a/src/content/docs/cache/how-to/tiered-cache.mdx +++ b/src/content/docs/cache/how-to/tiered-cache.mdx @@ -114,7 +114,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/cache/regional_tiered_cache -For more API examples and configuration options for Tiered Cache, refer to the [API documentation](/api/operations/tiered-caching-get-tiered-caching-setting). +For more API examples and configuration options for Tiered Cache, refer to the [API documentation](/api/resources/argo/subresources/tiered_caching/methods/get/). :::note diff --git a/src/content/docs/calls/get-started.mdx b/src/content/docs/calls/get-started.mdx index 7dc7a96ab0d4819..7bdf51b95925e98 100644 --- a/src/content/docs/calls/get-started.mdx +++ b/src/content/docs/calls/get-started.mdx @@ -17,7 +17,7 @@ You must first [create a Cloudflare account](/fundamentals/setup/account/create- ## Create your first app Every Calls App is a separate environment, so you can make one for development, staging and production versions for your product. -Either using [Dashboard](https://dash.cloudflare.com/?to=/:account/calls), or the [API](/api/operations/calls-apps-create-a-new-app) create a Calls App. When you create a Calls App, you will get: +Either using [Dashboard](https://dash.cloudflare.com/?to=/:account/calls), or the [API](/api/resources/calls/subresources/sfu/methods/create/) create a Calls App. When you create a Calls App, you will get: * App ID * App Secret diff --git a/src/content/docs/calls/turn/generate-credentials.mdx b/src/content/docs/calls/turn/generate-credentials.mdx index 5f902d2f561c73d..b2ff149d21b9e8a 100644 --- a/src/content/docs/calls/turn/generate-credentials.mdx +++ b/src/content/docs/calls/turn/generate-credentials.mdx @@ -10,7 +10,7 @@ Cloudflare will issue TURN keys, but these keys cannot be used as credentials wi ## Create a TURN key -To create a TURN credential, you first need to create a TURN key using [Dashboard](https://dash.cloudflare.com/?to=/:account/calls), or the [API](/api/operations/calls-turn-key-create). +To create a TURN credential, you first need to create a TURN key using [Dashboard](https://dash.cloudflare.com/?to=/:account/calls), or the [API](/api/resources/calls/subresources/turn/methods/create/). You should keep your TURN key on the server side (don't share it with the browser/app). A TURN key is a long-term secret that allows you to generate unlimited, shorter lived TURN credentials for TURN clients. diff --git a/src/content/docs/china-network/reference/infrastructure.mdx b/src/content/docs/china-network/reference/infrastructure.mdx index fce174466aa3a73..e750a4df4b93562 100644 --- a/src/content/docs/china-network/reference/infrastructure.mdx +++ b/src/content/docs/china-network/reference/infrastructure.mdx @@ -14,7 +14,7 @@ For up-to-date information, refer to the [Cloudflare China Network](https://www. Cloudflare publishes a list of IP addresses for JD Cloud data centers, used by Cloudflare when connecting to the origin networks of customers to retrieve assets. These addresses are not the same IP addresses returned to website visitors as part of DNS resolution. -You can obtain the list of JD Cloud data center IP addresses via Cloudflare API. Use the [Cloudflare/JD Cloud IP Details](/api/operations/cloudflare-i-ps-cloudflare-ip-details) operation with the `networks=jdcloud` query string parameter: +You can obtain the list of JD Cloud data center IP addresses via Cloudflare API. Use the [Cloudflare/JD Cloud IP Details](/api/resources/ips/methods/list/) operation with the `networks=jdcloud` query string parameter: ```sh title="Example request" $ curl https://api.cloudflare.com/client/v4/ips?networks=jdcloud diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/api-reference.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/api-reference.mdx index 6e80ab045ec0a04..8e27512affc5b99 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/api-reference.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/api-reference.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: API reference -external_link: /api/operations/custom-hostname-for-a-zone-list-custom-hostnames +external_link: /api/resources/custom_hostnames/methods/list/ sidebar: order: 13 --- diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/create-custom-hostnames.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/create-custom-hostnames.mdx index a9e64b763786ee9..423c53f97b798cf 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/create-custom-hostnames.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/create-custom-hostnames.mdx @@ -32,7 +32,7 @@ To create a custom hostname: ## Hostnames over 64 characters -The Common Name (CN) restriction establishes a limit of 64 characters ([RFC 5280](https://www.rfc-editor.org/rfc/rfc5280.html)). If you have a hostname that exceeds this length, you can set `cloudflare_branding` to `true` when creating your custom hostnames [via API](/api/operations/custom-hostname-for-a-zone-create-custom-hostname). +The Common Name (CN) restriction establishes a limit of 64 characters ([RFC 5280](https://www.rfc-editor.org/rfc/rfc5280.html)). If you have a hostname that exceeds this length, you can set `cloudflare_branding` to `true` when creating your custom hostnames [via API](/api/resources/custom_hostnames/methods/create/). ```txt diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/custom-metadata.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/custom-metadata.mdx index 9765e6892f837f1..842a4efdbe41c09 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/custom-metadata.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/custom-metadata.mdx @@ -30,7 +30,7 @@ Please speak with your Solutions Engineer to discuss additional logic and requir ## Submitting custom metadata -You may add custom metadata to Cloudflare via the Custom Hostnames API. This data can be added via a [`PATCH` request](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname) to the specific hostname ID to set metadata for that hostname, for example: +You may add custom metadata to Cloudflare via the Custom Hostnames API. This data can be added via a [`PATCH` request](/api/resources/custom_hostnames/methods/edit/) to the specific hostname ID to set metadata for that hostname, for example: ```bash curl --request PATCH \ diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/hostname-validation/pre-validation.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/hostname-validation/pre-validation.mdx index c986012c927b75c..9b9bf44596e7f67 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/hostname-validation/pre-validation.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/hostname-validation/pre-validation.mdx @@ -35,7 +35,7 @@ If your customer cannot update their authoritative DNS, you could also use [HTTP To set up `TXT` validation: -1. When you [create a custom hostname](/api/operations/custom-hostname-for-a-zone-create-custom-hostname), save the `ownership_verification` information. +1. When you [create a custom hostname](/api/resources/custom_hostnames/methods/create/), save the `ownership_verification` information. ```json null {11-12} { @@ -73,7 +73,7 @@ When you [create a custom hostname](/cloudflare-for-platforms/cloudflare-for-saa To get and use the `ownership_verification` record: -1. Make an API call to [create a Custom Hostname](/api/operations/custom-hostname-for-a-zone-create-custom-hostname). +1. Make an API call to [create a Custom Hostname](/api/resources/custom_hostnames/methods/create/). 2. In the response, copy the `http_url` and `http_body` from the `ownership_verification_http` object: diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/hostname-validation/realtime-validation.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/hostname-validation/realtime-validation.mdx index df9d0ac76c3b9dc..630e6eae32b28b2 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/hostname-validation/realtime-validation.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/hostname-validation/realtime-validation.mdx @@ -19,7 +19,7 @@ Real-time validation methods put less burden on your customers because it does n However, it may cause some downtime since Cloudflare takes a few seconds to iterate over DNS records. This downtime also can increase - due to the increasing [validation backoff schedule](/cloudflare-for-platforms/cloudflare-for-saas/domain-support/hostname-validation/backoff-schedule/) - if your customer takes additional time to add their DNS routing record. -To minimize this downtime, you can continually send no-change [`PATCH` requests](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname) for the specific custom hostname until it validates (which resets the validation backoff schedule). +To minimize this downtime, you can continually send no-change [`PATCH` requests](/api/resources/custom_hostnames/methods/edit/) for the specific custom hostname until it validates (which resets the validation backoff schedule). To avoid any chance of downtime, use a [pre-validation method](/cloudflare-for-platforms/cloudflare-for-saas/domain-support/hostname-validation/pre-validation/) diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/remove-custom-hostnames.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/remove-custom-hostnames.mdx index 35a621c3169ad35..3da0af859e622fa 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/remove-custom-hostnames.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/domain-support/remove-custom-hostnames.mdx @@ -34,7 +34,7 @@ This is especially important if your end customers are using Cloudflare because -To delete a custom hostname and any issued certificates using the API, send a [`DELETE` request](). +To delete a custom hostname and any issued certificates using the API, send a [`DELETE` request](/api/resources/custom_hostnames/methods/delete/). diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/performance/early-hints-for-saas.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/performance/early-hints-for-saas.mdx index e861d05f43e83e4..25b84dec7080ae1 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/performance/early-hints-for-saas.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/performance/early-hints-for-saas.mdx @@ -22,7 +22,7 @@ Before you can employ Early Hints for SaaS, you need to create a custom hostname 2. Locate your Authentication Key by selecting **My Profile** > **API tokens** > **Global API Key**. -3. If you are [creating a new custom hostname](/api/operations/custom-hostname-for-a-zone-create-custom-hostname), make an API call such as the example below, specifying `"early_hints": "on"`: +3. If you are [creating a new custom hostname](/api/resources/custom_hostnames/methods/create/), make an API call such as the example below, specifying `"early_hints": "on"`: ```bash curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/custom_hostnames" \ diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/reference/troubleshooting.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/reference/troubleshooting.mdx index b0bc1b18702e6b8..b1733cfdc90891f 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/reference/troubleshooting.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/reference/troubleshooting.mdx @@ -49,7 +49,7 @@ If you encounter other 1XXX errors, refer to [Troubleshooting Cloudflare 1XXX Er ## Custom hostname in Moved status -To move a custom hostname back to an Active status, send a [PATCH request](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname) to restart the hostname validation. A Custom Hostname in a Moved status is deleted after 7 days. +To move a custom hostname back to an Active status, send a [PATCH request](/api/resources/custom_hostnames/methods/edit/) to restart the hostname validation. A Custom Hostname in a Moved status is deleted after 7 days. In some circumstances, custom hostnames can also enter a **Moved** state if your customer changes their DNS records pointing to your SaaS service. For more details, refer to [Remove custom hostnames](/cloudflare-for-platforms/cloudflare-for-saas/domain-support/remove-custom-hostnames/). @@ -81,7 +81,7 @@ As Let's Encrypt - one of the [certificate authorities (CAs)](/ssl/reference/cer Consider the following solutions: -- Use the [Edit Custom Hostname](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname) endpoint to set the `certificate_authority` parameter to an empty string (`""`): this sets the custom hostname certificate to "default CA", leaving the choice up to Cloudflare. Cloudflare will always attempt to issue the certificate from a more compatible CA, such as [Google Trust Services](/ssl/reference/certificate-authorities/#google-trust-services), and will only fall back to using Let’s Encrypt if there is a [CAA record](/ssl/edge-certificates/caa-records/) in place that blocks Google from issuing a certificate. +- Use the [Edit Custom Hostname](/api/resources/custom_hostnames/methods/edit/) endpoint to set the `certificate_authority` parameter to an empty string (`""`): this sets the custom hostname certificate to "default CA", leaving the choice up to Cloudflare. Cloudflare will always attempt to issue the certificate from a more compatible CA, such as [Google Trust Services](/ssl/reference/certificate-authorities/#google-trust-services), and will only fall back to using Let’s Encrypt if there is a [CAA record](/ssl/edge-certificates/caa-records/) in place that blocks Google from issuing a certificate.
@@ -103,7 +103,7 @@ Consider the following solutions:
-- Use the [Edit Custom Hostname](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname) endpoint to set the `certificate_authority` parameter to `google`: this sets Google Trust Services as the CA for your custom hostnames. +- Use the [Edit Custom Hostname](/api/resources/custom_hostnames/methods/edit/) endpoint to set the `certificate_authority` parameter to `google`: this sets Google Trust Services as the CA for your custom hostnames. - If you are using a custom certificate for your custom hostname, refer to the [custom certificates troubleshooting](/ssl/edge-certificates/custom-certificates/troubleshooting/#lets-encrypt-chain-update). ## Custom hostname fails to verify because the zone is held diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/reference/versioning.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/reference/versioning.mdx index f3364e80c877297..86b9f8858f43438 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/reference/versioning.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/reference/versioning.mdx @@ -27,11 +27,11 @@ Using a [TXT](#dns-txt-record) or [HTTP](#http-token) validation method helps yo #### DNS TXT Record -When creating a Custom Hostname with the TXT method through the [API](/api/operations/custom-hostname-for-a-zone-create-custom-hostname), a TXT ownership\_verification record is provided for your customer to add to their DNS for the ownership validation check. When the TXT record is added, the Custom Hostname will be marked as **Active** in the Cloudflare SSL/TLS app under the Custom Hostnames tab. +When creating a Custom Hostname with the TXT method through the [API](/api/resources/custom_hostnames/methods/create/), a TXT ownership\_verification record is provided for your customer to add to their DNS for the ownership validation check. When the TXT record is added, the Custom Hostname will be marked as **Active** in the Cloudflare SSL/TLS app under the Custom Hostnames tab. #### HTTP Token -When creating a Custom Hostname with the HTTP through the [API](/api/operations/custom-hostname-for-a-zone-create-custom-hostname), an HTTP ownership\_verification token is provided. HTTP verification is used mainly by organizations with a large deployed base of custom domains with HTTPS support. Serving the HTTP token from your origin web server allows hostname verification before proxying domain traffic through Cloudflare. +When creating a Custom Hostname with the HTTP through the [API](/api/resources/custom_hostnames/methods/create/), an HTTP ownership\_verification token is provided. HTTP verification is used mainly by organizations with a large deployed base of custom domains with HTTPS support. Serving the HTTP token from your origin web server allows hostname verification before proxying domain traffic through Cloudflare. Cloudflare sends GET requests to the http\_url using `User-Agent: Cloudflare Custom Hostname Verification`. diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/custom-certificates/certificate-signing-requests.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/custom-certificates/certificate-signing-requests.mdx index 22ed60af7bcd10a..719850cd8b81564 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/custom-certificates/certificate-signing-requests.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/custom-certificates/certificate-signing-requests.mdx @@ -119,7 +119,7 @@ EOF )) ``` -With the request body built, [create the custom hostname](/api/operations/custom-hostname-for-a-zone-create-custom-hostname) with the supplied custom certificate. If you intend to use the certificate with multiple hostnames, make multiple API calls replacing the `hostname` field. +With the request body built, [create the custom hostname](/api/resources/custom_hostnames/methods/create/) with the supplied custom certificate. If you intend to use the certificate with multiple hostnames, make multiple API calls replacing the `hostname` field. *** diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/custom-certificates/uploading-certificates.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/custom-certificates/uploading-certificates.mdx index 470fb838440b18b..47c6174f7ef44e0 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/custom-certificates/uploading-certificates.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/custom-certificates/uploading-certificates.mdx @@ -54,7 +54,7 @@ EOF #### 2. Upload your certificate and key -Use a [POST request](/api/operations/custom-hostname-for-a-zone-create-custom-hostname) to upload your certificate and key. +Use a [POST request](/api/resources/custom_hostnames/methods/create/) to upload your certificate and key. The serial number returned is unique to the issuer, but not globally unique. Additionally, it is returned as a string, not an integer. @@ -64,4 +64,4 @@ The serial number returned is unique to the issuer, but not globally unique. Add If you want to switch from maintaining a custom certificate to using one issued by Cloudflare, you can migrate that certificate with zero downtime. -Send a [PATCH request](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname) to your custom hostname with a value for the DCV `method`. As soon as the [certificate is validated](/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/) and the [hostname is validated](/cloudflare-for-platforms/cloudflare-for-saas/domain-support/hostname-validation/), Cloudflare will remove the old custom certificate and begin serving the new one. +Send a [PATCH request](/api/resources/custom_hostnames/methods/edit/) to your custom hostname with a value for the DCV `method`. As soon as the [certificate is validated](/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/) and the [hostname is validated](/cloudflare-for-platforms/cloudflare-for-saas/domain-support/hostname-validation/), Cloudflare will remove the old custom certificate and begin serving the new one. diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/enforce-mtls.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/enforce-mtls.mdx index 196bc17799e9022..71f7d9ac0ff4576 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/enforce-mtls.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/enforce-mtls.mdx @@ -51,7 +51,7 @@ For security and regulatory reasons, you may want to only allow connections from
-Refer to [Edit zone setting](/api/operations/zone-settings-edit-single-setting) and use `ciphers` as the setting name in the URI path. +Refer to [Edit zone setting](/api/resources/zones/subresources/settings/methods/edit/) and use `ciphers` as the setting name in the URI path.
@@ -59,7 +59,7 @@ Refer to [Edit zone setting](/api/operations/zone-settings-edit-single-setting)
-Refer to [SSL properties of a custom hostname](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname). +Refer to [SSL properties of a custom hostname](/api/resources/custom_hostnames/methods/edit/). diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/cname.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/cname.mdx index 62f894a6e6b352f..36f13168372b8d2 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/cname.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/cname.mdx @@ -21,7 +21,7 @@ With the [upcoming change](/ssl/reference/migration-guides/digicert-update/custo ::: -Since this method is only available using the API, you need to make a [POST request](/api/operations/custom-hostname-for-a-zone-create-custom-hostname) and set a `"method":"cname"` parameter. +Since this method is only available using the API, you need to make a [POST request](/api/resources/custom_hostnames/methods/create/) and set a `"method":"cname"` parameter. Within the `ssl` object in the response, refer to the values present in the `validation_records` array. Each record will contain a property for `cname` and `cname_target` (you can also access these values in the dashboard by clicking that specific hostname certificate). Provide these values to your customer so they can add a CNAME record at their authoritative DNS provider. diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/email.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/email.mdx index 7cb3dcba640a027..1cedaff5d7de8be 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/email.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/email.mdx @@ -23,7 +23,7 @@ With the [change](/ssl/reference/migration-guides/digicert-update/custom-hostnam
-* [**API**](/api/operations/custom-hostname-for-a-zone-custom-hostname-details): Within the `ssl` object, refer to the values present in the `validation_records` array (specifically `emails`). +* [**API**](/api/resources/custom_hostnames/methods/get/): Within the `ssl` object, refer to the values present in the `validation_records` array (specifically `emails`). * **Dashboard**: When viewing an individual certificate at **SSL/TLS** > **Custom Hostnames**, refer to the value for **Certificate validation email recipients**. diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/http.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/http.mdx index 3abad3f65880b24..64b14333199441c 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/http.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/http.mdx @@ -59,7 +59,7 @@ If you would like to complete the issuance process before asking your customer t
-* [**API**](/api/operations/custom-hostname-for-a-zone-custom-hostname-details): Within the `ssl` object, store the values present in the `validation_records` array (specifically `http_url` and `http_body`). +* [**API**](/api/resources/custom_hostnames/methods/get/): Within the `ssl` object, store the values present in the `validation_records` array (specifically `http_url` and `http_body`). * **Dashboard**: When viewing an individual certificate at **SSL/TLS** > **Custom Hostnames**, refer to the values for **Certificate validation request** and **Certificate validation response**. At your origin, make the `http_body` available in a TXT record at the path specified in `http_url`. This path should also be publicly accessible to anyone on the Internet so your CA can access it. diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/troubleshooting.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/troubleshooting.mdx index de60b10c5592c46..32302eccb75a1c6 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/troubleshooting.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/troubleshooting.mdx @@ -51,13 +51,13 @@ If a certificate issuance times out, the error message will indicate where the t * Timed Out (Deployment) * Timed Out (Deletion) -To fix this error, send a [PATCH request](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname) through the API or select **Refresh** for the specific custom hostname in the dashboard. Please make sure that the `--data` field is not empty in your request. +To fix this error, send a [PATCH request](/api/resources/custom_hostnames/methods/edit/) through the API or select **Refresh** for the specific custom hostname in the dashboard. Please make sure that the `--data` field is not empty in your request. If these return an error, delete and recreate the custom hostname. *** ## Immediate validation checks -You can send a [PATCH request](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname) to request an immediate validation check on any certificate. The PATCH data only needs include the same `ssl` object as the original request. +You can send a [PATCH request](/api/resources/custom_hostnames/methods/edit/) to request an immediate validation check on any certificate. The PATCH data only needs include the same `ssl` object as the original request. *** diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/waf-for-saas/managed-rulesets.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/waf-for-saas/managed-rulesets.mdx index 5cc6b4d12329053..51f67bc431cf6a2 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/waf-for-saas/managed-rulesets.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/security/waf-for-saas/managed-rulesets.mdx @@ -21,7 +21,7 @@ If you would like to deploy a managed ruleset at the account level, refer to the Ensure you have reviewed [Get Started with Cloudflare for SaaS](/cloudflare-for-platforms/cloudflare-for-saas/start/getting-started/) and familiarize yourself with [WAF for SaaS](/cloudflare-for-platforms/cloudflare-for-saas/security/waf-for-saas/). -Customers can automate the [custom metadata](/cloudflare-for-platforms/cloudflare-for-saas/domain-support/custom-metadata/) tagging by adding it to the custom hostnames at creation. For more information on tagging a custom hostname with custom metadata, refer to the [API documentation](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname). +Customers can automate the [custom metadata](/cloudflare-for-platforms/cloudflare-for-saas/domain-support/custom-metadata/) tagging by adding it to the custom hostnames at creation. For more information on tagging a custom hostname with custom metadata, refer to the [API documentation](/api/resources/custom_hostnames/methods/edit/). *** diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/start/advanced-settings/custom-origin.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/start/advanced-settings/custom-origin.mdx index feb3d74c1fffdb3..2fc99d5f22e669b 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/start/advanced-settings/custom-origin.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/start/advanced-settings/custom-origin.mdx @@ -22,7 +22,7 @@ To use a custom origin server, you need to meet the following requirements: ## Use a custom origin -To use a custom origin, select that option when [creating a new custom hostname](/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/) in the dashboard or include the `"custom_origin_server": your_custom_origin_server` parameter when using the API [POST command](/api/operations/custom-hostname-for-a-zone-create-custom-hostname). +To use a custom origin, select that option when [creating a new custom hostname](/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/) in the dashboard or include the `"custom_origin_server": your_custom_origin_server` parameter when using the API [POST command](/api/resources/custom_hostnames/methods/create/). ## SNI rewrites @@ -65,7 +65,7 @@ Choose how your custom hostname populates the SNI value with SNI rewrites: To set an SNI rewrite in the dashboard, choose your preferred option from **Origin SNI value** when [creating a custom hostname](/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/). -To set an SNI rewrite via the API, set the `custom_origin_sni` parameter when [creating a custom hostname](/api/operations/custom-hostname-for-a-zone-create-custom-hostname): +To set an SNI rewrite via the API, set the `custom_origin_sni` parameter when [creating a custom hostname](/api/resources/custom_hostnames/methods/create/): * **Custom origin name** (default): Applies if you do not set the parameter * **Host header**: Specify `":request_host_header:"` diff --git a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/start/common-api-calls.mdx b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/start/common-api-calls.mdx index 6e1e43c857a5654..61c1a63a5f6dc27 100644 --- a/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/start/common-api-calls.mdx +++ b/src/content/docs/cloudflare-for-platforms/cloudflare-for-saas/start/common-api-calls.mdx @@ -14,16 +14,16 @@ As a SaaS provider, you may want to configure and manage Cloudflare for SaaS [vi | Endpoint | Notes | | -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| [List custom hostnames](/api/operations/custom-hostname-for-a-zone-list-custom-hostnames) | Use the `page` parameter to pull additional pages. Add a `hostname` parameter to search for specific hostnames. | -| [Create custom hostname](/api/operations/custom-hostname-for-a-zone-create-custom-hostname) | In the `validation_records` object of the response, use the `txt_name` and `txt_record` listed to validate the custom hostname. | -| [Custom hostname details](/api/operations/custom-hostname-for-a-zone-custom-hostname-details) | | -| [Edit custom hostname](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname) | When sent with an `ssl` object that matches the existing value, indicates that hostname should restart domain control validation (DCV). | -| [Delete custom hostname](/api/operations/custom-hostname-for-a-zone-delete-custom-hostname-\(-and-any-issued-ssl-certificates\)) | Also deletes any associated SSL/TLS certificates. | +| [List custom hostnames](/api/resources/custom_hostnames/methods/list/) | Use the `page` parameter to pull additional pages. Add a `hostname` parameter to search for specific hostnames. | +| [Create custom hostname](/api/resources/custom_hostnames/methods/create/) | In the `validation_records` object of the response, use the `txt_name` and `txt_record` listed to validate the custom hostname. | +| [Custom hostname details](/api/resources/custom_hostnames/methods/get/) | | +| [Edit custom hostname](/api/resources/custom_hostnames/methods/edit/) | When sent with an `ssl` object that matches the existing value, indicates that hostname should restart domain control validation (DCV). | +| [Delete custom hostname](/api/resources/custom_hostnames/methods/delete/) | Also deletes any associated SSL/TLS certificates. | ## Fallback origins Our API includes the following endpoints related to the [fallback origin](/cloudflare-for-platforms/cloudflare-for-saas/start/getting-started/#1-create-fallback-origin) of a custom hostname: -* [Get fallback origin](/api/operations/custom-hostname-fallback-origin-for-a-zone-get-fallback-origin-for-custom-hostnames) -* [Update fallback origin](/api/operations/custom-hostname-fallback-origin-for-a-zone-update-fallback-origin-for-custom-hostnames) -* [Remove fallback origin](/api/operations/custom-hostname-fallback-origin-for-a-zone-delete-fallback-origin-for-custom-hostnames) +* [Get fallback origin](/api/resources/custom_hostnames/subresources/fallback_origin/methods/get/) +* [Update fallback origin](/api/resources/custom_hostnames/subresources/fallback_origin/methods/update/) +* [Remove fallback origin](/api/resources/custom_hostnames/subresources/fallback_origin/methods/delete/) diff --git a/src/content/docs/cloudflare-for-platforms/workers-for-platforms/get-started/user-workers.mdx b/src/content/docs/cloudflare-for-platforms/workers-for-platforms/get-started/user-workers.mdx index d2009cda116574f..90e4541bf48514a 100644 --- a/src/content/docs/cloudflare-for-platforms/workers-for-platforms/get-started/user-workers.mdx +++ b/src/content/docs/cloudflare-for-platforms/workers-for-platforms/get-started/user-workers.mdx @@ -26,10 +26,10 @@ For simplicity, start with wrangler when [getting started](/cloudflare-for-platf ### Upload user Workers via the API -Since you will be deploying Workers on behalf of your users, you will likely want to use the [Workers for Platforms script upload APIs](/api/operations/namespace-worker-put-script-content) directly instead of Wrangler to have more control over the upload process. The Workers for Platforms script upload API is the same as the [Worker upload API](/api/operations/worker-script-upload-worker-module), but it will upload the Worker to a [dispatch namespace](/cloudflare-for-platforms/workers-for-platforms/reference/how-workers-for-platforms-works/#dispatch-namespace) instead of to your account directly. +Since you will be deploying Workers on behalf of your users, you will likely want to use the [Workers for Platforms script upload APIs](/api/resources/workers_for_platforms/subresources/dispatch/subresources/namespaces/subresources/scripts/subresources/content/methods/update/) directly instead of Wrangler to have more control over the upload process. The Workers for Platforms script upload API is the same as the [Worker upload API](/api/resources/workers/subresources/scripts/methods/update/), but it will upload the Worker to a [dispatch namespace](/cloudflare-for-platforms/workers-for-platforms/reference/how-workers-for-platforms-works/#dispatch-namespace) instead of to your account directly. ## Bindings You can use any Workers [bindings](/workers/runtime-apis/bindings/) with the dynamic dispatch Worker or any user Workers. -Bindings for your user Workers can be defined on [multipart script uploads](/api/operations/namespace-worker-put-script-content) in the [metadata](/workers/configuration/multipart-upload-metadata/) part. +Bindings for your user Workers can be defined on [multipart script uploads](/api/resources/workers_for_platforms/subresources/dispatch/subresources/namespaces/subresources/scripts/subresources/content/methods/update/) in the [metadata](/workers/configuration/multipart-upload-metadata/) part. diff --git a/src/content/docs/cloudflare-for-platforms/workers-for-platforms/wfp-api.mdx b/src/content/docs/cloudflare-for-platforms/workers-for-platforms/wfp-api.mdx index 864efb2e1d49e6d..dda564299695600 100644 --- a/src/content/docs/cloudflare-for-platforms/workers-for-platforms/wfp-api.mdx +++ b/src/content/docs/cloudflare-for-platforms/workers-for-platforms/wfp-api.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: WFP REST API -external_link: /api/operations/namespace-worker-list +external_link: /api/resources/workers_for_platforms/subresources/dispatch/subresources/namespaces/methods/list/ sidebar: order: 20 diff --git a/src/content/docs/cloudflare-one/applications/configure-apps/dash-sso-apps.mdx b/src/content/docs/cloudflare-one/applications/configure-apps/dash-sso-apps.mdx index d68c54846fb6947..0bd6d38b728ecae 100644 --- a/src/content/docs/cloudflare-one/applications/configure-apps/dash-sso-apps.mdx +++ b/src/content/docs/cloudflare-one/applications/configure-apps/dash-sso-apps.mdx @@ -69,7 +69,7 @@ This section describes how to restore access to the Cloudflare dashboard in case If there is an issue with your SSO IdP provider, you can add an alternate IdP using the API. The following example shows how to add [Cloudflare One-time PIN](/cloudflare-one/identity/one-time-pin/) as a login method: -1. [Add](/api/operations/access-identity-providers-add-an-access-identity-provider) one-time PIN login: +1. [Add](/api/resources/zero_trust/subresources/identity_providers/methods/create/) one-time PIN login: ```bash title="cURL command" curl 'https://api.cloudflare.com/client/v4/accounts/{account_id}/access/identity_providers' \ @@ -82,7 +82,7 @@ curl 'https://api.cloudflare.com/client/v4/accounts/{account_id}/access/identity }' ``` -2. [Get](/api/operations/access-applications-list-access-applications) the `id` of the `dash_sso` Access application. You can use [`jq`](https://jqlang.github.io/jq/download/) to quickly find the correct application: +2. [Get](/api/resources/zero_trust/subresources/access/subresources/applications/methods/list/) the `id` of the `dash_sso` Access application. You can use [`jq`](https://jqlang.github.io/jq/download/) to quickly find the correct application: ```bash title="cURL command" curl 'https://api.cloudflare.com/client/v4/accounts/{account_id}/access/apps' \ @@ -101,7 +101,7 @@ curl 'https://api.cloudflare.com/client/v4/accounts/{account_id}/access/apps' \ } ``` -3. Using the `id` obtained above, [update](/api/operations/access-applications-update-an-access-application) **SSO App** to accept all identity providers: +3. Using the `id` obtained above, [update](/api/resources/zero_trust/subresources/access/subresources/applications/methods/update/) **SSO App** to accept all identity providers: ```bash title="cURL command" curl --request PUT \ diff --git a/src/content/docs/cloudflare-one/connections/connect-devices/agentless/pac-files.mdx b/src/content/docs/cloudflare-one/connections/connect-devices/agentless/pac-files.mdx index d298a0fc6810034..dba1aafe312a45d 100644 --- a/src/content/docs/cloudflare-one/connections/connect-devices/agentless/pac-files.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-devices/agentless/pac-files.mdx @@ -65,7 +65,7 @@ https://.proxy.cloudflare-gateway.com -1. [Create a proxy endpoint](/api/operations/zero-trust-gateway-proxy-endpoints-create-proxy-endpoint) with the following call: +1. [Create a proxy endpoint](/api/resources/zero_trust/subresources/gateway/subresources/proxy_endpoints/methods/create/) with the following call: ```bash curl https://api.cloudflare.com/client/v4/accounts//gateway/proxy_endpoints \ diff --git a/src/content/docs/cloudflare-one/connections/connect-devices/user-side-certificates/custom-certificate.mdx b/src/content/docs/cloudflare-one/connections/connect-devices/user-side-certificates/custom-certificate.mdx index 5d77a3fd817589f..3fdfecc12019678 100644 --- a/src/content/docs/cloudflare-one/connections/connect-devices/user-side-certificates/custom-certificate.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-devices/user-side-certificates/custom-certificate.mdx @@ -79,7 +79,7 @@ openssl x509 -in .pem -text 1. Verify that the certificate is installed on your devices. 2. - 3. Deploy the certificate in Gateway using the certificate's UUID with the [Patch Zero Trust account configuration endpoint](/api/operations/zero-trust-accounts-patch-zero-trust-account-configuration). + 3. Deploy the certificate in Gateway using the certificate's UUID with the [Patch Zero Trust account configuration endpoint](/api/resources/zero_trust/subresources/gateway/subresources/configurations/methods/edit/). ```bash {10} curl --request PATCH \ "https://api.cloudflare.com/client/v4/accounts/{account_id}/gateway/configuration" \ @@ -122,7 +122,7 @@ openssl x509 -in .pem -text "updated_at": "2014-01-01T05:20:00.12345Z" } ``` - 4. Activate the certificate for use in inspection with the [Activate a Zero Trust certificate endpoint](/api/operations/zero-trust-certificates-activate-zero-trust-certificate). + 4. Activate the certificate for use in inspection with the [Activate a Zero Trust certificate endpoint](/api/resources/zero_trust/subresources/gateway/subresources/certificates/methods/activate/). ```bash curl --request POST \ "https://api.cloudflare.com/client/v4/accounts/{account_id}/gateway/certificates/{certificate_id}/activate" \ diff --git a/src/content/docs/cloudflare-one/connections/connect-devices/warp/configure-warp/device-profiles.mdx b/src/content/docs/cloudflare-one/connections/connect-devices/warp/configure-warp/device-profiles.mdx index fb635cf3d6aee2b..7722ffbc2c8f1ee 100644 --- a/src/content/docs/cloudflare-one/connections/connect-devices/warp/configure-warp/device-profiles.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-devices/warp/configure-warp/device-profiles.mdx @@ -32,7 +32,7 @@ Your profile will appear in the **Profile settings** list. You can rearrange the -Send a `POST` request to the [Devices endpoint](/api/operations/devices-create-device-settings-policy): +Send a `POST` request to the [Devices endpoint](/api/resources/zero_trust/subresources/devices/subresources/policies/subresources/custom/methods/create/): ```bash curl https://api.cloudflare.com/client/v4/accounts/{account_id}/devices/policy \ diff --git a/src/content/docs/cloudflare-one/connections/connect-networks/configure-tunnels/remote-management.mdx b/src/content/docs/cloudflare-one/connections/connect-networks/configure-tunnels/remote-management.mdx index 55d147a40641cc2..351760c2d4b4314 100644 --- a/src/content/docs/cloudflare-one/connections/connect-networks/configure-tunnels/remote-management.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-networks/configure-tunnels/remote-management.mdx @@ -164,7 +164,7 @@ To get the token for a remotely-managed tunnel: -Make a `GET` request to the [Cloudflare Tunnel token](/api/operations/cloudflare-tunnel-get-a-cloudflare-tunnel-token) endpoint: +Make a `GET` request to the [Cloudflare Tunnel token](/api/resources/zero_trust/subresources/tunnels/methods/get/-token) endpoint: ```sh curl https://api.cloudflare.com/client/v4/accounts/{account_id}/cfd_tunnel/{tunnel_id}/token \ @@ -210,7 +210,7 @@ To rotate a tunnel token: AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg= ``` - 2. Make a `PATCH` request to the [Cloudflare Tunnel](/api/operations/cloudflare-tunnel-update-a-cloudflare-tunnel) endpoint: + 2. Make a `PATCH` request to the [Cloudflare Tunnel](/api/resources/zero_trust/subresources/tunnels/methods/edit/) endpoint: ```sh curl --request PATCH \ https://api.cloudflare.com/client/v4/accounts/{account_id}/cfd_tunnel/{tunnel_id} \ @@ -281,7 +281,7 @@ The tunnel token is now fully rotated. The old token is no longer in use. If your tunnel token is compromised, we recommend taking the following steps: 1. Refresh the token using the dashboard or API. Refer to Step 1 of [Rotate a token without service disruption](#rotate-a-token-without-service-disruption). -2. [Delete all connections](/api/operations/cloudflare-tunnel-clean-up-cloudflare-tunnel-connections) between `cloudflared` and Cloudflare: +2. [Delete all connections](/api/resources/zero_trust/subresources/tunnels/subresources/connections/methods/delete/) between `cloudflared` and Cloudflare: ```sh curl --request DELETE \ https://api.cloudflare.com/client/v4/accounts/{account_id}/cfd_tunnel/{tunnel_id}/connections \ diff --git a/src/content/docs/cloudflare-one/connections/connect-networks/configure-tunnels/tunnel-run-parameters.mdx b/src/content/docs/cloudflare-one/connections/connect-networks/configure-tunnels/tunnel-run-parameters.mdx index edb319396df9bff..6c7e115928d1581 100644 --- a/src/content/docs/cloudflare-one/connections/connect-networks/configure-tunnels/tunnel-run-parameters.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-networks/configure-tunnels/tunnel-run-parameters.mdx @@ -22,7 +22,7 @@ By default, `cloudflared` will periodically check for updates and restart with t :::note -For locally-managed tunnels only. +For locally-managed tunnels only. ::: | Syntax | Default | @@ -97,7 +97,7 @@ Disables automatic `cloudflared` updates. See also: [`autoupdate-freq`](#autoupd :::note -For locally-managed tunnels only. +For locally-managed tunnels only. ::: | Syntax | Default | Environment Variable | @@ -152,11 +152,11 @@ Specifies custom tags used to identify this tunnel. Multiple tags may be specifi :::note -For remotely-managed tunnels only. +For remotely-managed tunnels only. ::: | Syntax | Environment Variable | | ----------------------------------------------- | -------------------- | | `cloudflared tunnel run --token ` | `TUNNEL_TOKEN` | -Associates the `cloudflared` instance with a specific tunnel. The tunnel's token is shown in the dashboard when you first [create the tunnel](/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/). You can also retrieve the token using the [API](/api/operations/cloudflare-tunnel-get-a-cloudflare-tunnel-token). +Associates the `cloudflared` instance with a specific tunnel. The tunnel's token is shown in the dashboard when you first [create the tunnel](/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/). You can also retrieve the token using the [API](/api/resources/zero_trust/subresources/tunnels/subresources/token/methods/get/). diff --git a/src/content/docs/cloudflare-one/connections/connect-networks/get-started/tunnel-useful-terms.mdx b/src/content/docs/cloudflare-one/connections/connect-networks/get-started/tunnel-useful-terms.mdx index a652509d3435812..0ccef5a20767a40 100644 --- a/src/content/docs/cloudflare-one/connections/connect-networks/get-started/tunnel-useful-terms.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-networks/get-started/tunnel-useful-terms.mdx @@ -29,7 +29,7 @@ You can create and configure a tunnel once and run that tunnel through multiple, ## Remotely-managed tunnel -A remotely-managed tunnel is a [tunnel](#tunnel) that was created in [Zero Trust](https://one.dash.cloudflare.com/) under **Networks** > **Tunnels**. Tunnel configuration is stored in Cloudflare, which allows you to manage the tunnel from the dashboard or using the [API](/api/operations/cloudflare-tunnel-configuration-get-configuration). +A remotely-managed tunnel is a [tunnel](#tunnel) that was created in [Zero Trust](https://one.dash.cloudflare.com/) under **Networks** > **Tunnels**. Tunnel configuration is stored in Cloudflare, which allows you to manage the tunnel from the dashboard or using the [API](/api/resources/zero_trust/subresources/tunnels/subresources/configurations/methods/get/). ## Locally-managed tunnel diff --git a/src/content/docs/cloudflare-one/connections/connect-networks/use-cases/ssh/ssh-infrastructure-access.mdx b/src/content/docs/cloudflare-one/connections/connect-networks/use-cases/ssh/ssh-infrastructure-access.mdx index 5fe57bc3f49dcb9..83ceda80284d173 100644 --- a/src/content/docs/cloudflare-one/connections/connect-networks/use-cases/ssh/ssh-infrastructure-access.mdx +++ b/src/content/docs/cloudflare-one/connections/connect-networks/use-cases/ssh/ssh-infrastructure-access.mdx @@ -108,7 +108,7 @@ Cloudflare will stop logging SSH commands to your targets, as well as any comman -To delete the SSH encryption public key using the [API](/api/operations/zero-trust-update-audit-ssh-settings): +To delete the SSH encryption public key using the [API](/api/resources/zero_trust/subresources/gateway/subresources/audit_ssh_settings/methods/update/): ```sh curl --request PUT https://api.cloudflare.com/client/v4/accounts/{account_id}/gateway/audit_ssh_settings \ diff --git a/src/content/docs/cloudflare-one/identity/authorization-cookie/validating-json.mdx b/src/content/docs/cloudflare-one/identity/authorization-cookie/validating-json.mdx index abdae1236f54aef..250346f1b032fd1 100644 --- a/src/content/docs/cloudflare-one/identity/authorization-cookie/validating-json.mdx +++ b/src/content/docs/cloudflare-one/identity/authorization-cookie/validating-json.mdx @@ -18,7 +18,7 @@ The public key for the signing key pair is located at `https://. By default, Access rotates the signing key every 6 weeks. This means you will need to programmatically or manually update your keys as they rotate. Previous keys remain valid for 7 days after rotation to allow time for you to make the update. -You can also manually rotate the key using the [API](/api/operations/access-key-configuration-rotate-access-keys). This can be done for testing or security purposes. +You can also manually rotate the key using the [API](/api/resources/zero_trust/subresources/access/subresources/keys/methods/rotate/). This can be done for testing or security purposes. As shown in the example below, `https://.cloudflareaccess.com/cdn-cgi/access/certs` contains two public keys: the current key used to sign all new tokens, and the previous key that has been rotated out. diff --git a/src/content/docs/cloudflare-one/identity/devices/index.mdx b/src/content/docs/cloudflare-one/identity/devices/index.mdx index ac23873a73fd7ed..2cf298d04f93ee1 100644 --- a/src/content/docs/cloudflare-one/identity/devices/index.mdx +++ b/src/content/docs/cloudflare-one/identity/devices/index.mdx @@ -57,14 +57,14 @@ A --> G[Service provider] --interval--> C ### Expiration -By default, the posture result on Cloudflare remains valid until it is overwritten by new data. You can specify an `expiration` time using our [API](/api/operations/device-posture-rules-update-device-posture-rule). We recommend setting the expiration to be longer than the [polling frequency](#polling-frequency). +By default, the posture result on Cloudflare remains valid until it is overwritten by new data. You can specify an `expiration` time using our [API](/api/resources/zero_trust/subresources/devices/subresources/posture/methods/update/). We recommend setting the expiration to be longer than the [polling frequency](#polling-frequency). ### Polling frequency #### WARP client checks -By default, the WARP client polls the device for status changes every five minutes. To modify the polling frequency, use the API to update the [`schedule`](/api/operations/device-posture-rules-update-device-posture-rule) parameter. +By default, the WARP client polls the device for status changes every five minutes. To modify the polling frequency, use the API to update the [`schedule`](/api/resources/zero_trust/subresources/devices/subresources/posture/methods/update/) parameter. #### Service provider checks -When setting up a [service-to-service integration](/cloudflare-one/identity/devices/service-providers/), you will choose a polling frequency to determine how often Cloudflare will query the third-party API. To set the polling frequency via the API, use the [`interval`](/api/operations/device-posture-integrations-update-device-posture-integration) parameter. +When setting up a [service-to-service integration](/cloudflare-one/identity/devices/service-providers/), you will choose a polling frequency to determine how often Cloudflare will query the third-party API. To set the polling frequency via the API, use the [`interval`](/api/resources/zero_trust/subresources/devices/subresources/posture/subresources/integrations/methods/edit/) parameter. diff --git a/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/corp-device.mdx b/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/corp-device.mdx index 1cb195e762818b7..04b67390152950f 100644 --- a/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/corp-device.mdx +++ b/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/corp-device.mdx @@ -20,7 +20,7 @@ To create rules based on device serial numbers, you first need to create a [Gate 1. In [Zero Trust](https://one.dash.cloudflare.com), go to **My Team** > **Lists**. -2. Select **Create manual list** or **Upload CSV**. For larger teams, we recommend uploading a CSV or using Cloudflare's [API endpoint](/api/operations/zero-trust-lists-list-zero-trust-lists). +2. Select **Create manual list** or **Upload CSV**. For larger teams, we recommend uploading a CSV or using Cloudflare's [API endpoint](/api/resources/zero_trust/subresources/gateway/subresources/lists/methods/list/). 3. Give your list a descriptive name, as this name will appear when configuring your policies. diff --git a/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/device-uuid.mdx b/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/device-uuid.mdx index bfdace6ad79bf20..d2c5366e13c03bc 100644 --- a/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/device-uuid.mdx +++ b/src/content/docs/cloudflare-one/identity/devices/warp-client-checks/device-uuid.mdx @@ -28,7 +28,7 @@ To create rules based on device UUIDs, you first need to create a [Gateway List] 1. In [Zero Trust](https://one.dash.cloudflare.com), go to **My Team** > **Lists**. -2. Select **Create manual list** or **Upload CSV**. For larger teams, we recommend uploading a CSV or using Cloudflare's [API endpoint](/api/operations/zero-trust-lists-list-zero-trust-lists). +2. Select **Create manual list** or **Upload CSV**. For larger teams, we recommend uploading a CSV or using Cloudflare's [API endpoint](/api/resources/zero_trust/subresources/gateway/subresources/lists/methods/list/). 3. Give your list a descriptive name, as this name will appear when configuring your policies. diff --git a/src/content/docs/cloudflare-one/identity/idp-integration/entra-id.mdx b/src/content/docs/cloudflare-one/identity/idp-integration/entra-id.mdx index 5ca91654cee3971..39e82e01503008c 100644 --- a/src/content/docs/cloudflare-one/identity/idp-integration/entra-id.mdx +++ b/src/content/docs/cloudflare-one/identity/idp-integration/entra-id.mdx @@ -206,7 +206,7 @@ Access and Gateway policies for an Entra group will also apply to all [nested gr ## Force user interaction during WARP reauthentication -You can require users to re-enter their credentials into Entra ID whenever they [re-authenticate their WARP session](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-sessions/). To configure this setting, make a [`PUT` request](/api/operations/access-identity-providers-update-an-access-identity-provider) and set the `prompt` parameter to either `login` or `select_account`. +You can require users to re-enter their credentials into Entra ID whenever they [re-authenticate their WARP session](/cloudflare-one/connections/connect-devices/warp/configure-warp/warp-sessions/). To configure this setting, make a [`PUT` request](/api/resources/zero_trust/subresources/identity_providers/methods/update/) and set the `prompt` parameter to either `login` or `select_account`. ## Example API Configuration diff --git a/src/content/docs/cloudflare-one/identity/idp-integration/generic-saml.mdx b/src/content/docs/cloudflare-one/identity/idp-integration/generic-saml.mdx index fe1131322deb904..9090bfa40ec184c 100644 --- a/src/content/docs/cloudflare-one/identity/idp-integration/generic-saml.mdx +++ b/src/content/docs/cloudflare-one/identity/idp-integration/generic-saml.mdx @@ -37,7 +37,7 @@ The typical setup requirements are: If your identity provider supports metadata file configuration, you can use the default or identity provider specific metadata endpoint: - **Default:** `https://.cloudflareaccess.com/cdn-cgi/access/saml-metadata` -- **Identity provider specific:** `https://.cloudflareaccess.com/cdn-cgi/access//saml-metadata`, where `` is the `id` value obtained from [List Access identity providers](/api/operations/access-identity-providers-list-access-identity-providers). Use this endpoint if your IdP requires a configuration not defined in the default metadata file. +- **Identity provider specific:** `https://.cloudflareaccess.com/cdn-cgi/access//saml-metadata`, where `` is the `id` value obtained from [List Access identity providers](/api/resources/zero_trust/subresources/identity_providers/methods/list/). Use this endpoint if your IdP requires a configuration not defined in the default metadata file. To download the SAML metadata file, copy-paste the metadata endpoint into a web browser and save the page as an `.xml` file. Upload this XML file to the identity provider. diff --git a/src/content/docs/cloudflare-one/insights/email-monitoring/search-email.mdx b/src/content/docs/cloudflare-one/insights/email-monitoring/search-email.mdx index f392447c957139e..c58d792a8e9dafb 100644 --- a/src/content/docs/cloudflare-one/insights/email-monitoring/search-email.mdx +++ b/src/content/docs/cloudflare-one/insights/email-monitoring/search-email.mdx @@ -122,7 +122,7 @@ With Email Security, you can export messages to a CSV file. To export messages: 1. On the **Investigation** page, under **Your matching messages**, select **Export to CSV**. -2. Select **Export messages** on the pop-up message. You can only export up to 1,000 rows from the dashboard. To export all matching messages, use the [API](/api/operations/email_security_get_message). +2. Select **Export messages** on the pop-up message. You can only export up to 1,000 rows from the dashboard. To export all matching messages, use the [API](/api/resources/email_security/subresources/investigate/methods/get/). ## Email status diff --git a/src/content/docs/cloudflare-one/insights/logs/audit-logs.mdx b/src/content/docs/cloudflare-one/insights/logs/audit-logs.mdx index 9bd50617f4aa6d9..c1bb70b1d33530c 100644 --- a/src/content/docs/cloudflare-one/insights/logs/audit-logs.mdx +++ b/src/content/docs/cloudflare-one/insights/logs/audit-logs.mdx @@ -41,7 +41,7 @@ To view logs for identity-based authentication events: -The [Access authentication logs](/api/operations/access-authentication-logs-get-access-authentication-logs) API endpoint provides a custom URL to export audit log events for your account. +The [Access authentication logs](/api/resources/zero_trust/subresources/access/subresources/logs/subresources/access_requests/methods/list/) API endpoint provides a custom URL to export audit log events for your account. ```bash title="Request" curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/access/logs/access_requests?limit=25&direction=desc&since=2020-07-01T05:20:00Z&until=2020-10-01T05:20:00Z" \ diff --git a/src/content/docs/cloudflare-one/policies/data-loss-prevention/dlp-policies/logging-options.mdx b/src/content/docs/cloudflare-one/policies/data-loss-prevention/dlp-policies/logging-options.mdx index 2c57a378bfd2135..e503f833502d6d8 100644 --- a/src/content/docs/cloudflare-one/policies/data-loss-prevention/dlp-policies/logging-options.mdx +++ b/src/content/docs/cloudflare-one/policies/data-loss-prevention/dlp-policies/logging-options.mdx @@ -43,7 +43,7 @@ Data Loss Prevention will now store a portion of the payload for HTTP requests t 3. Select **Decrypt Payload Log**. 4. Enter your private key and select **Decrypt**. -You will see the [ID of the matched DLP Profile](/api/operations/dlp-profiles-list-all-profiles) followed by the decrypted payload. Note that DLP currently logs only the first match. +You will see the [ID of the matched DLP Profile](/api/resources/zero_trust/subresources/dlp/subresources/profiles/methods/list/) followed by the decrypted payload. Note that DLP currently logs only the first match. :::note Neither the key nor the decrypted payload will be stored by Cloudflare. diff --git a/src/content/docs/cloudflare-one/policies/gateway/application-app-types.mdx b/src/content/docs/cloudflare-one/policies/gateway/application-app-types.mdx index b26070c50eec1cc..3ba48998e52941b 100644 --- a/src/content/docs/cloudflare-one/policies/gateway/application-app-types.mdx +++ b/src/content/docs/cloudflare-one/policies/gateway/application-app-types.mdx @@ -11,7 +11,7 @@ Gateway allows you to create DNS, Network, and HTTP policies based on applicatio ## Applications -When you choose the _Application_ selector in a Gateway policy builder, the **Value** field will include all supported applications and their respective app types. Alternatively, you can use the [Gateway API](/api/operations/zero-trust-gateway-application-and-application-type-mappings-list-application-and-application-type-mappings) to fetch a list of applications, app types, and ID numbers. +When you choose the _Application_ selector in a Gateway policy builder, the **Value** field will include all supported applications and their respective app types. Alternatively, you can use the [Gateway API](/api/resources/zero_trust/subresources/gateway/subresources/app_types/methods/list/) to fetch a list of applications, app types, and ID numbers. ## App types diff --git a/src/content/docs/cloudflare-one/policies/gateway/block-page.mdx b/src/content/docs/cloudflare-one/policies/gateway/block-page.mdx index 607d9448b3fccb8..3f46a3380f34ddb 100644 --- a/src/content/docs/cloudflare-one/policies/gateway/block-page.mdx +++ b/src/content/docs/cloudflare-one/policies/gateway/block-page.mdx @@ -58,6 +58,6 @@ You can add a Mailto link to your custom block page, which allows users to direc | Rule ID | The ID of the Gateway policy that blocked the page. | | Source IP | The public source IP of the user device. | | Account ID | The Cloudflare account associated with the block policy. | -| User ID | The ID of the user who visited the page. Currently, User IDs are not surfaced in the dashboard and can only be viewed by calling the [API](/api/operations/zero-trust-users-get-users). | +| User ID | The ID of the user who visited the page. Currently, User IDs are not surfaced in the dashboard and can only be viewed by calling the [API](/api/resources/zero_trust/subresources/access/subresources/users/methods/list/). | | Device ID | The ID of the device that visited the page. This is generated by the WARP client. | | Block Reason | Your policy-specific block message. | diff --git a/src/content/docs/cloudflare-one/policies/gateway/dns-policies/timed-policies.mdx b/src/content/docs/cloudflare-one/policies/gateway/dns-policies/timed-policies.mdx index df5e4a8c23072c6..75a6e0c5754dfc6 100644 --- a/src/content/docs/cloudflare-one/policies/gateway/dns-policies/timed-policies.mdx +++ b/src/content/docs/cloudflare-one/policies/gateway/dns-policies/timed-policies.mdx @@ -37,7 +37,7 @@ For policies with an exact end time, you can change the time before the policy t ## Scheduled policies -You can use the Gateway API to create a new DNS policy with a schedule or add a schedule to an existing policy. To schedule a policy, use the [Create a Zero Trust Gateway rule endpoint](/api/operations/zero-trust-gateway-rules-create-zero-trust-gateway-rule) or [Update a Zero Trust Gateway rule endpoint](/api/operations/zero-trust-gateway-rules-update-zero-trust-gateway-rule) with the `schedule` parameter set to your desired days of the week, times of day, and an optional time zone. The schedule will appear in Zero Trust under **Gateway** > **Firewall policies** > **DNS** when you select the policy. +You can use the Gateway API to create a new DNS policy with a schedule or add a schedule to an existing policy. To schedule a policy, use the [Create a Zero Trust Gateway rule endpoint](/api/resources/zero_trust/subresources/gateway/subresources/rules/methods/create/) or [Update a Zero Trust Gateway rule endpoint](/api/resources/zero_trust/subresources/gateway/subresources/rules/methods/update/) with the `schedule` parameter set to your desired days of the week, times of day, and an optional time zone. The schedule will appear in Zero Trust under **Gateway** > **Firewall policies** > **DNS** when you select the policy. ### How Gateway determines time zone diff --git a/src/content/docs/cloudflare-one/tutorials/user-selectable-egress-ips.mdx b/src/content/docs/cloudflare-one/tutorials/user-selectable-egress-ips.mdx index 0e7fbdb644d4b71..5b1087208a10920 100644 --- a/src/content/docs/cloudflare-one/tutorials/user-selectable-egress-ips.mdx +++ b/src/content/docs/cloudflare-one/tutorials/user-selectable-egress-ips.mdx @@ -59,7 +59,7 @@ First, create [virtual networks](/cloudflare-one/connections/connect-networks/pr }' ``` - For more information, refer to [Create a virtual network](/api/operations/tunnel-virtual-network-create-a-virtual-network). + For more information, refer to [Create a virtual network](/api/resources/zero_trust/subresources/networks/subresources/virtual_networks/methods/create/). 2. Repeat Step 1 for each dedicated egress IP you want users to switch between. For example, you can create another virtual network called `vnet-EMEA` for egress from Europe, the Middle East, and Africa. @@ -100,7 +100,7 @@ After creating your virtual networks, route your private network CIDRs over each }' ``` - For more information, refer to [Update a tunnel route](/api/operations/tunnel-route-update-a-tunnel-route). + For more information, refer to [Update a tunnel route](/api/resources/zero_trust/subresources/networks/subresources/routes/methods/edit/). 2. Repeat this process for each virtual network you created. For example: @@ -183,7 +183,7 @@ Next, assign your dedicated egress IPs to each virtual network using Gateway egr }' ``` - For more information, refer to [Create a Zero Trust Gateway rule](/api/operations/zero-trust-gateway-rules-create-zero-trust-gateway-rule). + For more information, refer to [Create a Zero Trust Gateway rule](/api/resources/zero_trust/subresources/gateway/subresources/rules/methods/create/). 2. Repeat Step 1 to create an egress policy for each virtual network you created. diff --git a/src/content/docs/d1/best-practices/query-d1.mdx b/src/content/docs/d1/best-practices/query-d1.mdx index bdbfe9e0c6ad4b6..8f0387f6b16de3f 100644 --- a/src/content/docs/d1/best-practices/query-d1.mdx +++ b/src/content/docs/d1/best-practices/query-d1.mdx @@ -10,7 +10,7 @@ D1 is compatible with most SQLite's SQL convention since it leverages SQLite's q There are a number of ways you can interact with a D1 database: 1. Using [D1 Workers Binding API](/d1/worker-api/) in your code. -2. Using [D1 REST API](/api/operations/cloudflare-d1-create-database). +2. Using [D1 REST API](/api/resources/d1/subresources/database/methods/create/). 3. Using [D1 Wrangler commands](/d1/wrangler-commands/). ## Use SQL to query D1 @@ -102,7 +102,7 @@ Refer to [Workers Binding API](/d1/worker-api/) for more information. REST API primarily interacts with the control plane, and allows you to create/manage your D1 database. -Refer to [D1 REST API](/api/operations/cloudflare-d1-create-database) for D1 REST API documentation. +Refer to [D1 REST API](/api/resources/d1/subresources/database/methods/create/) for D1 REST API documentation. ## Query D1 with Wrangler commands diff --git a/src/content/docs/d1/d1-api.mdx b/src/content/docs/d1/d1-api.mdx index 065bc842cf8cd18..25c486c6a10520c 100644 --- a/src/content/docs/d1/d1-api.mdx +++ b/src/content/docs/d1/d1-api.mdx @@ -1,8 +1,7 @@ --- pcx_content_type: navigation title: REST API -external_link: /api/operations/cloudflare-d1-create-database +external_link: /api/resources/d1/subresources/database/methods/create/ sidebar: order: 6 - --- diff --git a/src/content/docs/d1/tutorials/build-an-api-to-access-d1/index.mdx b/src/content/docs/d1/tutorials/build-an-api-to-access-d1/index.mdx index 07a4fb18737ba40..bb92a93b867cced 100644 --- a/src/content/docs/d1/tutorials/build-an-api-to-access-d1/index.mdx +++ b/src/content/docs/d1/tutorials/build-an-api-to-access-d1/index.mdx @@ -19,7 +19,7 @@ In this tutorial, you will learn how to create an API that allows you to securel This is useful if you want to access a D1 database outside of a Worker or Pages project, customize access controls and/or limit what tables can be queried. -D1's built-in [REST API](/api/operations/cloudflare-d1-create-database) is best suited for administrative use as the global [Cloudflare API rate limit](/fundamentals/api/reference/limits) applies. +D1's built-in [REST API](/api/resources/d1/subresources/database/methods/create/) is best suited for administrative use as the global [Cloudflare API rate limit](/fundamentals/api/reference/limits) applies. To access a D1 database outside of a Worker project, you need to create an API using a Worker. Your application can then securely interact with this API to run D1 queries. diff --git a/src/content/docs/d1/tutorials/import-to-d1-with-rest-api/index.mdx b/src/content/docs/d1/tutorials/import-to-d1-with-rest-api/index.mdx index 94bf5c06c6c46fd..60af7188b174e9b 100644 --- a/src/content/docs/d1/tutorials/import-to-d1-with-rest-api/index.mdx +++ b/src/content/docs/d1/tutorials/import-to-d1-with-rest-api/index.mdx @@ -14,7 +14,7 @@ languages: import { Render, Steps } from "~/components"; -In this tutorial, you will learn how to import a database into D1 using the [REST API](/api/operations/cloudflare-d1-import-database). +In this tutorial, you will learn how to import a database into D1 using the [REST API](/api/resources/d1/subresources/database/methods/import/). ## Prerequisites diff --git a/src/content/docs/data-localization/how-to/cache.mdx b/src/content/docs/data-localization/how-to/cache.mdx index 90b3d786e7a96c4..e8b1f80787b6fe9 100644 --- a/src/content/docs/data-localization/how-to/cache.mdx +++ b/src/content/docs/data-localization/how-to/cache.mdx @@ -25,7 +25,7 @@ To configure Regional Services for hostnames [proxied](/dns/manage-dns-records/r -1. To create records with the API, use the [API POST](/api/operations/dns-records-for-a-zone-create-dns-record) command. +1. To create records with the API, use the [API POST](/api/resources/dns/subresources/records/methods/create/) command. 2. Run the [API POST](/data-localization/regional-services/get-started/#configure-regional-services-via-api) command on the hostname to create a `regional_hostnames` with a specific region. diff --git a/src/content/docs/data-localization/how-to/cloudflare-for-saas.mdx b/src/content/docs/data-localization/how-to/cloudflare-for-saas.mdx index 4ff56cecd9494fe..86d538c4c7233d5 100644 --- a/src/content/docs/data-localization/how-to/cloudflare-for-saas.mdx +++ b/src/content/docs/data-localization/how-to/cloudflare-for-saas.mdx @@ -23,8 +23,8 @@ To configure Regional Services for both hostnames [proxied](/dns/manage-dns-reco -1. Set the [fallback record](/api/operations/custom-hostname-fallback-origin-for-a-zone-update-fallback-origin-for-custom-hostnames). -2. Create a [Custom Hostname](/api/operations/custom-hostname-for-a-zone-create-custom-hostname). +1. Set the [fallback record](/api/resources/custom_hostnames/subresources/fallback_origin/methods/update/). +2. Create a [Custom Hostname](/api/resources/custom_hostnames/methods/create/). 3. Run the [API POST](/data-localization/regional-services/get-started/#configure-regional-services-via-api) command on the Custom Hostname to create a `regional_hostnames` with a specific region. diff --git a/src/content/docs/data-localization/how-to/pages.mdx b/src/content/docs/data-localization/how-to/pages.mdx index 1b79d868eca80d5..2771cd7f3c3bb74 100644 --- a/src/content/docs/data-localization/how-to/pages.mdx +++ b/src/content/docs/data-localization/how-to/pages.mdx @@ -27,7 +27,7 @@ To configure Regional Services for hostnames [proxied](/dns/manage-dns-records/r -1. Use the [API POST](/api/operations/pages-domains-add-domain) command to add a Custom Domain to a Pages project. +1. Use the [API POST](/api/resources/pages/subresources/projects/subresources/domains/methods/create/) command to add a Custom Domain to a Pages project. 2. Run the [API POST](/data-localization/regional-services/get-started/#configure-regional-services-via-api) command on the Pages Custom Domain to create a `regional_hostnames` with a specific Region. diff --git a/src/content/docs/dns/cname-flattening/set-up-cname-flattening.mdx b/src/content/docs/dns/cname-flattening/set-up-cname-flattening.mdx index 833de113746b0c6..97fc321890aabf1 100644 --- a/src/content/docs/dns/cname-flattening/set-up-cname-flattening.mdx +++ b/src/content/docs/dns/cname-flattening/set-up-cname-flattening.mdx @@ -35,7 +35,7 @@ For zones on paid plans, you can choose to flatten all `CNAME` records. This opt -Make a `PATCH` request to the [Update DNS Settings](/api/operations/dns-settings-for-a-zone-update-dns-settings) endpoint and set `flatten_all_cnames` to `true` in the request body. +Make a `PATCH` request to the [Update DNS Settings](/api/resources/dns/subresources/settings/methods/edit/) endpoint and set `flatten_all_cnames` to `true` in the request body. @@ -66,7 +66,7 @@ For the following cases, **Flatten** will not be available: -With the available [API endpoints](/api/operations/dns-records-for-a-zone-create-dns-record), specify the following for each `CNAME` record in the request body: +With the available [API endpoints](/api/resources/dns/subresources/records/methods/create/), specify the following for each `CNAME` record in the request body: ```txt "settings": { diff --git a/src/content/docs/dns/dns-firewall/analytics.mdx b/src/content/docs/dns/dns-firewall/analytics.mdx index 57e641f96479562..1a6fc2b98b08bee 100644 --- a/src/content/docs/dns/dns-firewall/analytics.mdx +++ b/src/content/docs/dns/dns-firewall/analytics.mdx @@ -6,7 +6,7 @@ sidebar: --- -To access analytics for your DNS Firewall, use the [Cloudflare API](/api/operations/dns-firewall-analytics-table). +To access analytics for your DNS Firewall, use the [Cloudflare API](/api/resources/dns_firewall/subresources/analytics/subresources/reports/methods/get/). Alternatively, [set up Logpush](/logs/about/) to deliver [DNS Firewall logs](/logs/reference/log-fields/account/dns_firewall_logs/) to a storage service, SIEM, or log management provider. diff --git a/src/content/docs/dns/dns-firewall/faq.mdx b/src/content/docs/dns/dns-firewall/faq.mdx index f34e52e75ef1ea7..145de8f61b9b1c7 100644 --- a/src/content/docs/dns/dns-firewall/faq.mdx +++ b/src/content/docs/dns/dns-firewall/faq.mdx @@ -26,7 +26,7 @@ As long as there is enough allocated memory, Cloudflare does not clear items fro
-Yes. `SERVFAIL` is treated like any other negative answer for caching purposes. The default TTL is 30 seconds. You can use the [API](/api/operations/dns-firewall-update-dns-firewall-cluster) to set a different `negative_cache_ttl`. +Yes. `SERVFAIL` is treated like any other negative answer for caching purposes. The default TTL is 30 seconds. You can use the [API](/api/resources/dns_firewall/methods/edit/) to set a different `negative_cache_ttl`.
@@ -47,13 +47,13 @@ EDNS limits the effectiveness of the DNS cache. ::: -Some resolvers might not be sending any EDNS data. When you set the `ecs_fallback` parameter to `true` via the [API](/api/operations/dns-firewall-update-dns-firewall-cluster), DNS Firewall will forward the IP subnet of the resolver instead only if there is no EDNS data present in incoming the DNS query. +Some resolvers might not be sending any EDNS data. When you set the `ecs_fallback` parameter to `true` via the [API](/api/resources/dns_firewall/methods/edit/), DNS Firewall will forward the IP subnet of the resolver instead only if there is no EDNS data present in incoming the DNS query.
-Yes. The default TTL is 30 seconds. You can set `negative_cache_ttl` via the [API](/api/operations/dns-firewall-update-dns-firewall-cluster). This will affect the TTL of responses with status `REFUSED`, `NXDOMAIN`, or `SERVFAIL`. +Yes. The default TTL is 30 seconds. You can set `negative_cache_ttl` via the [API](/api/resources/dns_firewall/methods/edit/). This will affect the TTL of responses with status `REFUSED`, `NXDOMAIN`, or `SERVFAIL`.
@@ -61,7 +61,7 @@ Yes. The default TTL is 30 seconds. You can set `negative_cache_ttl` via the [AP To set up PTR records for the DNS Firewall cluster IPs that point to your nameserver hostnames, use the following API endpoints: -- [Show DNS Firewall Cluster Reverse DNS](/api/operations/dns-firewall-show-dns-firewall-cluster-reverse-dns) -- [Update DNS Firewall Cluster Reverse DNS](/api/operations/dns-firewall-update-dns-firewall-cluster-reverse-dns) +- [Show DNS Firewall Cluster Reverse DNS](/api/resources/dns_firewall/subresources/reverse_dns/methods/get/) +- [Update DNS Firewall Cluster Reverse DNS](/api/resources/dns_firewall/methods/edit/-reverse-dns) diff --git a/src/content/docs/dns/dns-firewall/random-prefix-attacks/setup.mdx b/src/content/docs/dns/dns-firewall/random-prefix-attacks/setup.mdx index e6467962e27c666..d73dd043a19ca69 100644 --- a/src/content/docs/dns/dns-firewall/random-prefix-attacks/setup.mdx +++ b/src/content/docs/dns/dns-firewall/random-prefix-attacks/setup.mdx @@ -12,7 +12,7 @@ head: In order to enable automatic mitigation of [random prefix attacks](/dns/dns-firewall/random-prefix-attacks/about/): 1. Set up [DNS Firewall](/dns/dns-firewall/setup/). -2. Send a [`PATCH` request](/api/operations/dns-firewall-update-dns-firewall-cluster) to update your DNS Firewall cluster. +2. Send a [`PATCH` request](/api/resources/dns_firewall/methods/edit/) to update your DNS Firewall cluster. ```bash curl --request PATCH "https://api.cloudflare.com/client/v4/accounts/{account_id}/dns_firewall/{cluster_tag}" \ diff --git a/src/content/docs/dns/dns-firewall/setup.mdx b/src/content/docs/dns/dns-firewall/setup.mdx index 908af51b1e49093..0b68804856d4352 100644 --- a/src/content/docs/dns/dns-firewall/setup.mdx +++ b/src/content/docs/dns/dns-firewall/setup.mdx @@ -45,7 +45,7 @@ If you forget to save your new IP addresses, find your cluster and click **IP Ad -You can also create a DNS Firewall cluster by sending a [POST request](/api/operations/dns-firewall-create-dns-firewall-cluster) to the API. +You can also create a DNS Firewall cluster by sending a [POST request](/api/resources/dns_firewall/methods/create/) to the API. @@ -67,6 +67,6 @@ Configure security policy in your DNS servers and Firewall to allow only [Cloudf ## Additional options -When you use the API, you can also specify other parameters, such as rate limit (in queries per second per data center). You can find the parameters descriptions and examples in the [API documentation](/api/operations/dns-firewall-create-dns-firewall-cluster). +When you use the API, you can also specify other parameters, such as rate limit (in queries per second per data center). You can find the parameters descriptions and examples in the [API documentation](/api/resources/dns_firewall/methods/create/). -To configure rate limiting and other options for already existing clusters, use the [Update DNS Firewall Cluster](/api/operations/dns-firewall-update-dns-firewall-cluster) endpoint. +To configure rate limiting and other options for already existing clusters, use the [Update DNS Firewall Cluster](/api/resources/dns_firewall/methods/edit/) endpoint. diff --git a/src/content/docs/dns/dnssec/dnssec-active-migration.mdx b/src/content/docs/dns/dnssec/dnssec-active-migration.mdx index 0ffbe61f224f316..b034152cbe31e8f 100644 --- a/src/content/docs/dns/dnssec/dnssec-active-migration.mdx +++ b/src/content/docs/dns/dnssec/dnssec-active-migration.mdx @@ -28,13 +28,13 @@ The provider you are migrating from must allow you to add DNSKEY records on the 1. [Add your zone to Cloudflare](/fundamentals/setup/manage-domains/add-site/). - To add your zone using the API, refer to the [Create Zone endpoint](/api/operations/zones-post). + To add your zone using the API, refer to the [Create Zone endpoint](/api/resources/zones/methods/create/). 2. [Review the records found by the automatic scan](/dns/manage-dns-records/how-to/create-dns-records/) or [import your zone file](/dns/manage-dns-records/how-to/import-and-export/). - To import the zone file using the API, refer to the [Import DNS Records endpoint](/api/operations/dns-records-for-a-zone-import-dns-records). + To import the zone file using the API, refer to the [Import DNS Records endpoint](/api/resources/dns/subresources/records/methods/import/). -3. Go to **DNS** > **Settings**, and select **Enable DNSSEC**. Or use the following [API request](/api/operations/dnssec-edit-dnssec-status). +3. Go to **DNS** > **Settings**, and select **Enable DNSSEC**. Or use the following [API request](/api/resources/dns/subresources/dnssec/methods/edit/). ```bash curl --request PATCH \ @@ -45,7 +45,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/dnssec \ --data '{"status": "active"}' ``` -4. Go to **DNS** > **Settings**, and enable **Multi-signer DNSSEC**. Or use the following [API request](/api/operations/dnssec-edit-dnssec-status). +4. Go to **DNS** > **Settings**, and enable **Multi-signer DNSSEC**. Or use the following [API request](/api/resources/dns/subresources/dnssec/methods/edit/). ```bash curl --request PATCH \ @@ -60,7 +60,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/dnssec \ 1. Add the [ZSK](https://www.cloudflare.com/learning/dns/dns-records/dnskey-ds-records/) of your previous provider to Cloudflare by creating a DNSKEY record on your zone. -You can do this [on the dashboard](/dns/manage-dns-records/how-to/create-dns-records/#create-dns-records) or through the [Create DNS Record endpoint](/api/operations/dns-records-for-a-zone-create-dns-record), as in the following example. +You can do this [on the dashboard](/dns/manage-dns-records/how-to/create-dns-records/#create-dns-records) or through the [Create DNS Record endpoint](/api/resources/dns/subresources/records/methods/create/), as in the following example. ```bash curl https://api.cloudflare.com/client/v4/zones/{zone_id}/dns_records \ diff --git a/src/content/docs/dns/dnssec/dnssec-states.mdx b/src/content/docs/dns/dnssec/dnssec-states.mdx index f1349cc1b34c46a..be03ff37ec5b55a 100644 --- a/src/content/docs/dns/dnssec/dnssec-states.mdx +++ b/src/content/docs/dns/dnssec/dnssec-states.mdx @@ -6,7 +6,7 @@ sidebar: --- -This page describes different DNSSEC states and how they relate to the responses you get from the [DNSSEC details API endpoint](/api/operations/dnssec-dnssec-details). +This page describes different DNSSEC states and how they relate to the responses you get from the [DNSSEC details API endpoint](/api/resources/dns/subresources/dnssec/methods/get/). | State | API response | Description | | ---------------- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -14,11 +14,11 @@ This page describes different DNSSEC states and how they relate to the responses | Active | `"status":"active"`
`"modified_on":` | DNSSEC has been enabled and the Cloudflare DS record is present at the registrar. | | Pending-disabled | `"status":"pending-disabled"`
`"modified_on":` | DNSSEC has been disabled but the Cloudflare DS record is still added at the registrar. | | Disabled | `"status":"disabled"`
`"modified_on":` | DNSSEC has been disabled and the Cloudflare DS record has been removed from the registrar. | -| Deleted | `"status":"disabled"`
`"modified_on": null` | DNSSEC has never been enabled for the zone or DNSSEC has been disabled and then deleted using the [Delete DNSSEC records endpoint](/api/operations/dnssec-delete-dnssec-records). | +| Deleted | `"status":"disabled"`
`"modified_on": null` | DNSSEC has never been enabled for the zone or DNSSEC has been disabled and then deleted using the [Delete DNSSEC records endpoint](/api/resources/dns/subresources/dnssec/methods/delete/). | :::caution -Once you have enabled DNSSEC on a zone for the first time, you cannot transition directly from an `active` state to a `deleted` state. You can only [delete DNSSEC records](/api/operations/dnssec-delete-dnssec-records) once your zone DNSSEC is in a `disabled` state. Cloudflare prevents you from deleting DNSSEC records before removing the DS record from the registrar to avoid DNS resolution issues. +Once you have enabled DNSSEC on a zone for the first time, you cannot transition directly from an `active` state to a `deleted` state. You can only [delete DNSSEC records](/api/resources/dns/subresources/dnssec/methods/delete/) once your zone DNSSEC is in a `disabled` state. Cloudflare prevents you from deleting DNSSEC records before removing the DS record from the registrar to avoid DNS resolution issues. ::: In both `pending` and `active` states, Cloudflare signs the zone and responds with `RRSIG`, `NSEC`, `DNSKEY`, `CDS`, and `CDNSKEY` record types. diff --git a/src/content/docs/dns/dnssec/multi-signer-dnssec/setup.mdx b/src/content/docs/dns/dnssec/multi-signer-dnssec/setup.mdx index 77ab9187a4575b1..90d5a1e89e88be5 100644 --- a/src/content/docs/dns/dnssec/multi-signer-dnssec/setup.mdx +++ b/src/content/docs/dns/dnssec/multi-signer-dnssec/setup.mdx @@ -42,7 +42,7 @@ For the purpose of this tutorial, you will update your registrar with the DS rec -1. Use the [Edit DNSSEC Status endpoint](/api/operations/dnssec-edit-dnssec-status) to enable DNSSEC and activate multi-signer DNSSEC for your zone. Set `status` to `active` and `dnssec_multi_signer` to `true`, as in the following example. +1. Use the [Edit DNSSEC Status endpoint](/api/resources/dns/subresources/dnssec/methods/edit/) to enable DNSSEC and activate multi-signer DNSSEC for your zone. Set `status` to `active` and `dnssec_multi_signer` to `true`, as in the following example. ```bash curl --request PATCH \ @@ -133,7 +133,7 @@ For the purpose of this tutorial, you will update your registrar with the DS rec -1. Use the [Edit DNSSEC Status endpoint](/api/operations/dnssec-edit-dnssec-status) to enable DNSSEC and activate multi-signer DNSSEC for your zone. Set `status` to `active` and `dnssec_multi_signer` to `true`, as in the following example. +1. Use the [Edit DNSSEC Status endpoint](/api/resources/dns/subresources/dnssec/methods/edit/) to enable DNSSEC and activate multi-signer DNSSEC for your zone. Set `status` to `active` and `dnssec_multi_signer` to `true`, as in the following example. ```bash $ curl --request PATCH 'https://api.cloudflare.com/client/v4/zones/{zone_id}/dnssec' \ diff --git a/src/content/docs/dns/foundation-dns/setup.mdx b/src/content/docs/dns/foundation-dns/setup.mdx index 509142fe01a95f6..6b16fc5a707d815 100644 --- a/src/content/docs/dns/foundation-dns/setup.mdx +++ b/src/content/docs/dns/foundation-dns/setup.mdx @@ -25,7 +25,7 @@ To enable advanced nameservers on an existing zone: - Use the [Update DNS Settings](/api/operations/dns-settings-for-a-zone-update-dns-settings) endpoint to send a PATCH request like the following: + Use the [Update DNS Settings](/api/resources/dns/subresources/settings/methods/edit/) endpoint to send a PATCH request like the following: ```bash curl --request PATCH \ diff --git a/src/content/docs/dns/manage-dns-records/how-to/batch-record-changes.mdx b/src/content/docs/dns/manage-dns-records/how-to/batch-record-changes.mdx index 47f73cddfd61bf9..46b06b200df89df 100644 --- a/src/content/docs/dns/manage-dns-records/how-to/batch-record-changes.mdx +++ b/src/content/docs/dns/manage-dns-records/how-to/batch-record-changes.mdx @@ -75,7 +75,7 @@ This option requires familiarity with API usage and concepts. For further inform ::: -The [Batched DNS record changes](/api/operations/dns-records-for-a-zone-batch-dns-records) endpoint allows you to trigger the execution of `DELETES`, `PATCHES`, `PUTS`, and `POSTS` in a single request. +The [Batched DNS record changes](/api/resources/dns/subresources/records/methods/batch/) endpoint allows you to trigger the execution of `DELETES`, `PATCHES`, `PUTS`, and `POSTS` in a single request. [Tags and comments](/dns/manage-dns-records/reference/record-attributes/) are also supported with batch changes. @@ -99,7 +99,7 @@ For each operation that you list in the `/batch` request body, consider the requ - **`deletes`**: only the `id` is required for each record object. You can keep additional parameters such as `name` for readability, but any other fields aside from `id` will be ignored in this case. - **`patches`**: aside from each record `id`, you should specify the fields you want to update. All unspecified fields will remain as they are. - **`puts`**: you must specify each record `id`, `content`, `name`, and `type`. You should also specify any other fields you want to set to a value that is not the default. Any unspecified fields will assume their default value for each [record type](/dns/manage-dns-records/reference/dns-record-types/). This operation works as an overwrite, so all fields in a given record are always affected. -- **`posts`**: since you are creating a new record, `id` is not required. For field definitions, refer to the [Create DNS Record](/api/operations/dns-records-for-a-zone-create-dns-record) endpoint and select the desired record type under the request body specification. +- **`posts`**: since you are creating a new record, `id` is not required. For field definitions, refer to the [Create DNS Record](/api/resources/dns/subresources/records/methods/create/) endpoint and select the desired record type under the request body specification. ### Example request diff --git a/src/content/docs/dns/manage-dns-records/how-to/create-dns-records.mdx b/src/content/docs/dns/manage-dns-records/how-to/create-dns-records.mdx index 3095f1a426be4e5..79ca491977b8c92 100644 --- a/src/content/docs/dns/manage-dns-records/how-to/create-dns-records.mdx +++ b/src/content/docs/dns/manage-dns-records/how-to/create-dns-records.mdx @@ -43,7 +43,7 @@ To create a DNS record in the dashboard: -To create records with the API, use a [POST request](/api/operations/dns-records-for-a-zone-create-dns-record). For field definitions, select a record type under the request body specification. +To create records with the API, use a [POST request](/api/resources/dns/subresources/records/methods/create/). For field definitions, select a record type under the request body specification. For specific API examples, refer to [DNS record types](/dns/manage-dns-records/reference/dns-record-types/). @@ -67,7 +67,7 @@ To edit DNS records in the dashboard: -To update part of a record with the API, use a [PATCH request](/api/operations/dns-records-for-a-zone-patch-dns-record). If you want to overwrite the entire existing record, use a [PUT request](/api/operations/dns-records-for-a-zone-update-dns-record). +To update part of a record with the API, use a [PATCH request](/api/resources/dns/subresources/records/methods/edit/). If you want to overwrite the entire existing record, use a [PUT request](/api/resources/dns/subresources/records/methods/update/). @@ -89,7 +89,7 @@ To delete DNS records in the dashboard: -To delete records with the API, use a [DELETE request](/api/operations/dns-records-for-a-zone-delete-dns-record). +To delete records with the API, use a [DELETE request](/api/resources/dns/subresources/records/methods/delete/). diff --git a/src/content/docs/dns/manage-dns-records/how-to/import-and-export.mdx b/src/content/docs/dns/manage-dns-records/how-to/import-and-export.mdx index 11dd1751602be9f..6550ca745694543 100644 --- a/src/content/docs/dns/manage-dns-records/how-to/import-and-export.mdx +++ b/src/content/docs/dns/manage-dns-records/how-to/import-and-export.mdx @@ -35,7 +35,7 @@ To import a zone file using the dashboard: -To import records using the API, send a [POST request](/api/operations/dns-records-for-a-zone-import-dns-records) with a properly [formatted file](#format-your-zone-file). +To import records using the API, send a [POST request](/api/resources/dns/subresources/records/methods/import/) with a properly [formatted file](#format-your-zone-file). @@ -56,7 +56,7 @@ To export records using the dashboard: -To export records using the API, send a [GET request](/api/operations/dns-records-for-a-zone-export-dns-records). +To export records using the API, send a [GET request](/api/resources/dns/subresources/records/methods/export/). diff --git a/src/content/docs/dns/manage-dns-records/how-to/managing-dynamic-ip-addresses.mdx b/src/content/docs/dns/manage-dns-records/how-to/managing-dynamic-ip-addresses.mdx index 5c7d251f9792a07..a773e1bb9b18006 100644 --- a/src/content/docs/dns/manage-dns-records/how-to/managing-dynamic-ip-addresses.mdx +++ b/src/content/docs/dns/manage-dns-records/how-to/managing-dynamic-ip-addresses.mdx @@ -10,7 +10,7 @@ Most Internet service providers and some hosting providers dynamically update th ## Cloudflare API -Create a script to monitor IP address changes and then have that script push changes to the [Cloudflare API](/api/operations/dns-records-for-a-zone-update-dns-record). +Create a script to monitor IP address changes and then have that script push changes to the [Cloudflare API](/api/resources/dns/subresources/records/methods/update/). ## ddclient diff --git a/src/content/docs/dns/manage-dns-records/reference/record-attributes.mdx b/src/content/docs/dns/manage-dns-records/reference/record-attributes.mdx index 9888f51d3df5b4d..773a7d5046f03f2 100644 --- a/src/content/docs/dns/manage-dns-records/reference/record-attributes.mdx +++ b/src/content/docs/dns/manage-dns-records/reference/record-attributes.mdx @@ -47,7 +47,7 @@ Comments and tags are only supported for [full](/dns/zone-setups/full-setup/) an ## Add or edit record attributes -Create or edit record attributes just like any other aspect of DNS records, whether through the [dashboard](/dns/manage-dns-records/how-to/create-dns-records/) or [API](/api/operations/dns-records-for-a-zone-create-dns-record). +Create or edit record attributes just like any other aspect of DNS records, whether through the [dashboard](/dns/manage-dns-records/how-to/create-dns-records/) or [API](/api/resources/dns/subresources/records/methods/create/). You can also add or edit attributes by [exporting and re-importing](/dns/manage-dns-records/how-to/import-and-export/#dns-record-attributes) your records, or using the [Batch record changes API](/dns/manage-dns-records/how-to/batch-record-changes/#use-the-api). diff --git a/src/content/docs/dns/nameservers/custom-nameservers/account-custom-nameservers.mdx b/src/content/docs/dns/nameservers/custom-nameservers/account-custom-nameservers.mdx index 3b5e989ac0bd28a..6625b0ba4b0e41d 100644 --- a/src/content/docs/dns/nameservers/custom-nameservers/account-custom-nameservers.mdx +++ b/src/content/docs/dns/nameservers/custom-nameservers/account-custom-nameservers.mdx @@ -43,7 +43,7 @@ For this configuration to be possible, a few conditions apply: -Use the [Add account custom nameserver endpoint](/api/operations/account-level-custom-nameservers-add-account-custom-nameserver) to create account custom nameservers. Follow the [conditions](#configuration-conditions) for `ns_name` and `ns_set`. +Use the [Add account custom nameserver endpoint](/api/resources/custom_nameservers/methods/create/) to create account custom nameservers. Follow the [conditions](#configuration-conditions) for `ns_name` and `ns_set`. @@ -88,7 +88,7 @@ Cloudflare will assign an IPv4 and an IPv6 address to each ACNS name, and these -Use the endpoint [Update DNS Settings for a Zone](/api/operations/dns-settings-for-a-zone-update-dns-settings) and configure the `nameservers` object accordingly for each zone. +Use the endpoint [Update DNS Settings for a Zone](/api/resources/dns/subresources/settings/methods/edit/) and configure the `nameservers` object accordingly for each zone. @@ -116,7 +116,7 @@ Refer to [DNS zone defaults](/dns/nameservers/nameserver-options/#dns-zone-defau -Use the endpoint [Update DNS Settings for an Account](/api/operations/dns-settings-for-an-account-update-dns-settings). Within the `zone_defaults` object, set the following: +Use the endpoint [Update DNS Settings for an Account](/api/resources/dns/subresources/settings/methods/edit/). Within the `zone_defaults` object, set the following: ```txt "zone_defaults": { @@ -144,8 +144,8 @@ To remove ACNS from a zone, first update your nameservers to stop using ACNS: -* If you are using [Cloudflare Registrar](/registrar/), use the [Set ACNS Related Zone Metadata endpoint](/api/operations/account-level-custom-nameservers-usage-for-a-zone-set-account-custom-nameserver-related-zone-metadata) to change the `enabled` parameter to `false`, and then [contact Cloudflare Support](/support/contacting-cloudflare-support/) to set your nameservers back to the regular Cloudflare branded nameservers. -* If you are not using [Cloudflare Registrar](/registrar/), modify the domain's registrar to use your regular Cloudflare branded nameservers and then use the [Set ACNS Related Zone Metadata endpoint](/api/operations/account-level-custom-nameservers-usage-for-a-zone-set-account-custom-nameserver-related-zone-metadata) to set the `enabled` parameter to `false`. +* If you are using [Cloudflare Registrar](/registrar/), use the [Update DNS settings endpoint](/api/resources/dns/subresources/settings/methods/edit/) to change the `enabled` parameter to `false`, and then [contact Cloudflare Support](/support/contacting-cloudflare-support/) to set your nameservers back to the regular Cloudflare branded nameservers. +* If you are not using [Cloudflare Registrar](/registrar/), modify the domain's registrar to use your regular Cloudflare branded nameservers and then use the [Update DNS settings endpoint](/api/resources/dns/subresources/settings/methods/edit/) to set the `enabled` parameter to `false`. @@ -164,7 +164,7 @@ Following the [configuration conditions](#configuration-conditions), each set mu -Use the [Delete account custom nameserver endpoint](/api/operations/account-level-custom-nameservers-delete-account-custom-nameserver) to delete a specific ACNS. +Use the [Delete account custom nameserver endpoint](/api/resources/custom_nameservers/methods/delete/) to delete a specific ACNS. \ No newline at end of file diff --git a/src/content/docs/dns/nameservers/custom-nameservers/tenant-custom-nameservers.mdx b/src/content/docs/dns/nameservers/custom-nameservers/tenant-custom-nameservers.mdx index 76f9a347e845928..4c4e13aaab3d6de 100644 --- a/src/content/docs/dns/nameservers/custom-nameservers/tenant-custom-nameservers.mdx +++ b/src/content/docs/dns/nameservers/custom-nameservers/tenant-custom-nameservers.mdx @@ -32,7 +32,7 @@ For this configuration to be possible, a few conditions apply: If you are an account owner and your account is part of a tenant that has custom nameservers, do the following: -1. Use a [PUT command](/api/operations/account-level-custom-nameservers-usage-for-a-zone-set-account-custom-nameserver-related-zone-metadata) and specify `ns_type` and `ns_set`. +1. Use a [PUT command](/api/resources/zones/subresources/custom_nameservers/methods/update/) and specify `ns_type` and `ns_set`. ```bash curl --request PUT https://api.cloudflare.com/client/v4/zones/{zone_id}/custom_ns \ @@ -55,7 +55,7 @@ If the parameter `ns_set` is omitted, the default set `1` will be assigned. 2. If you are **not** using [Cloudflare Registrar](/registrar/), update the nameservers at your registrar to use the TCNS names. If you are using [Cloudflare Registrar](/registrar/), no further action is needed. -To make these TCNS the default namerservers for all new zones added to your account from now on, use the endpoint [Update DNS Settings for an Account](/api/operations/dns-settings-for-an-account-update-dns-settings). Within the `zone_defaults` object, set the following: +To make these TCNS the default namerservers for all new zones added to your account from now on, use the endpoint [Update DNS Settings for an Account](/api/resources/dns/subresources/settings/methods/edit/). Within the `zone_defaults` object, set the following: ```txt "zone_defaults": { @@ -66,7 +66,7 @@ To make these TCNS the default namerservers for all new zones added to your acco ``` ### Disable tenant custom nameservers on a zone -To remove TCNS and their associated DNS records from a zone, use a [PUT command](/api/operations/account-level-custom-nameservers-usage-for-a-zone-set-account-custom-nameserver-related-zone-metadata). +To remove TCNS and their associated DNS records from a zone, use a [PUT command](/api/resources/zones/subresources/custom_nameservers/methods/update/). If you are **not** using [Cloudflare Registrar](/registrar/), also remove the TCNS at your domain’s registrar. diff --git a/src/content/docs/dns/nameservers/custom-nameservers/zone-custom-nameservers.mdx b/src/content/docs/dns/nameservers/custom-nameservers/zone-custom-nameservers.mdx index 107479c00573638..4a92a8851a456c3 100644 --- a/src/content/docs/dns/nameservers/custom-nameservers/zone-custom-nameservers.mdx +++ b/src/content/docs/dns/nameservers/custom-nameservers/zone-custom-nameservers.mdx @@ -34,7 +34,7 @@ To create zone custom nameservers: -Use the [Edit zone endpoint](/api/operations/zones-0-patch) and specify the custom nameservers in the payload: +Use the [Edit zone endpoint](/api/resources/zones/methods/edit/) and specify the custom nameservers in the payload: ```txt "vanity_name_servers": ["ns1.example.com","ns2.example.com"] @@ -52,7 +52,7 @@ The next step depends on whether you are using [Cloudflare Registrar](/registrar If you are using [Cloudflare as a secondary DNS provider](/dns/zone-setups/zone-transfers/cloudflare-as-secondary/), you can still set up zone custom nameservers. After following the [steps above](/dns/nameservers/custom-nameservers/zone-custom-nameservers/#primary-full-setup-zones) to create zone custom nameservers, do the following: -1. Get the ZCNS IPs. You can see them on the dashboard (**DNS** > **Records**) or you can use the [Zone details endpoint](/api/operations/zones-0-get) to get the `vanity_name_servers_ips`. +1. Get the ZCNS IPs. You can see them on the dashboard (**DNS** > **Records**) or you can use the [Zone details endpoint](/api/resources/zones/methods/get/) to get the `vanity_name_servers_ips`. 2. At your primary DNS provider, add [`NS` records](/dns/manage-dns-records/reference/dns-record-types/#ns) and, on the subdomains that you used as ZCNS names, add `A/AAAA` records. 3. At your registrar, add the zone custom nameservers as your authoritative nameservers and as glue (A and AAAA) records ([RFC 1912](https://www.rfc-editor.org/rfc/rfc1912.html)). @@ -68,7 +68,7 @@ To remove zone custom nameservers (and their associated, read-only DNS records): -Use the [Edit zone endpoint](/api/operations/zones-0-patch) and include an empty array in the payload: +Use the [Edit zone endpoint](/api/resources/zones/methods/edit/) and include an empty array in the payload: ```txt "vanity_name_servers": [] diff --git a/src/content/docs/dns/reference/analytics-api-properties.mdx b/src/content/docs/dns/reference/analytics-api-properties.mdx index 6184e997dae0d92..49609ca177431ad 100644 --- a/src/content/docs/dns/reference/analytics-api-properties.mdx +++ b/src/content/docs/dns/reference/analytics-api-properties.mdx @@ -13,10 +13,10 @@ description: API properties that you can use in API requests for Cloudflare DNS import { Details, Render } from "~/components" -This page describes API properties that you can use in requests to the [DNS analytics API](/api/operations/dns-analytics-table). +This page describes API properties that you can use in requests to the [DNS analytics API](/api/resources/dns/subresources/analytics/subresources/reports/methods/get/). :::caution[Warning] -The [DNS analytics API](/api/operations/dns-analytics-table), along with the following [API properties](/dns/reference/analytics-api-properties/), will be deprecated soon. +The [DNS analytics API](/api/resources/dns/subresources/analytics/subresources/reports/methods/get/), along with the following [API properties](/dns/reference/analytics-api-properties/), will be deprecated soon. To access the new analytics dashboard, go to **DNS** > **Analytics**. Refer to [Analytics and logs](/dns/additional-options/analytics/) for details. ::: diff --git a/src/content/docs/dns/troubleshooting/faq.mdx b/src/content/docs/dns/troubleshooting/faq.mdx index bc2d1b7c2ad872f..0e948fbb59367dc 100644 --- a/src/content/docs/dns/troubleshooting/faq.mdx +++ b/src/content/docs/dns/troubleshooting/faq.mdx @@ -197,7 +197,7 @@ Make sure the argument `zone_id = data.cloudflare_zones.example_com.zones[0].id` ## Why am I getting hundreds of random DNS records after adding my domain? -This can happen when you had a wildcard \* record configured at your previous authoritative DNS. You can remove these records in bulk [using the API](/api/operations/dns-records-for-a-zone-delete-dns-record). +This can happen when you had a wildcard \* record configured at your previous authoritative DNS. You can remove these records in bulk [using the API](/api/resources/dns/subresources/records/methods/delete/). You can also: diff --git a/src/content/docs/dns/zone-setups/conversions/convert-full-to-secondary.mdx b/src/content/docs/dns/zone-setups/conversions/convert-full-to-secondary.mdx index 925e7f3715a1497..d5568966b6242c4 100644 --- a/src/content/docs/dns/zone-setups/conversions/convert-full-to-secondary.mdx +++ b/src/content/docs/dns/zone-setups/conversions/convert-full-to-secondary.mdx @@ -18,7 +18,7 @@ Follow the steps below to achieve this conversion. 1. [Export a zone file](/dns/manage-dns-records/how-to/import-and-export/#export-records). 2. Import the zone file into your new primary DNS provider. -3. At your Cloudflare zone, use the [Update DNS Settings](/api/operations/dns-settings-for-a-zone-update-dns-settings) endpoint to enable [secondary DNS overrides](/dns/zone-setups/zone-transfers/cloudflare-as-secondary/proxy-traffic/). Set the value for `secondary_overrides` to `true`. +3. At your Cloudflare zone, use the [Update DNS Settings](/api/resources/dns/subresources/settings/methods/edit/) endpoint to enable [secondary DNS overrides](/dns/zone-setups/zone-transfers/cloudflare-as-secondary/proxy-traffic/). Set the value for `secondary_overrides` to `true`. :::note Enabling secondary DNS overrides is necessary in case you have DNS records that you wish to keep proxied. @@ -47,7 +47,7 @@ Follow the steps below to achieve this conversion. ## 3. Convert the zone and initiate zone transfers -1. Use the [Edit Zone endpoint](/api/operations/zones-0-patch) with `type` set to `secondary` to convert the zone type. The existing records will remain in place. +1. Use the [Edit Zone endpoint](/api/resources/zones/methods/edit/) with `type` set to `secondary` to convert the zone type. The existing records will remain in place. 2. Go to **DNS** > **Settings** > **DNS Zone Transfers** and select **Manage linked peers**. 3. Link the peer server you created in the previous steps and select **Save**. 4. On **DNS** > **Settings**, select **Initiate zone transfer**. diff --git a/src/content/docs/dns/zone-setups/conversions/convert-partial-to-secondary.mdx b/src/content/docs/dns/zone-setups/conversions/convert-partial-to-secondary.mdx index 8fbcba8381610d7..f760d0b07409c21 100644 --- a/src/content/docs/dns/zone-setups/conversions/convert-partial-to-secondary.mdx +++ b/src/content/docs/dns/zone-setups/conversions/convert-partial-to-secondary.mdx @@ -82,19 +82,19 @@ Final records adjusted in the zone file: ## 2. Configure the Cloudflare zone -1. Use the [Import DNS Records endpoint](/api/operations/dns-records-for-a-zone-import-dns-records) with a properly [formatted zone file](/dns/manage-dns-records/how-to/import-and-export/#format-your-zone-file) to import the records into your partial zone. +1. Use the [Import DNS Records endpoint](/api/resources/dns/subresources/records/methods/import/) with a properly [formatted zone file](/dns/manage-dns-records/how-to/import-and-export/#format-your-zone-file) to import the records into your partial zone. Existing and already proxied records will not be overwritten by the import. -2. Use the [Update DNS Settings endpoint](/api/operations/dns-settings-for-a-zone-update-dns-settings) with `secondary_overrides` set to `true`, to enable Secondary DNS Override. +2. Use the [Update DNS Settings endpoint](/api/resources/dns/subresources/settings/methods/edit/) with `secondary_overrides` set to `true`, to enable Secondary DNS Override. :::caution This step is essential so that Cloudflare can keep the proxy status of the records after the conversion. ::: -3. Use the [Edit Zone endpoint](/api/operations/zones-0-patch) with `type` set to `secondary`, to convert the zone type. +3. Use the [Edit Zone endpoint](/api/resources/zones/methods/edit/) with `type` set to `secondary`, to convert the zone type. You can verify if it answers as expected by querying the new assigned secondary nameservers. You can find your nameservers in [**DNS** > **Records**](https://dash.cloudflare.com/?to=/:account/:zone/dns/records), and they should follow a format like `ns0123.secondary.cloudflare.com`. @@ -135,8 +135,8 @@ If you keep any DNS records that still refer `cdn.cloudflare.net`, HTTP traffic -Use the [Update Secondary Zone Configuration endpoint]() to link your Cloudflare zone to the peer DNS server. +Use the [Update Secondary Zone Configuration endpoint](/api/resources/dns/subresources/zone_transfers/subresources/peers/methods/update/) to link your Cloudflare zone to the peer DNS server. -4. In [**DNS** > **Settings**](https://dash.cloudflare.com/?to=/:account/:zone/dns/settings), confirm the linked peer is listed under **DNS Zone Transfers**, and select **Initiate zone transfer**. Alternatively, you can use the [Force AXFR endpoint](). +4. In [**DNS** > **Settings**](https://dash.cloudflare.com/?to=/:account/:zone/dns/settings), confirm the linked peer is listed under **DNS Zone Transfers**, and select **Initiate zone transfer**. Alternatively, you can use the [Force AXFR endpoint](/api/resources/dns/subresources/zone_transfers/subresources/force_axfr/methods/create/). diff --git a/src/content/docs/dns/zone-setups/conversions/convert-secondary-to-full.mdx b/src/content/docs/dns/zone-setups/conversions/convert-secondary-to-full.mdx index e231b0405b7f1e1..baaa8a79c43fa34 100644 --- a/src/content/docs/dns/zone-setups/conversions/convert-secondary-to-full.mdx +++ b/src/content/docs/dns/zone-setups/conversions/convert-secondary-to-full.mdx @@ -27,11 +27,11 @@ Follow the steps below to achieve this conversion. - If you have [Secondary DNS override](/dns/zone-setups/zone-transfers/cloudflare-as-secondary/proxy-traffic/), confirm each record has the appropriate setting (**Proxied** or **DNS only**). - If [Secondary DNS override](/dns/zone-setups/zone-transfers/cloudflare-as-secondary/proxy-traffic/) is disabled, make sure all of your DNS records are listed as **DNS only**. -3. (Optional) For consistency, use the [Update DNS Settings](/api/operations/dns-settings-for-a-zone-update-dns-settings) endpoint to specify SOA record fields according to your needs. Once Cloudflare automatically generates an SOA record for your zone on full setup, the field overrides will be considered. +3. (Optional) For consistency, use the [Update DNS Settings](/api/resources/dns/subresources/settings/methods/edit/) endpoint to specify SOA record fields according to your needs. Once Cloudflare automatically generates an SOA record for your zone on full setup, the field overrides will be considered. ## 3. Convert your zone -1. Use the [Edit Zone endpoint](/api/operations/zones-0-patch) with `type` set to `full` to convert the zone type. Existing DNS records will not be affected. +1. Use the [Edit Zone endpoint](/api/resources/zones/methods/edit/) with `type` set to `full` to convert the zone type. Existing DNS records will not be affected. 2. Go to [**DNS** > **Records**](https://dash.cloudflare.com/?to=/:account/:zone/dns/records) and take note of your new **Cloudflare Nameservers**. 3. At your domain registrar (or parent zone), [update your nameservers](/dns/nameservers/update-nameservers/). Replace the nameservers ending in `secondary.cloudflare.com` by the ones ending in `ns.cloudflare.com`. diff --git a/src/content/docs/dns/zone-setups/conversions/convert-secondary-to-partial.mdx b/src/content/docs/dns/zone-setups/conversions/convert-secondary-to-partial.mdx index ac6f16d8e26396e..9781aa7019934c2 100644 --- a/src/content/docs/dns/zone-setups/conversions/convert-secondary-to-partial.mdx +++ b/src/content/docs/dns/zone-setups/conversions/convert-secondary-to-partial.mdx @@ -39,7 +39,7 @@ Follow the steps below to achieve this conversion. ## 3. Convert your Cloudflare zone 1. Back at your Cloudflare zone, confirm that you have all the `A`, `AAAA`, or `CNAME` [DNS records](/dns/manage-dns-records/how-to/create-dns-records/) needed for the hostnames you pointed to `{your-hostname}.cdn.cloudflare.net` in the previous step. You can also delete any DNS records that have a different type, as they will no longer resolve once you convert your zone to a partial setup. -2. Use the [Edit Zone endpoint](/api/operations/zones-0-patch) with `type` set to `partial` to convert the zone type. Existing DNS records will not be affected. +2. Use the [Edit Zone endpoint](/api/resources/zones/methods/edit/) with `type` set to `partial` to convert the zone type. Existing DNS records will not be affected. 3. On [**DNS** > **Records**](https://dash.cloudflare.com/?to=/:account/:zone/dns/records), get the **Verification TXT Record** and add it at your authoritative DNS provider.
diff --git a/src/content/docs/dns/zone-setups/subdomain-setup/setup/parent-on-full.mdx b/src/content/docs/dns/zone-setups/subdomain-setup/setup/parent-on-full.mdx index 07f624a65d860c3..338d05934e7fa92 100644 --- a/src/content/docs/dns/zone-setups/subdomain-setup/setup/parent-on-full.mdx +++ b/src/content/docs/dns/zone-setups/subdomain-setup/setup/parent-on-full.mdx @@ -65,7 +65,7 @@ If you have already created DNS records covering your subdomain in the parent zo 6. Get the nameserver names for the subdomain. These can be found within your newly created child zone in [DNS > Records](https://dash.cloudflare.com/?to=/:account/:zone/dns/records), and will **not** be the same nameservers as the ones used in the parent zone. :::note - If the parent zone is on Cloudflare, steps 7 and 9 below can be achieved via API. Use the [Batch DNS records](/api/operations/dns-records-for-a-zone-batch-dns-records) endpoint to delete and create or update DNS records within a single request. Refer to [Batch record changes](/dns/manage-dns-records/how-to/batch-record-changes/) for further guidance. + If the parent zone is on Cloudflare, steps 7 and 9 below can be achieved via API. Use the [Batch DNS records](/api/resources/dns/subresources/records/methods/batch/) endpoint to delete and create or update DNS records within a single request. Refer to [Batch record changes](/dns/manage-dns-records/how-to/batch-record-changes/) for further guidance. ::: 7. Within the **DNS** > **Records** of the parent zone, update existing address records (`A/AAAA`) on your subdomain to `NS` records. If you only have one address record, update the existing one and add a new `NS` record. If you have multiple address records, update any two of them. diff --git a/src/content/docs/dns/zone-setups/zone-transfers/access-control-lists/create-new-list.mdx b/src/content/docs/dns/zone-setups/zone-transfers/access-control-lists/create-new-list.mdx index 5e57274628d51b9..352c8fef49b2f84 100644 --- a/src/content/docs/dns/zone-setups/zone-transfers/access-control-lists/create-new-list.mdx +++ b/src/content/docs/dns/zone-setups/zone-transfers/access-control-lists/create-new-list.mdx @@ -29,6 +29,6 @@ To create a new ACL using the dashboard: -To create a new ACL using the API, send a [POST]() request. +To create a new ACL using the API, send a [POST](/api/resources/dns/subresources/zone_transfers/subresources/acls/methods/create/) request. diff --git a/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-primary/dnssec-for-primary.mdx b/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-primary/dnssec-for-primary.mdx index 6128c738222609c..d5a3bbb60cb5f05 100644 --- a/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-primary/dnssec-for-primary.mdx +++ b/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-primary/dnssec-for-primary.mdx @@ -25,7 +25,7 @@ Note that: ## Steps -1. Use the [Edit DNSSEC Status endpoint](/api/operations/dnssec-edit-dnssec-status) to enable DNSSEC and activate multi-signer DNSSEC for your zone. This is done by setting `status` to `active` and `dnssec_multi_signer` to `true`, as in the following example. +1. Use the [Edit DNSSEC Status endpoint](/api/resources/dns/subresources/dnssec/methods/edit/) to enable DNSSEC and activate multi-signer DNSSEC for your zone. This is done by setting `status` to `active` and `dnssec_multi_signer` to `true`, as in the following example. ```bash curl --request PATCH \ diff --git a/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-primary/setup.mdx b/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-primary/setup.mdx index 0bd55c4b9637263..1678c3f3c743598 100644 --- a/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-primary/setup.mdx +++ b/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-primary/setup.mdx @@ -77,7 +77,7 @@ To create a peer using the dashboard: -To create a peer DNS server using the API, send a [POST]() request. +To create a peer DNS server using the API, send a [POST](/api/resources/dns/subresources/zone_transfers/subresources/peers/methods/create/) request. @@ -98,7 +98,7 @@ To link a primary zone to a peer using the dashboard: -To link a primary zone to a peer using the API, send a [POST]() request with the ID of the peer you [previously created](#2-create-peer-dns-server-optional). +To link a primary zone to a peer using the API, send a [POST](/api/resources/dns/subresources/zone_transfers/subresources/incoming/methods/create/) request with the ID of the peer you [previously created](#2-create-peer-dns-server-optional). @@ -159,7 +159,7 @@ When you enable outgoing zone transfers, this will send a DNS NOTIFY message to -To enable outgoing zone transfers using the API, send a [POST]() request. +To enable outgoing zone transfers using the API, send a [POST](/api/resources/dns/subresources/zone_transfers/subresources/outgoing/methods/enable/) request. diff --git a/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-secondary/dnssec-for-secondary.mdx b/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-secondary/dnssec-for-secondary.mdx index d3348d19ce799de..b4a6cb5bb731316 100644 --- a/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-secondary/dnssec-for-secondary.mdx +++ b/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-secondary/dnssec-for-secondary.mdx @@ -42,7 +42,7 @@ In this setup, DNSSEC on your pirmary DNS provider does not need to be enabled. -1. Use the [Edit DNSSEC Status endpoint](/api/operations/dnssec-edit-dnssec-status) and set a `status` of `active` for your zone. +1. Use the [Edit DNSSEC Status endpoint](/api/resources/dns/subresources/dnssec/methods/edit/) and set a `status` of `active` for your zone. ```bash curl --request PATCH \ @@ -55,7 +55,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/dnssec \ }' ``` -2. Use the [DNSSEC Details endpoint](/api/operations/dnssec-dnssec-details) to get the necessary values to create a **DS** record at your registrar. +2. Use the [DNSSEC Details endpoint](/api/resources/dns/subresources/dnssec/methods/get/) to get the necessary values to create a **DS** record at your registrar. 3. @@ -95,7 +95,7 @@ b. Under **DNSSEC with Secondary DNS** select **Pre-signed**. -Use the [Edit DNSSEC Status endpoint](/api/operations/dnssec-edit-dnssec-status) and set the `dnssec_presigned` value to `true`. +Use the [Edit DNSSEC Status endpoint](/api/resources/dns/subresources/dnssec/methods/edit/) and set the `dnssec_presigned` value to `true`. ```bash curl --request PATCH \ diff --git a/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-secondary/proxy-traffic.mdx b/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-secondary/proxy-traffic.mdx index cbc6f041b076730..984091633d8fc67 100644 --- a/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-secondary/proxy-traffic.mdx +++ b/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-secondary/proxy-traffic.mdx @@ -58,7 +58,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/dns_settings \ }' ``` -2. For specific `A`, `AAAA`, or `CNAME` records, send a [POST](/api/operations/dns-records-for-a-zone-create-dns-record) request with the `proxied` status as `true`. +2. For specific `A`, `AAAA`, or `CNAME` records, send a [POST](/api/resources/dns/subresources/records/methods/create/) request with the `proxied` status as `true`. - Make sure the added record has the same name as the transferred record you intend to proxy. Cloudflare only looks at the name and the proxy status, so the record content does not matter. diff --git a/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-secondary/setup.mdx b/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-secondary/setup.mdx index a1771dc868ea1e0..7dac1f43fe7ad86 100644 --- a/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-secondary/setup.mdx +++ b/src/content/docs/dns/zone-setups/zone-transfers/cloudflare-as-secondary/setup.mdx @@ -90,7 +90,7 @@ To create a secondary zone using the dashboard: -To create a secondary zone using the API, send a [POST]() request with the `type` parameter set to `"secondary"`. +To create a secondary zone using the API, send a [POST](/api/resources/dns/subresources/zone_transfers/subresources/incoming/methods/create/) request with the `type` parameter set to `"secondary"`. diff --git a/src/content/docs/dns/zone-setups/zone-transfers/index.mdx b/src/content/docs/dns/zone-setups/zone-transfers/index.mdx index cecc218502b3c4c..993b6c38a307b10 100644 --- a/src/content/docs/dns/zone-setups/zone-transfers/index.mdx +++ b/src/content/docs/dns/zone-setups/zone-transfers/index.mdx @@ -22,7 +22,7 @@ With zone transfers, you have two configuration options: Peer DNS servers can be used as primary and secondary external DNS servers. The same peer can be linked to multiple primary and secondary zones. Each peer can be associated with only one Transaction Signature (TSIG). -You can manage peers via the [API](/api/operations/secondary-dns-\(-peer\)-list-peers) or the dashboard by going to **Manage Account** > **Configurations** > **DNS Zone Transfers**. +You can manage peers via the [API](/api/resources/dns/subresources/zone_transfers/subresources/peers/methods/list/) or the dashboard by going to **Manage Account** > **Configurations** > **DNS Zone Transfers**. Depending on the usage of the peer, the fields are interpreted in a different way: diff --git a/src/content/docs/durable-objects/durable-objects-rest-api.mdx b/src/content/docs/durable-objects/durable-objects-rest-api.mdx index dc4a4b92ec3ec68..bb31483101a657f 100644 --- a/src/content/docs/durable-objects/durable-objects-rest-api.mdx +++ b/src/content/docs/durable-objects/durable-objects-rest-api.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: REST API -external_link: /api/operations/durable-objects-namespace-list-namespaces +external_link: /api/resources/durable_objects/subresources/namespaces/methods/list/ sidebar: order: 5 diff --git a/src/content/docs/email-routing/api-reference.mdx b/src/content/docs/email-routing/api-reference.mdx index 0905cdee751bf6a..d4fae4c2fe53a43 100644 --- a/src/content/docs/email-routing/api-reference.mdx +++ b/src/content/docs/email-routing/api-reference.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: API reference -external_link: /api/operations/email-routing-destination-addresses-list-destination-addresses +external_link: /api/resources/email_routing/subresources/addresses/methods/list/ sidebar: order: 9 diff --git a/src/content/docs/firewall/api/cf-filters/endpoints.mdx b/src/content/docs/firewall/api/cf-filters/endpoints.mdx index 5e823ba09b07900..afa7f4c71ffeb75 100644 --- a/src/content/docs/firewall/api/cf-filters/endpoints.mdx +++ b/src/content/docs/firewall/api/cf-filters/endpoints.mdx @@ -26,7 +26,7 @@ For help with endpoints and pagination, refer to [Getting Started: Endpoints](/f The Filters API endpoints require a value for ``. -To retrieve a list of zones associated with your account, use the [List Zones](/api/operations/zones-get) operation and note the Zone ID associated with the domain for which you want to manage filters. +To retrieve a list of zones associated with your account, use the [List Zones](/api/resources/zones/methods/list/) operation and note the Zone ID associated with the domain for which you want to manage filters. ::: @@ -46,7 +46,7 @@ The Cloudflare Filters API supports the operations outlined below. Visit the pag - Create filters + Create filters POST zones/<ZONE_ID>/filters @@ -55,7 +55,7 @@ The Cloudflare Filters API supports the operations outlined below. Visit the pag - Get filters + Get filters GET zones/<ZONE_ID>/filters @@ -67,7 +67,7 @@ The Cloudflare Filters API supports the operations outlined below. Visit the pag - Get a filter + Get a filter @@ -78,7 +78,7 @@ The Cloudflare Filters API supports the operations outlined below. Visit the pag - Update filters + Update filters PUT zones/<ZONE_ID>/filters @@ -90,7 +90,7 @@ The Cloudflare Filters API supports the operations outlined below. Visit the pag - Update a filter + Update a filter @@ -101,7 +101,7 @@ The Cloudflare Filters API supports the operations outlined below. Visit the pag - Delete filters + Delete filters DELETE zones/<ZONE_ID>/filters @@ -116,7 +116,7 @@ The Cloudflare Filters API supports the operations outlined below. Visit the pag - Delete a filter + Delete a filter diff --git a/src/content/docs/firewall/api/cf-filters/json-object.mdx b/src/content/docs/firewall/api/cf-filters/json-object.mdx index edf13a197574538..ee5f79b37c20893 100644 --- a/src/content/docs/firewall/api/cf-filters/json-object.mdx +++ b/src/content/docs/firewall/api/cf-filters/json-object.mdx @@ -11,7 +11,7 @@ head: ## Filter object structure and properties -A JSON response for the [Filters API](/api/operations/filters-list-filters) has this structure: +A JSON response for the [Filters API](/api/resources/filters/methods/list/) has this structure: ```json { diff --git a/src/content/docs/firewall/api/cf-firewall-rules/endpoints.mdx b/src/content/docs/firewall/api/cf-firewall-rules/endpoints.mdx index d31eb3e45c47876..60fa913e122df6c 100644 --- a/src/content/docs/firewall/api/cf-firewall-rules/endpoints.mdx +++ b/src/content/docs/firewall/api/cf-firewall-rules/endpoints.mdx @@ -22,7 +22,7 @@ For help with endpoints and pagination, refer to [Getting Started: Endpoints](/f The Firewall Rules API endpoints require a value for ``. -To retrieve a list of zones associated with your account, use the [List Zones](/api/operations/zones-get) operation and note the zone ID associated with the domain whose firewall rules you want to manage. +To retrieve a list of zones associated with your account, use the [List Zones](/api/resources/zones/methods/list/) operation and note the zone ID associated with the domain whose firewall rules you want to manage. ::: @@ -39,7 +39,7 @@ The Cloudflare Firewall Rules API supports the operations outlined below. Visit - + Create firewall rules @@ -48,7 +48,7 @@ The Cloudflare Firewall Rules API supports the operations outlined below. Visit - + List firewall rules @@ -59,7 +59,7 @@ The Cloudflare Firewall Rules API supports the operations outlined below. Visit - + Get a firewall rule @@ -68,7 +68,7 @@ The Cloudflare Firewall Rules API supports the operations outlined below. Visit - + Update firewall rules @@ -80,7 +80,7 @@ The Cloudflare Firewall Rules API supports the operations outlined below. Visit - + Update a firewall rule @@ -89,7 +89,7 @@ The Cloudflare Firewall Rules API supports the operations outlined below. Visit - + Delete firewall rules @@ -104,7 +104,7 @@ The Cloudflare Firewall Rules API supports the operations outlined below. Visit - + Delete a firewall rule diff --git a/src/content/docs/firewall/api/cf-firewall-rules/json-object.mdx b/src/content/docs/firewall/api/cf-firewall-rules/json-object.mdx index 1f725c9e9dbf407..321ad8355017b31 100644 --- a/src/content/docs/firewall/api/cf-firewall-rules/json-object.mdx +++ b/src/content/docs/firewall/api/cf-firewall-rules/json-object.mdx @@ -11,7 +11,7 @@ head: ## Firewall rule example JSON response -A JSON response for the [Firewall Rules API](/api/operations/firewall-rules-list-firewall-rules) has this structure: +A JSON response for the [Firewall Rules API](/api/resources/firewall/subresources/rules/methods/list/) has this structure: ```json { diff --git a/src/content/docs/firewall/cf-firewall-rules/order-priority.mdx b/src/content/docs/firewall/cf-firewall-rules/order-priority.mdx index 575208c40ed97c2..42b67e157ebaa59 100644 --- a/src/content/docs/firewall/cf-firewall-rules/order-priority.mdx +++ b/src/content/docs/firewall/cf-firewall-rules/order-priority.mdx @@ -62,7 +62,7 @@ The **Priority** column in the rules list displays the priority value for each r ## Working with priority ordering -Cloudflare has designed priority ordering to be extremely flexible. This flexibility is particularly useful for managing large rulesets programmatically via the Cloudflare API. Use the Update firewall rules command to set the `priority` property. Refer to [Cloudflare API: Firewall rules](/api/operations/firewall-rules-list-firewall-rules) for details. +Cloudflare has designed priority ordering to be extremely flexible. This flexibility is particularly useful for managing large rulesets programmatically via the Cloudflare API. Use the Update firewall rules command to set the `priority` property. Refer to [Cloudflare API: Firewall rules](/api/resources/firewall/subresources/rules/methods/list/) for details. While your priority numbering scheme can be arbitrary, keep the following in mind: diff --git a/src/content/docs/fundamentals/api/how-to/create-via-api.mdx b/src/content/docs/fundamentals/api/how-to/create-via-api.mdx index 97d9def5530a827..06c1fda17b2428a 100644 --- a/src/content/docs/fundamentals/api/how-to/create-via-api.mdx +++ b/src/content/docs/fundamentals/api/how-to/create-via-api.mdx @@ -24,7 +24,7 @@ Cloudflare also recommends limiting the use of the token via client IP address f ## Creating API tokens with the API -Once you create an API token that can create other tokens, you can now use it in the API. Refer to the [API schema docs](/api/operations/user-api-tokens-create-token) for more information. +Once you create an API token that can create other tokens, you can now use it in the API. Refer to the [API schema docs](/api/resources/user/subresources/tokens/methods/create/) for more information. To create a token: @@ -75,7 +75,7 @@ API token policies support three resource types: `User`, `Account`, and `Zone`. :::note -Fetch each object's ID by calling the appropriate `GET ` API. Refer to [User](/api/operations/user-user-details), [Account](/api/operations/accounts-list-accounts), and [Zone](/api/operations/zones-get) documentation for more details. +Fetch each object's ID by calling the appropriate `GET ` API. Refer to [User](/api/resources/user/methods/get/), [Account](/api/resources/accounts/methods/list/), and [Zone](/api/resources/zones/methods/list/) documentation for more details. ::: ##### Account @@ -99,7 +99,7 @@ For user resources, you can only reference yourself, which is denoted as:`"com.c #### Permission groups -Determine what permission groups should be applied. Refer to the full list of permission groups either in [the documentation](/fundamentals/api/reference/permissions/) or fetch the permission groups [via the API](/api/operations/permission-groups-list-permission-groups). It is only required to pass the `id` of the permission group in the policy. Permission groups are scoped to specific resources, so a permission group in a policy will only apply to the resource type it is scoped for. +Determine what permission groups should be applied. Refer to the full list of permission groups either in [the documentation](/fundamentals/api/reference/permissions/) or fetch the permission groups [via the API](/api/resources/user/subresources/tokens/subresources/permission_groups/methods/list/). It is only required to pass the `id` of the permission group in the policy. Permission groups are scoped to specific resources, so a permission group in a policy will only apply to the resource type it is scoped for. ### 2. Define the restrictions diff --git a/src/content/docs/fundamentals/api/how-to/make-api-calls.mdx b/src/content/docs/fundamentals/api/how-to/make-api-calls.mdx index 7eadf8ccfdb8e40..846c34713bcbb48 100644 --- a/src/content/docs/fundamentals/api/how-to/make-api-calls.mdx +++ b/src/content/docs/fundamentals/api/how-to/make-api-calls.mdx @@ -37,7 +37,7 @@ For specific guidance on making API calls, refer to the following resources: ## Query parameters -Several Cloudflare endpoints have optional query parameters to filter incoming results, such as [List Zones](/api/operations/zones-get). +Several Cloudflare endpoints have optional query parameters to filter incoming results, such as [List Zones](/api/resources/zones/methods/list/). When adding those query parameters, make sure you enclose the URL in quotes `'` (just like the header values), or the API call might error. diff --git a/src/content/docs/fundamentals/api/how-to/restrict-tokens.mdx b/src/content/docs/fundamentals/api/how-to/restrict-tokens.mdx index 663f963eee29327..c008a9ad18cdd8c 100644 --- a/src/content/docs/fundamentals/api/how-to/restrict-tokens.mdx +++ b/src/content/docs/fundamentals/api/how-to/restrict-tokens.mdx @@ -19,7 +19,7 @@ Client IP address restrictions control which IP addresses can make API requests :::note -Client IP address range filtering is not applied to the [Verify Token](https://developers.cloudflare.com/api/operations/user-api-tokens-verify-token) endpoint. +Client IP address range filtering is not applied to the [Verify Token](https://developers.cloudflare.com/api/resources/user/subresources/tokens/methods/verify/) endpoint. ::: diff --git a/src/content/docs/fundamentals/api/reference/permissions.mdx b/src/content/docs/fundamentals/api/reference/permissions.mdx index acde25acba58a35..a47dffbcf817981 100644 --- a/src/content/docs/fundamentals/api/reference/permissions.mdx +++ b/src/content/docs/fundamentals/api/reference/permissions.mdx @@ -15,7 +15,7 @@ Permissions are segmented into three categories based on resource: Each category contains permission groups related to those resources. DNS permissions belong to the Zone category, while Billing permissions belong to the Account category. Below is a list of the available token permissions. -To obtain an updated list of token permissions, including the permission ID and the scope of each permission, use the [List permission groups](/api/operations/permission-groups-list-permission-groups) endpoint. +To obtain an updated list of token permissions, including the permission ID and the scope of each permission, use the [List permission groups](/api/resources/user/subresources/tokens/subresources/permission_groups/methods/list/) endpoint. ## User permissions diff --git a/src/content/docs/fundamentals/basic-tasks/trace-request/how-to.mdx b/src/content/docs/fundamentals/basic-tasks/trace-request/how-to.mdx index bda9fd698218410..1138daf13fee7a7 100644 --- a/src/content/docs/fundamentals/basic-tasks/trace-request/how-to.mdx +++ b/src/content/docs/fundamentals/basic-tasks/trace-request/how-to.mdx @@ -61,7 +61,7 @@ To run a trace later with the same configuration: ## Use Trace via API -Use the [Request Trace](/api/operations/account-request-tracer-request-trace) operation to perform a trace using the Cloudflare API. +Use the [Request Trace](/api/resources/request_tracers/subresources/traces/methods/create/) operation to perform a trace using the Cloudflare API. *** diff --git a/src/content/docs/fundamentals/reference/connection-limits.mdx b/src/content/docs/fundamentals/reference/connection-limits.mdx index 5f05ff4113b4fab..65135605f8ecd05 100644 --- a/src/content/docs/fundamentals/reference/connection-limits.mdx +++ b/src/content/docs/fundamentals/reference/connection-limits.mdx @@ -28,7 +28,7 @@ If you are using [Cloudflare tunnels](/cloudflare-one/connections/connect-networ | TCP ACK Timeout | 90 | [522](/support/troubleshooting/cloudflare-errors/troubleshooting-cloudflare-5xx-errors/#error-522-connection-timed-out) | No | | TCP Keep-Alive Interval | 30 | [520](/support/troubleshooting/cloudflare-errors/troubleshooting-cloudflare-5xx-errors/#error-520-web-server-returns-an-unknown-error) | No | | Proxy Idle Timeout | 900 | [520](/support/troubleshooting/cloudflare-errors/troubleshooting-cloudflare-5xx-errors/#error-520-web-server-returns-an-unknown-error) | No | -| Proxy Read Timeout | 100 | [524](/support/troubleshooting/cloudflare-errors/troubleshooting-cloudflare-5xx-errors/#error-524-a-timeout-occurred) | [Yes](/api/operations/zone-settings-edit-single-setting) | +| Proxy Read Timeout | 100 | [524](/support/troubleshooting/cloudflare-errors/troubleshooting-cloudflare-5xx-errors/#error-524-a-timeout-occurred) | [Yes](/api/resources/zones/subresources/settings/methods/edit/) | | Proxy Write Timeout | 30 | [524](/support/troubleshooting/cloudflare-errors/troubleshooting-cloudflare-5xx-errors/#error-524-a-timeout-occurred) | No | | HTTP/2 Pings to Origin | Off | - | Yes | | HTTP/2 Connection Idle | 900 | No | No | diff --git a/src/content/docs/fundamentals/setup/manage-domains/add-multiple-sites-automation.mdx b/src/content/docs/fundamentals/setup/manage-domains/add-multiple-sites-automation.mdx index 0afc6a5b06f84e7..57804f9b6bd02d3 100644 --- a/src/content/docs/fundamentals/setup/manage-domains/add-multiple-sites-automation.mdx +++ b/src/content/docs/fundamentals/setup/manage-domains/add-multiple-sites-automation.mdx @@ -97,8 +97,8 @@ Cloudflare offers a [quick scan](/dns/zone-setups/reference/dns-quick-scan/) tha This API call requires the domain `ID`. This can be found in the following locations: -- [Create Zone](/api/operations/zones-post#Request) -- [List Zones](/api/operations/zones-get) +- [Create Zone](/api/resources/zones/methods/create/#Request) +- [List Zones](/api/resources/zones/methods/list/) Using `jq` with the first option above, modify your script `add-multiple-zones.sh` to extract the domain ID and run a subsequent API call to quick scan DNS records. @@ -139,8 +139,8 @@ For each domain to become active on Cloudflare, it must be activated in either [ You can find your zones nameservers in the following locations: -- [Create Zone](/api/operations/zones-post#Request) -- [Zone Details](/api/operations/zones-0-get) +- [Create Zone](/api/resources/zones/methods/create/#Request) +- [Zone Details](/api/resources/zones/methods/get/) 1. Modify your script `add-multiple-zones.sh` to print a CSV with data from the `Create Zone` JSON response. diff --git a/src/content/docs/fundamentals/subscriptions-and-billing/change-plan.mdx b/src/content/docs/fundamentals/subscriptions-and-billing/change-plan.mdx index fd84fd862a389ec..7f2299deb6a9420 100644 --- a/src/content/docs/fundamentals/subscriptions-and-billing/change-plan.mdx +++ b/src/content/docs/fundamentals/subscriptions-and-billing/change-plan.mdx @@ -41,9 +41,9 @@ To change the Cloudflare plan for a domain in the dashboard: -To change the Cloudflare plan for a domain using the API, first send a [`GET`](/api/operations/zone-rate-plan-list-available-plans) request to review available subscriptions. +To change the Cloudflare plan for a domain using the API, first send a [`GET`](/api/resources/zones/subresources/plans/methods/list/) request to review available subscriptions. -Then, send a [`PUT`](/api/operations/zone-subscription-update-zone-subscription) request with your desired plan type in the `rate_plan` object. +Then, send a [`PUT`](/api/resources/zones/subresources/subscriptions/methods/update/) request with your desired plan type in the `rate_plan` object. @@ -77,6 +77,6 @@ To change the duration of your Cloudflare plan in the dashboard: -To change the duration of a Cloudflare plan for a domain using the API, send a [`PUT`](/api/operations/zone-subscription-update-zone-subscription) request with an updated value for the `frequency` parameter. +To change the duration of a Cloudflare plan for a domain using the API, send a [`PUT`](/api/resources/zones/subresources/subscriptions/methods/update/) request with an updated value for the `frequency` parameter. diff --git a/src/content/docs/hyperdrive/hyperdrive-rest-api.mdx b/src/content/docs/hyperdrive/hyperdrive-rest-api.mdx index be26ef8356a711d..3ca0fadb81a2846 100644 --- a/src/content/docs/hyperdrive/hyperdrive-rest-api.mdx +++ b/src/content/docs/hyperdrive/hyperdrive-rest-api.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: Hyperdrive REST API -external_link: /api/operations/list-hyperdrive +external_link: /api/resources/hyperdrive/subresources/configs/methods/list/ sidebar: order: 10 diff --git a/src/content/docs/images/images-api.mdx b/src/content/docs/images/images-api.mdx index 331b1819b22ceeb..9ccfe01ac8a2480 100644 --- a/src/content/docs/images/images-api.mdx +++ b/src/content/docs/images/images-api.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: Images API Reference -external_link: /api/operations/cloudflare-images-list-images +external_link: /api/resources/images/subresources/v1/methods/list/ sidebar: order: 8 diff --git a/src/content/docs/images/manage-images/create-variants.mdx b/src/content/docs/images/manage-images/create-variants.mdx index 958698449edc268..f95508dd6fc072d 100644 --- a/src/content/docs/images/manage-images/create-variants.mdx +++ b/src/content/docs/images/manage-images/create-variants.mdx @@ -21,7 +21,7 @@ Resize via the Cloudflare dashboard. ## Resize via the API -Make a `POST` request to [create a variant](/api/operations/cloudflare-images-variants-create-a-variant). +Make a `POST` request to [create a variant](/api/resources/images/subresources/v1/subresources/variants/methods/create/). ```bash curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/images/v1/variants" \ diff --git a/src/content/docs/images/manage-images/delete-images.mdx b/src/content/docs/images/manage-images/delete-images.mdx index a51f46f668a91f3..0b2bf6b67241a5b 100644 --- a/src/content/docs/images/manage-images/delete-images.mdx +++ b/src/content/docs/images/manage-images/delete-images.mdx @@ -19,7 +19,7 @@ Your image will be deleted from your account. ## Delete images via the API -Make a `DELETE` request to the [delete image endpoint](/api/operations/cloudflare-images-delete-image). `{image_id}` must be fully URL encoded in the API call URL. +Make a `DELETE` request to the [delete image endpoint](/api/resources/images/subresources/v1/methods/delete/). `{image_id}` must be fully URL encoded in the API call URL. ```bash curl --request DELETE https://api.cloudflare.com/client/v4/accounts/{account_id}/images/v1/{image_id} \ diff --git a/src/content/docs/images/manage-images/enable-flexible-variants.mdx b/src/content/docs/images/manage-images/enable-flexible-variants.mdx index 11e9072f4c8e207..ea53432f9a4cfa0 100644 --- a/src/content/docs/images/manage-images/enable-flexible-variants.mdx +++ b/src/content/docs/images/manage-images/enable-flexible-variants.mdx @@ -16,7 +16,7 @@ Flexible variants allow you to create variants with dynamic resizing which can p ## Enable flexible variants via the API -Make a `PATCH` request to the [Update a variant endpoint](/api/operations/cloudflare-images-variants-update-a-variant). +Make a `PATCH` request to the [Update a variant endpoint](/api/resources/images/subresources/v1/subresources/variants/methods/edit/). ```bash curl --request PATCH https://api.cloudflare.com/client/v4/accounts/{account_id}/images/v1/config \ diff --git a/src/content/docs/images/upload-images/images-batch.mdx b/src/content/docs/images/upload-images/images-batch.mdx index 823bf70089a1783..7b32144e3d84acb 100644 --- a/src/content/docs/images/upload-images/images-batch.mdx +++ b/src/content/docs/images/upload-images/images-batch.mdx @@ -28,12 +28,12 @@ curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/images/v1/batch After getting your token, you can use it to make requests for: -* [Upload an image](https://developers.cloudflare.com/api/operations/cloudflare-images-upload-an-image-via-url) - `POST /images/v1` -* [Delete an image](https://developers.cloudflare.com/api/operations/cloudflare-images-delete-image) - `DELETE /images/v1/{identifier}` -* [Image details](https://developers.cloudflare.com/api/operations/cloudflare-images-image-details) - `GET /images/v1/{identifier}` -* [Update image](https://developers.cloudflare.com/api/operations/cloudflare-images-update-image) - `PATCH /images/v1/{identifier}` -* [List images V2](https://developers.cloudflare.com/api/operations/cloudflare-images-list-images-v2) - `GET /images/v2` -* [Direct upload V2](https://developers.cloudflare.com/api/operations/cloudflare-images-create-authenticated-direct-upload-url-v-2) - `POST /images/v2/direct_upload` +* [Upload an image](https://developers.cloudflare.com/api/resources/images/subresources/v1/methods/create/) - `POST /images/v1` +* [Delete an image](https://developers.cloudflare.com/api/resources/images/subresources/v1/methods/delete/) - `DELETE /images/v1/{identifier}` +* [Image details](https://developers.cloudflare.com/api/resources/images/subresources/v1/methods/get/) - `GET /images/v1/{identifier}` +* [Update image](https://developers.cloudflare.com/api/resources/images/subresources/v1/methods/edit/) - `PATCH /images/v1/{identifier}` +* [List images V2](https://developers.cloudflare.com/api/resources/images/subresources/v2/methods/list/) - `GET /images/v2` +* [Direct upload V2](https://developers.cloudflare.com/api/resources/images/subresources/v2/subresources/direct_uploads/methods/create/) - `POST /images/v2/direct_upload` These options use a different host and a different path with the same method, request, and response bodies. diff --git a/src/content/docs/kv/api/delete-key-value-pairs.mdx b/src/content/docs/kv/api/delete-key-value-pairs.mdx index ede4552815d6711..426162a73131387 100644 --- a/src/content/docs/kv/api/delete-key-value-pairs.mdx +++ b/src/content/docs/kv/api/delete-key-value-pairs.mdx @@ -68,9 +68,9 @@ Calling the `delete()` method will remove the key and value from your KV namespa ### Delete data in bulk -Delete more than one key-value pair at a time with Wrangler or [via the REST API](/api/operations/workers-kv-namespace-delete-multiple-key-value-pairs). +Delete more than one key-value pair at a time with Wrangler or [via the REST API](/api/resources/kv/subresources/namespaces/methods/bulk_delete/). The bulk REST API can accept up to 10,000 KV pairs at once. Bulk writes are not supported using the [KV binding](/kv/concepts/kv-bindings/). ## Other methods to access KV -You can also [delete key-value pairs from the command line with Wrangler](/kv/reference/kv-commands/#delete) or [with the REST API](/api/operations/workers-kv-namespace-delete-key-value-pair). +You can also [delete key-value pairs from the command line with Wrangler](/kv/reference/kv-commands/#delete) or [with the REST API](/api/resources/kv/subresources/namespaces/subresources/values/methods/delete/). diff --git a/src/content/docs/kv/api/list-keys.mdx b/src/content/docs/kv/api/list-keys.mdx index fefca467beb7bce..de36b9604bd9b66 100644 --- a/src/content/docs/kv/api/list-keys.mdx +++ b/src/content/docs/kv/api/list-keys.mdx @@ -159,4 +159,4 @@ await NAMESPACE.put(key, "", { ``` ## Other methods to access KV -You can also [list keys on the command line with Wrangler](/kv/reference/kv-commands/#list) or [with the REST API](/api/operations/workers-kv-namespace-list-a-namespace'-s-keys). \ No newline at end of file +You can also [list keys on the command line with Wrangler](/kv/reference/kv-commands/#list) or [with the REST API](/api/resources/kv/subresources/namespaces/subresources/keys/methods/list/). \ No newline at end of file diff --git a/src/content/docs/kv/api/read-key-value-pairs.mdx b/src/content/docs/kv/api/read-key-value-pairs.mdx index 1f90e20462135d3..028ed32e44827db 100644 --- a/src/content/docs/kv/api/read-key-value-pairs.mdx +++ b/src/content/docs/kv/api/read-key-value-pairs.mdx @@ -166,5 +166,5 @@ The effective `cacheTtl` of an already cached item can be reduced by getting it ## Other methods to access KV -You can [read key-value pairs from the command line with Wrangler](/kv/reference/kv-commands/#get) and [from the REST API](/api/operations/workers-kv-namespace-read-key-value-pair). +You can [read key-value pairs from the command line with Wrangler](/kv/reference/kv-commands/#get) and [from the REST API](/api/resources/kv/subresources/namespaces/subresources/values/methods/get/). diff --git a/src/content/docs/kv/api/write-key-value-pairs.mdx b/src/content/docs/kv/api/write-key-value-pairs.mdx index b11cce7f5276ee4..339f6d1be482f69 100644 --- a/src/content/docs/kv/api/write-key-value-pairs.mdx +++ b/src/content/docs/kv/api/write-key-value-pairs.mdx @@ -84,7 +84,7 @@ Refer to [How KV works](/kv/concepts/how-kv-works/) for more information on this ### Write data in bulk -Write more than one key-value pair at a time with Wrangler or [via the REST API](/api/operations/workers-kv-namespace-write-multiple-key-value-pairs). +Write more than one key-value pair at a time with Wrangler or [via the REST API](/api/resources/kv/subresources/namespaces/methods/bulk_update/). The bulk API can accept up to 10,000 KV pairs at once. @@ -270,4 +270,4 @@ async function retryWithBackoff( ## Other methods to access KV -You can also [write key-value pairs from the command line with Wrangler](/kv/reference/kv-commands/#create) and [write data via the REST API](/api/operations/workers-kv-namespace-write-key-value-pair-with-metadata). +You can also [write key-value pairs from the command line with Wrangler](/kv/reference/kv-commands/#create) and [write data via the REST API](/api/resources/kv/subresources/namespaces/subresources/values/methods/update/). diff --git a/src/content/docs/kv/platform/pricing.mdx b/src/content/docs/kv/platform/pricing.mdx index 4afa72a15be8744..21b88259adda7ab 100644 --- a/src/content/docs/kv/platform/pricing.mdx +++ b/src/content/docs/kv/platform/pricing.mdx @@ -14,7 +14,7 @@ import { Render } from "~/components" Frequently asked questions related to KV pricing: -* When writing via KV's [REST API](/api/operations/workers-kv-namespace-write-multiple-key-value-pairs), how are writes charged? +* When writing via KV's [REST API](/api/resources/kv/subresources/namespaces/methods/bulk_update/), how are writes charged? Each key-value pair in the `PUT` request is counted as a single write, identical to how each call to `PUT` in the Workers API counts as a write. Writing 5,000 keys via the REST API incurs the same write costs as making 5,000 `PUT` calls in a Worker. diff --git a/src/content/docs/kv/workers-kv-api.mdx b/src/content/docs/kv/workers-kv-api.mdx index fb7bee6e30ca232..fe2d97067eeaaea 100644 --- a/src/content/docs/kv/workers-kv-api.mdx +++ b/src/content/docs/kv/workers-kv-api.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: KV REST API -external_link: /api/operations/workers-kv-namespace-list-namespaces +external_link: /api/resources/kv/subresources/namespaces/methods/list/ sidebar: order: 8 diff --git a/src/content/docs/learning-paths/mtls/mtls-app-security/related-features.mdx b/src/content/docs/learning-paths/mtls/mtls-app-security/related-features.mdx index d46d3cba02fb140..6f5b2ea5345a781 100644 --- a/src/content/docs/learning-paths/mtls/mtls-app-security/related-features.mdx +++ b/src/content/docs/learning-paths/mtls/mtls-app-security/related-features.mdx @@ -39,7 +39,7 @@ There are multiple ways to [forward a client certificate](/ssl/client-certificat If you already have mTLS implemented, client certificates are already installed on devices, and therefore you would like to use your own Certificate Authority (CA), this is possible by [bringing your own CA for mTLS](/ssl/client-certificates/byo-ca/). -Here you can use the [Replace Hostname Associations API endpoint](/api/operations/client-certificate-for-a-zone-put-hostname-associations) to enable mTLS in each hostname that should use the CA for mTLS validation, essentially associating your CAs specific with hostnames. +Here you can use the [Replace Hostname Associations API endpoint](/api/resources/certificate_authorities/subresources/hostname_associations/methods/update/) to enable mTLS in each hostname that should use the CA for mTLS validation, essentially associating your CAs specific with hostnames. :::note Each Enterprise account can upload up to five CAs, though this can be increased. Contact your account team if you require more. diff --git a/src/content/docs/learning-paths/mtls/mtls-cloudflare-access/index.mdx b/src/content/docs/learning-paths/mtls/mtls-cloudflare-access/index.mdx index 27f77b9a3a54c4d..0ff4bdecf6b8957 100644 --- a/src/content/docs/learning-paths/mtls/mtls-cloudflare-access/index.mdx +++ b/src/content/docs/learning-paths/mtls/mtls-cloudflare-access/index.mdx @@ -104,7 +104,7 @@ cfssl gencert -ca=ca.pem -ca-key=ca-key.pem -config=ca-config.json -profile=clie Follow the steps outlined in the [developer documentation](/cloudflare-one/identity/devices/access-integrations/mutual-tls-authentication/#add-mtls-authentication-to-your-access-configuration). -Using the example from Step 2: upload the `ca.pem` to your Cloudflare Access account via the [dashboard](/cloudflare-one/identity/devices/access-integrations/mutual-tls-authentication/#add-mtls-authentication-to-your-access-configuration) or [Cloudflare API](/api/operations/access-mtls-authentication-add-an-mtls-certificate). +Using the example from Step 2: upload the `ca.pem` to your Cloudflare Access account via the [dashboard](/cloudflare-one/identity/devices/access-integrations/mutual-tls-authentication/#add-mtls-authentication-to-your-access-configuration) or [Cloudflare API](/api/resources/zero_trust/subresources/access/subresources/certificates/methods/create/). Do not forget to enter the fully-qualified domain names (FQDN / associated hostnames) that will use this CA certificate. diff --git a/src/content/docs/learning-paths/secure-o365-email/monitor-your-inbox/monitor-detections.mdx b/src/content/docs/learning-paths/secure-o365-email/monitor-your-inbox/monitor-detections.mdx index 181c354cf751d0f..1a95b9f4f14d728 100644 --- a/src/content/docs/learning-paths/secure-o365-email/monitor-your-inbox/monitor-detections.mdx +++ b/src/content/docs/learning-paths/secure-o365-email/monitor-your-inbox/monitor-detections.mdx @@ -32,4 +32,4 @@ Additional information on search can be found on the [Screen criteria](/email-se ### Export messages -With Email Security, you can export messages to a CSV file. Via the dashboard, you can export up to 1,000 rows. If you want to export all messages, you can use the [API](https://developers.cloudflare.com/api/operations/email_security_get_message). \ No newline at end of file +With Email Security, you can export messages to a CSV file. Via the dashboard, you can export up to 1,000 rows. If you want to export all messages, you can use the [API](https://developers.cloudflare.com/api/resources/email_security/subresources/investigate/methods/get/). \ No newline at end of file diff --git a/src/content/docs/learning-paths/zero-trust-web-access/advanced-workflows/isolate-application.mdx b/src/content/docs/learning-paths/zero-trust-web-access/advanced-workflows/isolate-application.mdx index 128e997b4c12651..7d34d4c83455093 100644 --- a/src/content/docs/learning-paths/zero-trust-web-access/advanced-workflows/isolate-application.mdx +++ b/src/content/docs/learning-paths/zero-trust-web-access/advanced-workflows/isolate-application.mdx @@ -93,7 +93,7 @@ curl https://api.cloudflare.com/client/v4/accounts/{account_id}/access/apps/{app }' ``` -To create a list of serial numbers, refer to [Create Zero Trust list](/api/operations/zero-trust-lists-create-zero-trust-list). +To create a list of serial numbers, refer to [Create Zero Trust list](/api/resources/zero_trust/subresources/gateway/subresources/lists/methods/create/). @@ -220,7 +220,7 @@ curl https://api.cloudflare.com/client/v4/accounts/{account_id}/gateway/rules \ }' ``` -To create a list of serial numbers, refer to [Create Zero Trust list](/api/operations/zero-trust-lists-create-zero-trust-list). +To create a list of serial numbers, refer to [Create Zero Trust list](/api/resources/zero_trust/subresources/gateway/subresources/lists/methods/create/). @@ -315,6 +315,6 @@ curl https://api.cloudflare.com/client/v4/accounts/{account_id}/gateway/rules \ }' ``` -To configure a DLP profile, refer to [Update predefined profile](/api/operations/dlp-profiles-update-predefined-profile) or [Create custom profile](/api/operations/dlp-profiles-create-custom-profiles). +To configure a DLP profile, refer to [Update predefined profile](/api/resources/zero_trust/subresources/dlp/subresources/profiles/subresources/predefined/methods/update/) or [Create custom profile](/api/resources/zero_trust/subresources/dlp/subresources/profiles/subresources/custom/methods/create/). diff --git a/src/content/docs/load-balancing/additional-options/load-balancing-china.mdx b/src/content/docs/load-balancing/additional-options/load-balancing-china.mdx index 4937b16f09dce71..655ad712c77dce6 100644 --- a/src/content/docs/load-balancing/additional-options/load-balancing-china.mdx +++ b/src/content/docs/load-balancing/additional-options/load-balancing-china.mdx @@ -13,7 +13,7 @@ To enable load balancers to be deployed to the [China Network](/china-network/), 1. A valid [ICP license](/china-network/concepts/icp/) for the zone in question. 2. The zone must be provisioned with access to the China Network. -Once these two criteria are met, create a load balancer by sending a POST request to the following endpoint. To deploy to the China Network, the `networks` array in the API call must contain `jdcloud` as a value in addition to `cloudflare`. Refer to the [Cloudflare API documentation](/api/operations/load-balancers-create-load-balancer#request-body) for details on the required fields and their formats. When selecting a region for pool health checks, `China` is now available to be selected in both the dashboard and API. +Once these two criteria are met, create a load balancer by sending a POST request to the following endpoint. To deploy to the China Network, the `networks` array in the API call must contain `jdcloud` as a value in addition to `cloudflare`. Refer to the [Cloudflare API documentation](/api/resources/load_balancers/methods/create/#request-body) for details on the required fields and their formats. When selecting a region for pool health checks, `China` is now available to be selected in both the dashboard and API. ```bash https://api.cloudflare.com/client/v4/zones/{zone_id}/load_balancers diff --git a/src/content/docs/load-balancing/additional-options/load-shedding.mdx b/src/content/docs/load-balancing/additional-options/load-shedding.mdx index 4db29e153b60a08..1ef0f50c790e117 100644 --- a/src/content/docs/load-balancing/additional-options/load-shedding.mdx +++ b/src/content/docs/load-balancing/additional-options/load-shedding.mdx @@ -58,7 +58,7 @@ When choosing a **Shed %**, start with a small percentage and increase gradually ### Configure via API -To enable load shedding for a specific pool via the API, [update the values](/api/operations/account-load-balancer-pools-update-pool) for the pool's `load_shedding` object. +To enable load shedding for a specific pool via the API, [update the values](/api/resources/load_balancers/subresources/pools/methods/update/) for the pool's `load_shedding` object.
diff --git a/src/content/docs/load-balancing/additional-options/spectrum.mdx b/src/content/docs/load-balancing/additional-options/spectrum.mdx index 95f72f272ad3fef..afa4e31031593cd 100644 --- a/src/content/docs/load-balancing/additional-options/spectrum.mdx +++ b/src/content/docs/load-balancing/additional-options/spectrum.mdx @@ -53,7 +53,7 @@ The exact settings will vary depending on your use case. Refer to the following 9. On the **Review** page: * Review your configuration and make any changes. * If you set traffic steering to **Off**, re-order the pools in your load balancer to adjust the fallback order. - * If you chose to set traffic steering to Random, you can [set weights to your pools](/load-balancing/understand-basics/traffic-steering/steering-policies/standard-options/#random-steering) (via the [API](/api/operations/load-balancers-create-load-balancer)) to determine the percentage of traffic sent to each pool. + * If you chose to set traffic steering to Random, you can [set weights to your pools](/load-balancing/understand-basics/traffic-steering/steering-policies/standard-options/#random-steering) (via the [API](/api/resources/load_balancers/methods/create/)) to determine the percentage of traffic sent to each pool. * Choose whether to **Save as Draft** or **Save and Deploy**. ### 2. Configure your Spectrum application diff --git a/src/content/docs/load-balancing/api-reference.mdx b/src/content/docs/load-balancing/api-reference.mdx index 6f51cc033f1b360..b958198d8b8060a 100644 --- a/src/content/docs/load-balancing/api-reference.mdx +++ b/src/content/docs/load-balancing/api-reference.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: API reference -external_link: /api/operations/load-balancers-load-balancer-details +external_link: /api/resources/load_balancers/methods/get/ sidebar: order: 152 diff --git a/src/content/docs/load-balancing/load-balancers/create-load-balancer.mdx b/src/content/docs/load-balancing/load-balancers/create-load-balancer.mdx index 46a16fd664b787d..720050fe3a1ab23 100644 --- a/src/content/docs/load-balancing/load-balancers/create-load-balancer.mdx +++ b/src/content/docs/load-balancing/load-balancers/create-load-balancer.mdx @@ -54,7 +54,7 @@ To edit a load balancer in the dashboard: When you edit a load balancer with the API, your request type depends on how much you want to edit. -To update specific settings without having to resubmit the entire configuration, use a [PATCH](/api/operations/load-balancers-patch-load-balancer) request. For broader changes, use a [PUT](/api/operations/load-balancers-update-load-balancer) request. +To update specific settings without having to resubmit the entire configuration, use a [PATCH](/api/resources/load_balancers/methods/edit/) request. For broader changes, use a [PUT](/api/resources/load_balancers/methods/update/) request. @@ -73,7 +73,7 @@ To delete a load balancer in the dashboard: -To delete a load balancer using the API, send a [DELETE](/api/operations/load-balancers-delete-load-balancer) request. +To delete a load balancer using the API, send a [DELETE](/api/resources/load_balancers/methods/delete/) request. diff --git a/src/content/docs/load-balancing/load-balancers/index.mdx b/src/content/docs/load-balancing/load-balancers/index.mdx index e84f875ff7621f9..e7b732bae928b24 100644 --- a/src/content/docs/load-balancing/load-balancers/index.mdx +++ b/src/content/docs/load-balancing/load-balancers/index.mdx @@ -48,7 +48,7 @@ For step-by-step guidance, refer to [Create a load balancer](/load-balancing/loa ## Properties -For an up-to-date list of load balancer properties, refer to [Load balancer properties](/api/operations/load-balancers-load-balancer-details) in the Cloudflare API documentation. +For an up-to-date list of load balancer properties, refer to [Load balancer properties](/api/resources/load_balancers/methods/get/) in the Cloudflare API documentation. *** @@ -58,9 +58,9 @@ The Cloudflare API supports the following commands for load balancers. | Command | Method | Endpoint | | ------------------------------------------------------------------------------------- | -------- | ------------------------------------ | -| [Create Load Balancer](/api/operations/load-balancers-create-load-balancer) | `POST` | `/zones/:zone_id/load_balancers` | -| [Delete Load Balancer](/api/operations/load-balancers-delete-load-balancer) | `DELETE` | `/zones/:zone_id/load_balancers/:id` | -| [List Load Balancers](/api/operations/load-balancers-list-load-balancers) | `GET` | `/zones/:zone_id/load_balancers` | -| [Load Balancer Details](/api/operations/load-balancers-load-balancer-details) | `GET` | `/zones/:zone_id/load_balancers/:id` | -| [Overwrite specific properties](/api/operations/load-balancers-patch-load-balancer) | `PATCH` | `/zones/:zone_id/load_balancers/:id` | -| [Overwrite entire Load Balancer](/api/operations/load-balancers-update-load-balancer) | `PUT` | `/zones/:zone_id/load_balancers/:id` | +| [Create Load Balancer](/api/resources/load_balancers/methods/create/) | `POST` | `/zones/:zone_id/load_balancers` | +| [Delete Load Balancer](/api/resources/load_balancers/methods/delete/) | `DELETE` | `/zones/:zone_id/load_balancers/:id` | +| [List Load Balancers](/api/resources/load_balancers/methods/list/) | `GET` | `/zones/:zone_id/load_balancers` | +| [Load Balancer Details](/api/resources/load_balancers/methods/get/) | `GET` | `/zones/:zone_id/load_balancers/:id` | +| [Overwrite specific properties](/api/resources/load_balancers/methods/edit/) | `PATCH` | `/zones/:zone_id/load_balancers/:id` | +| [Overwrite entire Load Balancer](/api/resources/load_balancers/methods/update/) | `PUT` | `/zones/:zone_id/load_balancers/:id` | diff --git a/src/content/docs/load-balancing/monitors/create-monitor.mdx b/src/content/docs/load-balancing/monitors/create-monitor.mdx index 1d1c27b1b5c27d0..9b648b706e02d9a 100644 --- a/src/content/docs/load-balancing/monitors/create-monitor.mdx +++ b/src/content/docs/load-balancing/monitors/create-monitor.mdx @@ -79,7 +79,7 @@ To edit a monitor in the dashboard: When you edit a monitor with the API, your request type depends on how much you want to edit. -To update specific settings without having to resubmit the entire configuration, use a [PATCH](/api/operations/account-load-balancer-monitors-patch-monitor) request. For broader changes, use a [PUT](/api/operations/account-load-balancer-monitors-update-monitor) request. +To update specific settings without having to resubmit the entire configuration, use a [PATCH](/api/resources/load_balancers/subresources/monitors/methods/edit/) request. For broader changes, use a [PUT](/api/resources/load_balancers/subresources/monitors/methods/update/) request. @@ -97,6 +97,6 @@ To delete a monitor in the dashboard: -To delete a monitor using the API, send a [DELETE](/api/operations/account-load-balancer-monitors-delete-monitor) request. +To delete a monitor using the API, send a [DELETE](/api/resources/load_balancers/subresources/monitors/methods/delete/) request. diff --git a/src/content/docs/load-balancing/monitors/index.mdx b/src/content/docs/load-balancing/monitors/index.mdx index ecba119c95a945a..7c45ffddeff40e0 100644 --- a/src/content/docs/load-balancing/monitors/index.mdx +++ b/src/content/docs/load-balancing/monitors/index.mdx @@ -26,7 +26,7 @@ Health monitors associated with load balancers are different from standalone [He ## Properties -For an up-to-date list of monitor properties, refer to [Monitor properties](/api/operations/account-load-balancer-monitors-list-monitors) in our API documentation. +For an up-to-date list of monitor properties, refer to [Monitor properties](/api/resources/load_balancers/subresources/monitors/methods/list/) in our API documentation. *** @@ -66,13 +66,13 @@ The Cloudflare API supports the following commands for monitors. Examples are gi | Command | Method | Endpoint | | --------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------- | -| [Create Monitor](/api/operations/account-load-balancer-monitors-create-monitor) | `POST` | `accounts/:account_id/load_balancers/monitors` | -| [Delete Monitor](/api/operations/account-load-balancer-monitors-delete-monitor) | `DELETE` | `accounts/:account_id/load_balancers/monitors/:id` | -| [List Monitors](/api/operations/account-load-balancer-monitors-list-monitors) | `GET` | `accounts/:account_id/load_balancers/monitors` | -| [Monitor Details](/api/operations/account-load-balancer-monitors-monitor-details) | `GET` | `accounts/:account_id/load_balancers/monitors/:id` | -| [Overwrite specific properties](/api/operations/account-load-balancer-monitors-patch-monitor) | `PATCH` | `accounts/:account_id/load_balancers/monitors/:id` | -| [Overwrite existing monitor](/api/operations/account-load-balancer-monitors-update-monitor) | `PUT` | `accounts/:account_id/load_balancers/monitors/:id` | -| [Preview Monitor](/api/operations/account-load-balancer-monitors-preview-monitor) | `POST` | `accounts/:account_id/load_balancers/monitors/:id/preview` | +| [Create Monitor](/api/resources/load_balancers/subresources/monitors/methods/create/) | `POST` | `accounts/:account_id/load_balancers/monitors` | +| [Delete Monitor](/api/resources/load_balancers/subresources/monitors/methods/delete/) | `DELETE` | `accounts/:account_id/load_balancers/monitors/:id` | +| [List Monitors](/api/resources/load_balancers/subresources/monitors/methods/list/) | `GET` | `accounts/:account_id/load_balancers/monitors` | +| [Monitor Details](/api/resources/load_balancers/subresources/monitors/methods/get/) | `GET` | `accounts/:account_id/load_balancers/monitors/:id` | +| [Overwrite specific properties](/api/resources/load_balancers/subresources/monitors/methods/edit/) | `PATCH` | `accounts/:account_id/load_balancers/monitors/:id` | +| [Overwrite existing monitor](/api/resources/load_balancers/subresources/monitors/methods/update/) | `PUT` | `accounts/:account_id/load_balancers/monitors/:id` | +| [Preview Monitor](/api/resources/load_balancers/subresources/monitors/subresources/previews/methods/create/) | `POST` | `accounts/:account_id/load_balancers/monitors/:id/preview` | ## Supported protocols diff --git a/src/content/docs/load-balancing/pools/create-pool.mdx b/src/content/docs/load-balancing/pools/create-pool.mdx index edda06ea032c72c..ce1f9d70cf352e9 100644 --- a/src/content/docs/load-balancing/pools/create-pool.mdx +++ b/src/content/docs/load-balancing/pools/create-pool.mdx @@ -60,7 +60,7 @@ To edit a pool in the dashboard: When you edit a pool with the API, your request type depends on how much you want to edit. -To update specific settings without having to resubmit the entire configuration, use a [PATCH](/api/operations/account-load-balancer-pools-patch-pool) request. For broader changes, use a [PUT](/api/operations/account-load-balancer-pools-update-pool) request. +To update specific settings without having to resubmit the entire configuration, use a [PATCH](/api/resources/load_balancers/subresources/pools/methods/edit/) request. For broader changes, use a [PUT](/api/resources/load_balancers/subresources/pools/methods/update/) request. @@ -87,7 +87,7 @@ To delete a pool in the dashboard: -To delete a pool using the API, send a [DELETE](/api/operations/account-load-balancer-pools-delete-pool) request. +To delete a pool using the API, send a [DELETE](/api/resources/load_balancers/subresources/pools/methods/delete/) request. diff --git a/src/content/docs/load-balancing/pools/index.mdx b/src/content/docs/load-balancing/pools/index.mdx index f24aa485c8779e4..f66960fe2fd65a7 100644 --- a/src/content/docs/load-balancing/pools/index.mdx +++ b/src/content/docs/load-balancing/pools/index.mdx @@ -20,7 +20,7 @@ For more details about how endpoints and pools become unhealthy, refer to [Endpo ## Properties -For an up-to-date list of pool properties, refer to [Pool properties](/api/operations/account-load-balancer-pools-list-pools) in our API documentation. +For an up-to-date list of pool properties, refer to [Pool properties](/api/resources/load_balancers/subresources/pools/methods/list/) in our API documentation. *** @@ -42,12 +42,12 @@ The Cloudflare API supports the following commands for pools. Examples are given | Command | Method | Endpoint | | ---------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------- | -| [Create Pool](/api/operations/account-load-balancer-pools-create-pool) | `POST` | `accounts/:account_id/load_balancers/pools` | -| [Delete Pool](/api/operations/account-load-balancer-pools-delete-pool) | `DELETE` | `accounts/:account_id/load_balancers/pools/:id` | -| [List Pools](/api/operations/account-load-balancer-pools-list-pools) | `GET` | `accounts/:account_id/load_balancers/pools` | -| [Pool Details](/api/operations/account-load-balancer-pools-pool-details) | `GET` | `accounts/:account_id/load_balancers/pools/:id` | -| [Pool Health Details](/api/operations/account-load-balancer-pools-pool-health-details) | `GET` | `account/:account_id/load_balancers/pools/:id/health` | -| [Overwrite specific properties](/api/operations/account-load-balancer-pools-patch-pool) | `PATCH` | `accounts/:account_id/load_balancers/pools/:id` | -| [Overwrite existing pool](/api/operations/account-load-balancer-pools-update-pool) | `PUT` | `accounts/:account_id/load_balancers/pools/:id` | -| [Preview Pool](/api/operations/account-load-balancer-pools-preview-pool) | `POST` | `account/:account_id/load_balancers/pools/:id/preview` | -| [List Pool References](/api/operations/account-load-balancer-pools-list-pool-references) | `GET` | `accounts/:account_id/load_balancers/pools/:id/references` | +| [Create Pool](/api/resources/load_balancers/subresources/pools/methods/create/) | `POST` | `accounts/:account_id/load_balancers/pools` | +| [Delete Pool](/api/resources/load_balancers/subresources/pools/methods/delete/) | `DELETE` | `accounts/:account_id/load_balancers/pools/:id` | +| [List Pools](/api/resources/load_balancers/subresources/pools/methods/list/) | `GET` | `accounts/:account_id/load_balancers/pools` | +| [Pool Details](/api/resources/load_balancers/subresources/pools/methods/get/) | `GET` | `accounts/:account_id/load_balancers/pools/:id` | +| [Pool Health Details](/api/resources/load_balancers/subresources/pools/subresources/health/methods/get/) | `GET` | `account/:account_id/load_balancers/pools/:id/health` | +| [Overwrite specific properties](/api/resources/load_balancers/subresources/pools/methods/edit/) | `PATCH` | `accounts/:account_id/load_balancers/pools/:id` | +| [Overwrite existing pool](/api/resources/load_balancers/subresources/pools/methods/update/) | `PUT` | `accounts/:account_id/load_balancers/pools/:id` | +| [Preview Pool](/api/resources/load_balancers/subresources/pools/subresources/health/methods/create/) | `POST` | `account/:account_id/load_balancers/pools/:id/preview` | +| [List Pool References](/api/resources/load_balancers/subresources/pools/subresources/references/methods/get/) | `GET` | `accounts/:account_id/load_balancers/pools/:id/references` | diff --git a/src/content/docs/load-balancing/private-network/magic-wan.mdx b/src/content/docs/load-balancing/private-network/magic-wan.mdx index dcfd697e84fbbf8..b5969bdca7d1088 100644 --- a/src/content/docs/load-balancing/private-network/magic-wan.mdx +++ b/src/content/docs/load-balancing/private-network/magic-wan.mdx @@ -12,7 +12,7 @@ Consider the following steps to learn how to configure Private Network Load Bala 1. Create and [configure virtual networks](/cloudflare-one/connections/connect-networks/private-net/cloudflared/tunnel-virtual-networks/#create-a-virtual-network) using either the Cloudflare UI or the Cloudflare API. -2. Set your virtual network as the default. Your load balancer will use the `default` virtual network. In the [API](/api/operations/tunnel-virtual-network-create-a-virtual-network), specify the default virtual network by setting `is_default_network = true`. +2. Set your virtual network as the default. Your load balancer will use the `default` virtual network. In the [API](/api/resources/zero_trust/subresources/networks/subresources/virtual_networks/methods/create/), specify the default virtual network by setting `is_default_network = true`. 3. Retrieve the ID of the virtual network you created. To get the VNET ID, send a `GET` request to the following API endpoint: @@ -26,7 +26,7 @@ The VNET ID value will be used to ensure that your load balancer is properly int 1. Once you have your [VNets configured](/load-balancing/private-network/magic-wan/#1-configure-a-virtual-network-for-magic-wan), you need to make sure that the [pools](/load-balancing/pools/create-pool/) you will be using with your load balancer are configured with the default VNet value in the **Virtual Network** field. -2. Next, create an Account Load Balancer by sending a `POST` request to the following API endpoint. The request body should be structured similarly to a Zone Load Balancer. Refer to the [Cloudflare API documentation](/api/operations/load-balancers-create-load-balancer#request-body) for details on the required fields and their formats. Make sure that the pools you are using in your load balancer have the default VNET configured (previous step). +2. Next, create an Account Load Balancer by sending a `POST` request to the following API endpoint. The request body should be structured similarly to a Zone Load Balancer. Refer to the [Cloudflare API documentation](/api/resources/load_balancers/methods/create/#request-body) for details on the required fields and their formats. Make sure that the pools you are using in your load balancer have the default VNET configured (previous step). ```txt https://api.cloudflare.com/client/v4/accounts/{ACCOUNT_ID}/load_balancers/ @@ -42,7 +42,7 @@ To access the new load balancer, you need to create a tunnel route. This will be 1. Use the `tunnel_id` of the Account Load Balancer, retrieved in the previous step. By using the `tunnel_id` of the Account Load Balancer and assigning a private network IP we are making the Load Balancer available at that IP address on the associated virtual network. -2. To create a route for your Load Balancer, send a [`POST`](/api/operations/tunnel-route-create-a-tunnel-route) request to following endpoint with this sample body: +2. To create a route for your Load Balancer, send a [`POST`](/api/resources/zero_trust/subresources/networks/subresources/routes/methods/create/) request to following endpoint with this sample body: ```bash curl https://api.cloudflare.com/client/v4/accounts/{account_id}/teamnet/routes \ diff --git a/src/content/docs/load-balancing/private-network/tunnels-setup.mdx b/src/content/docs/load-balancing/private-network/tunnels-setup.mdx index 0582a2ef7744d41..76a4c067998bd1c 100644 --- a/src/content/docs/load-balancing/private-network/tunnels-setup.mdx +++ b/src/content/docs/load-balancing/private-network/tunnels-setup.mdx @@ -75,9 +75,9 @@ The specific configuration will vary depending on your use case. Refer to the fo -To get a list of your current virtual networks, use the [List virtual networks](/api/operations/tunnel-virtual-network-list-virtual-networks) API operation. +To get a list of your current virtual networks, use the [List virtual networks](/api/resources/zero_trust/subresources/networks/subresources/virtual_networks/methods/list/) API operation. -Enable virtual/private IP support by adding the `virtual_network_id` field to the origins in you API request. Refer to the [Cloudflare Load Balancer API documentation](/api/operations/account-load-balancer-pools-create-pool) for more information on how to create a pool using the API. +Enable virtual/private IP support by adding the `virtual_network_id` field to the origins in you API request. Refer to the [Cloudflare Load Balancer API documentation](/api/resources/load_balancers/subresources/pools/methods/create/) for more information on how to create a pool using the API. Consider the following example for updating an existing Load Balancer pool with a Virtual IP origin using cURL. diff --git a/src/content/docs/load-balancing/reference/load-balancing-analytics.mdx b/src/content/docs/load-balancing/reference/load-balancing-analytics.mdx index 2b7f266c858add4..82b62216bc411b9 100644 --- a/src/content/docs/load-balancing/reference/load-balancing-analytics.mdx +++ b/src/content/docs/load-balancing/reference/load-balancing-analytics.mdx @@ -59,7 +59,7 @@ To view latency information for your load balancer, go to **Traffic** > **Load B **Logs** provide a history of all endpoint status changes and how they affect your load balancing pools. Load Balancing only logs events that represent a status change for an endpoint, from healthy to unhealthy or vice versa. -To access logs in the dashboard, go to **Traffic** > **Load Balancing Analytics**. You can also access healthcheck logs [using the API](/api/operations/load-balancer-healthcheck-events-list-healthcheck-events). +To access logs in the dashboard, go to **Traffic** > **Load Balancing Analytics**. ## GraphQL Analytics @@ -131,7 +131,7 @@ This query shows the weighted, round-trip time (RTT) measurement (`avgRttMs`) fo :::caution -Note that `avgRttMs` refers to the round-trip time that is measured by the monitors and used in steering decisions. `avgRttMs` is different from the raw RTT for individual requests that reach the Cloudflare network. +Note that `avgRttMs` refers to the round-trip time that is measured by the monitors and used in steering decisions. `avgRttMs` is different from the raw RTT for individual requests that reach the Cloudflare network. ::: ```graphql title="Query" diff --git a/src/content/docs/load-balancing/reference/migration-guides/health-monitor-notifications.mdx b/src/content/docs/load-balancing/reference/migration-guides/health-monitor-notifications.mdx index ea751578c51712c..2c60272f7304306 100644 --- a/src/content/docs/load-balancing/reference/migration-guides/health-monitor-notifications.mdx +++ b/src/content/docs/load-balancing/reference/migration-guides/health-monitor-notifications.mdx @@ -27,7 +27,7 @@ First you should determine which pools are using notifications. It's often easie
-Use the [Cloudflare API](/api/operations/account-load-balancer-pools-list-pools) to list all your pools and then look for whether each pool has a value for the `notification_email` parameter. +Use the [Cloudflare API](/api/resources/load_balancers/subresources/pools/methods/list/) to list all your pools and then look for whether each pool has a value for the `notification_email` parameter. ```bash title="Request" curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/load_balancers/pools" \ @@ -80,7 +80,7 @@ In this step, you should create new notifications to replace all of your existin
-If using the Cloudflare API, [re-create all your existing notifications](/api/operations/notification-policies-create-a-notification-policy) with the following parameters specified: +If using the Cloudflare API, [re-create all your existing notifications](/api/resources/alerting/subresources/policies/methods/create/) with the following parameters specified: ```json "alert_type": "load_balancing_health_alert", @@ -111,7 +111,7 @@ Though you can perform these steps in the dashboard, Cloudflare recommends you u
-If using the Cloudflare API, we recently added a [`PATCH`](/api/operations/account-load-balancer-pools-patch-pools) endpoint so you can easily remove email notifications from multiple pools at the same time. +If using the Cloudflare API, we recently added a [`PATCH`](/api/resources/load_balancers/subresources/pools/methods/bulk_edit/) endpoint so you can easily remove email notifications from multiple pools at the same time. ```bash title="Request" curl --request PATCH \ diff --git a/src/content/docs/load-balancing/reference/region-mapping-api.mdx b/src/content/docs/load-balancing/reference/region-mapping-api.mdx index 83f09b3755acdb5..06cf48287e011f2 100644 --- a/src/content/docs/load-balancing/reference/region-mapping-api.mdx +++ b/src/content/docs/load-balancing/reference/region-mapping-api.mdx @@ -23,7 +23,7 @@ There are two main optional parameters for the Region API: * country\_code is a string containing a two-letter alpha-2 country code per ISO 3166-1. For example: /load\_balancers/regions?country\_code=US * subdivision\_code is a string containing a two-letter subdivision code for the U.S. and Canada per ISO 3166-2. For example: /load\_balancers/regions?subdivision\_code=CA -For additional details and examples on using the Region Mapping API, see [Cloudflare’s API documentation](/api/operations/load-balancer-regions-list-regions). +For additional details and examples on using the Region Mapping API, see [Cloudflare’s API documentation](/api/resources/load_balancers/subresources/regions/methods/list/). ## List of Load Balancer regions diff --git a/src/content/docs/load-balancing/troubleshooting/common-error-codes.mdx b/src/content/docs/load-balancing/troubleshooting/common-error-codes.mdx index 751121c3216b246..3a9923df75e6c09 100644 --- a/src/content/docs/load-balancing/troubleshooting/common-error-codes.mdx +++ b/src/content/docs/load-balancing/troubleshooting/common-error-codes.mdx @@ -18,8 +18,6 @@ GET user/load_balancing_analytics/events If a health monitor request fails, the breakdown will include the reason. -For a list of optional parameters, which are useful for filtering log results, see *[Cloudflare API: Health Monitor Events](/api/operations/load-balancer-healthcheck-events-list-healthcheck-events)*. - Common troubleshooting causes and solutions are listed below. *** diff --git a/src/content/docs/load-balancing/understand-basics/health-details.mdx b/src/content/docs/load-balancing/understand-basics/health-details.mdx index e060e0c45af3c8b..6ed50dc6054ec3c 100644 --- a/src/content/docs/load-balancing/understand-basics/health-details.mdx +++ b/src/content/docs/load-balancing/understand-basics/health-details.mdx @@ -38,7 +38,7 @@ If **Health Monitor Regions** for a pool is set to **All Data Centers (Enterpris Load balancing analytics and logs will only show global health changes. -For greater accuracy and consistency when changing endpoint health status, you can also set the `consecutive_up` and `consecutive_down` parameters via the [Create Monitor API endpoint](/api/operations/account-load-balancer-monitors-create-monitor). To change from healthy to unhealthy, an endpoint will have to be marked healthy a consecutive number of times (specified by `consecutive_down`). The same applies — from unhealthy to healthy — for `consecutive_up`. +For greater accuracy and consistency when changing endpoint health status, you can also set the `consecutive_up` and `consecutive_down` parameters via the [Create Monitor API endpoint](/api/resources/load_balancers/subresources/monitors/methods/create/). To change from healthy to unhealthy, an endpoint will have to be marked healthy a consecutive number of times (specified by `consecutive_down`). The same applies — from unhealthy to healthy — for `consecutive_up`. *** diff --git a/src/content/docs/load-balancing/understand-basics/session-affinity.mdx b/src/content/docs/load-balancing/understand-basics/session-affinity.mdx index 8acf49fe9262a78..5352fe8bce82945 100644 --- a/src/content/docs/load-balancing/understand-basics/session-affinity.mdx +++ b/src/content/docs/load-balancing/understand-basics/session-affinity.mdx @@ -70,8 +70,8 @@ Session Affinity by Cloudflare cookie and Client IP fallback is not supported fo Session affinity is a property of load balancers, which you can set with the following endpoints: -* [Create a load balancer](/api/operations/load-balancers-create-load-balancer) -* [Edit a load balancer](/api/operations/load-balancers-update-load-balancer) +* [Create a load balancer](/api/resources/load_balancers/methods/create/) +* [Edit a load balancer](/api/resources/load_balancers/methods/update/) Customize the behavior of session affinity by using the `session_affinity`, `session_affinity_ttl`, and `session_affinity_attributes` parameters. diff --git a/src/content/docs/load-balancing/understand-basics/traffic-steering/origin-level-steering/least-outstanding-requests-pools.mdx b/src/content/docs/load-balancing/understand-basics/traffic-steering/origin-level-steering/least-outstanding-requests-pools.mdx index 99cdc0ab3e659a4..e68da6e21c0f58a 100644 --- a/src/content/docs/load-balancing/understand-basics/traffic-steering/origin-level-steering/least-outstanding-requests-pools.mdx +++ b/src/content/docs/load-balancing/understand-basics/traffic-steering/origin-level-steering/least-outstanding-requests-pools.mdx @@ -25,7 +25,7 @@ Least Outstanding Requests steering is best to use if your endpoints are easily } ``` -Refer to the [API documentation](/api/operations/load-balancer-pools-update-pool) for more information on the pool configuration. +Refer to the [API documentation](/api/resources/load_balancers/subresources/pools/methods/update/) for more information on the pool configuration. :::note diff --git a/src/content/docs/load-balancing/understand-basics/traffic-steering/steering-policies/geo-steering.mdx b/src/content/docs/load-balancing/understand-basics/traffic-steering/steering-policies/geo-steering.mdx index 24b935e8149a307..7954c50b4cdd033 100644 --- a/src/content/docs/load-balancing/understand-basics/traffic-steering/steering-policies/geo-steering.mdx +++ b/src/content/docs/load-balancing/understand-basics/traffic-steering/steering-policies/geo-steering.mdx @@ -41,7 +41,7 @@ When [creating or editing a load balancer](/load-balancing/load-balancers/create -Use the `regions_pool` property of the [Update Load Balancers](/api/operations/load-balancers-update-load-balancer) command to specify an array of regions. Specify each region using the [appropriate region code](/load-balancing/reference/region-mapping-api/#list-of-load-balancer-regions) followed by a list of endpoints to use for that region. +Use the `regions_pool` property of the [Update Load Balancers](/api/resources/load_balancers/methods/update/) command to specify an array of regions. Specify each region using the [appropriate region code](/load-balancing/reference/region-mapping-api/#list-of-load-balancer-regions) followed by a list of endpoints to use for that region. In the example below, `WNAM` and `ENAM` represent the West and East Coasts of North America, respectively. @@ -94,7 +94,7 @@ When [creating or editing a load balancer](/load-balancing/load-balancers/create -When creating a load balancer [via the API](/api/operations/load-balancers-create-load-balancer), include the `country_pools` object to map countries to a list of pool IDs (ordered by their failover priority). +When creating a load balancer [via the API](/api/resources/load_balancers/methods/create/), include the `country_pools` object to map countries to a list of pool IDs (ordered by their failover priority). To get a list of country codes, use the [Region API](/load-balancing/reference/region-mapping-api/). @@ -104,7 +104,7 @@ Any country not explicitly defined will fall back to using the corresponding `re ### PoP steering -When creating a load balancer [via the API](/api/operations/load-balancers-create-load-balancer), include the `pop_pools` object to map Cloudflare data centers to a list of pool IDs (ordered by their failover priority). +When creating a load balancer [via the API](/api/resources/load_balancers/methods/create/), include the `pop_pools` object to map Cloudflare data centers to a list of pool IDs (ordered by their failover priority). For help finding data center identifiers, refer to [this community thread](https://community.cloudflare.com/t/is-there-a-way-to-retrieve-cloudflare-pops-list-and-locations-programmatically/234643). diff --git a/src/content/docs/load-balancing/understand-basics/traffic-steering/steering-policies/least-outstanding-requests.mdx b/src/content/docs/load-balancing/understand-basics/traffic-steering/steering-policies/least-outstanding-requests.mdx index bfbac3926ae03e1..83f4e7bb2af6936 100644 --- a/src/content/docs/load-balancing/understand-basics/traffic-steering/steering-policies/least-outstanding-requests.mdx +++ b/src/content/docs/load-balancing/understand-basics/traffic-steering/steering-policies/least-outstanding-requests.mdx @@ -23,7 +23,7 @@ Least Outstanding Requests steering is best to use if your pools are easily over } ``` -Refer to the [API documentation](/api/operations/load-balancers-update-load-balancer) for more information on the load balancer configuration. +Refer to the [API documentation](/api/resources/load_balancers/methods/update/) for more information on the load balancer configuration. :::note diff --git a/src/content/docs/load-balancing/understand-basics/traffic-steering/steering-policies/standard-options.mdx b/src/content/docs/load-balancing/understand-basics/traffic-steering/steering-policies/standard-options.mdx index 180ba34ddf5c29b..5ef21f883201712 100644 --- a/src/content/docs/load-balancing/understand-basics/traffic-steering/steering-policies/standard-options.mdx +++ b/src/content/docs/load-balancing/understand-basics/traffic-steering/steering-policies/standard-options.mdx @@ -27,4 +27,4 @@ If no monitors are attached to the load balancer, it will direct traffic to the Choose **Random** to route traffic to a healthy pool at random. Customers can use this option to set up [active - active failover](/load-balancing/load-balancers/common-configurations/#active---active-failover) (also known as round robin), where traffic is split equally between multiple pools. -Similar to setting Weights to direct the amount of traffic going to each endpoint, customers can also set Weights on pools via the [API's](/api/operations/load-balancers-create-load-balancer) `random_steering` object to determine the percentage of traffic sent to each pool. +Similar to setting Weights to direct the amount of traffic going to each endpoint, customers can also set Weights on pools via the [API's](/api/resources/load_balancers/methods/create/) `random_steering` object to determine the percentage of traffic sent to each pool. diff --git a/src/content/docs/logs/get-started/api-configuration.mdx b/src/content/docs/logs/get-started/api-configuration.mdx index e38aa7edbf4b9a9..3d410a649b1f81e 100644 --- a/src/content/docs/logs/get-started/api-configuration.mdx +++ b/src/content/docs/logs/get-started/api-configuration.mdx @@ -18,17 +18,17 @@ The `{dataset_id}` argument indicates the log category (such as `http_requests` | Operation | Description | API | | --------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `POST` | Create job | [Zone-scoped job](/api/operations/post-zones-zone_id-logpush-jobs) / [Account-scoped job](/api/operations/post-accounts-account_id-logpush-jobs) | -| `GET` | Retrieve job details | [Zone-scoped job](/api/operations/get-zones-zone_id-logpush-jobs-job_id) / [Account-scoped job](/api/operations/get-accounts-account_id-logpush-jobs-job_id) | -| `GET` | Retrieve all jobs for all datasets | [Zone-scoped jobs](/api/operations/get-zones-zone_id-logpush-jobs) / [Account-scoped jobs](/api/operations/get-accounts-account_id-logpush-jobs) | -| `GET` | Retrieve all jobs for a dataset | [Zone-scoped jobs](/api/operations/get-zones-zone_id-logpush-datasets-dataset_id-jobs) / [Account-scoped jobs](/api/operations/get-accounts-account_id-logpush-datasets-dataset_id-jobs) | -| `GET` | Retrieve all available fields for a dataset | [Zone-scoped fields](/api/operations/get-zones-zone_id-logpush-datasets-dataset_id-fields) / [Account-scoped fields](/api/operations/get-accounts-account_id-logpush-datasets-dataset_id-fields) | -| `PUT` | Update job | [Zone-scoped job](/api/operations/put-zones-zone_id-logpush-jobs-job_id) / [Account-scoped job](/api/operations/put-accounts-account_id-logpush-jobs-job_id) | -| `DELETE` | Delete job | [Zone-scoped job](/api/operations/delete-zones-zone_id-logpush-jobs-job_id) / [Account-scoped job](/api/operations/delete-accounts-account_id-logpush-jobs-job_id) | -| `POST` | Check whether destination exists | [Zone-scoped job](/api/operations/post-zones-zone_id-logpush-validate-destination-exists) / [Account-scoped job](/api/operations/delete-accounts-account_id-logpush-validate-destination-exists) | -| `POST` | Get ownership challenge | [Zone-scoped job](/api/operations/post-zones-zone_id-logpush-ownership) / [Account-scoped job](/api/operations/post-accounts-account_id-logpush-ownership) | -| `POST` | Validate ownership challenge | [Zone-scoped job](/api/operations/post-zones-zone_id-logpush-ownership-validate) / [Account-scoped job](/api/operations/post-accounts-account_id-logpush-ownership-validate) | -| `POST` | Validate log options | [Zone-scoped job](/api/operations/post-zones-zone_id-logpush-validate-origin) / [Account-scoped job](/api/operations/post-accounts-account_id-logpush-validate-origin) | +| `POST` | Create job | [Documentation](/api/resources/logpush/subresources/jobs/methods/create/) | +| `GET` | Retrieve job details | [Documentation](/api/resources/logpush/subresources/datasets/subresources/jobs/methods/get/) | +| `GET` | Retrieve all jobs for all datasets | [Documentation](/api/resources/logpush/subresources/jobs/methods/list/) | +| `GET` | Retrieve all jobs for a dataset | [Documentation](/api/resources/logpush/subresources/datasets/subresources/jobs/methods/get/) | +| `GET` | Retrieve all available fields for a dataset | [Documentation](/api/resources/logpush/subresources/datasets/subresources/fields/methods/get/) | +| `PUT` | Update job | [Documentation](/api/resources/logpush/subresources/jobs/methods/update/) | +| `DELETE` | Delete job | [Documentation](/api/resources/logpush/subresources/jobs/methods/delete/) | +| `POST` | Check whether destination exists | [Documentation](/api/resources/logpush/subresources/validate/methods/destination/) | +| `POST` | Get ownership challenge | [Documentation](/api/resources/logpush/subresources/ownership/methods/validate/) | +| `POST` | Validate ownership challenge | [Documentation](/api/resources/logpush/subresources/ownership/methods/validate/) | +| `POST` | Validate log options | [Documentation](/api/resources/logpush/subresources/validate/methods/origin/) | For concrete examples, refer to the tutorials in [Logpush examples](/logs/tutorials/examples/). @@ -90,7 +90,7 @@ You can specify your cloud service provider destination via the required **desti :::note[Note] -As of May 2022, defining a unique destination for a Logpush job will no longer be required. As this constraint has been removed, you can now have more than one job writing to the same destination. +As of May 2022, defining a unique destination for a Logpush job will no longer be required. As this constraint has been removed, you can now have more than one job writing to the same destination. ::: The `destination_conf` parameter must follow this format: @@ -209,7 +209,7 @@ If you are still using logpull\_options, here are the options that you can custo :::note[Note] -The **CVE-2021-44228** parameter can only be set through the API at this time. Updating your Logpush job through the dashboard will set this option to false. +The **CVE-2021-44228** parameter can only be set through the API at this time. Updating your Logpush job through the dashboard will set this option to false. ::: To check if the selected **logpull\_options** are valid: @@ -257,7 +257,7 @@ These parameters can be used to gain control of batch size in the case that a de :::note[Note] -Parameters **max\_upload\_bytes** and **max\_upload\_records** are not configurable for Edge Log Delivery. +Parameters **max\_upload\_bytes** and **max\_upload\_records** are not configurable for Edge Log Delivery. ::: ## Custom fields diff --git a/src/content/docs/logs/tutorials/examples/example-logpush-curl.mdx b/src/content/docs/logs/tutorials/examples/example-logpush-curl.mdx index 40a0ea36f87edb1..2f15c89dd1c4712 100644 --- a/src/content/docs/logs/tutorials/examples/example-logpush-curl.mdx +++ b/src/content/docs/logs/tutorials/examples/example-logpush-curl.mdx @@ -11,7 +11,6 @@ You can manage your Cloudflare Logpush service from the command line using cURL. Before getting started, review the following documentation: * [API configuration](/logs/get-started/api-configuration/) -* [Logpush job object definition](/api/operations/get-zones-zone_identifier-logpush-jobs) :::note diff --git a/src/content/docs/magic-firewall/how-to/add-rules.mdx b/src/content/docs/magic-firewall/how-to/add-rules.mdx index 71abacdb8471d42..ec106198e369473 100644 --- a/src/content/docs/magic-firewall/how-to/add-rules.mdx +++ b/src/content/docs/magic-firewall/how-to/add-rules.mdx @@ -6,7 +6,7 @@ sidebar: --- -You can check for an existing root ruleset from the dashboard or via the [Account rulesets API](/api/operations/listAccountRulesets). If you are a new Magic Transit customer, you may not have a root ruleset created for your account. To view examples for root rulesets, review the [Magic Firewall Terraform documentation](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/magic_firewall_ruleset). +You can check for an existing root ruleset from the dashboard or via the [Account rulesets API](/api/resources/rulesets/methods/list/). If you are a new Magic Transit customer, you may not have a root ruleset created for your account. To view examples for root rulesets, review the [Magic Firewall Terraform documentation](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/magic_firewall_ruleset). By default, you can create a maximum of 200 rules. We recommend you create lists of IP addresses to reference within rules to streamline rule management. @@ -50,7 +50,7 @@ The examples on this page all use the `https://api.cloudflare.com/client/v4/acco If you have a ruleset already deployed, consider using the `https://api.cloudflare.com/client/v4/accounts/{account_id}/rulesets/{ruleset_id}/rules` endpoint instead. -Refer to [Add rule to ruleset](/ruleset-engine/rulesets-api/add-rule/) and [Create an account ruleset](/api/operations/createAccountRuleset) for more information. +Refer to [Add rule to ruleset](/ruleset-engine/rulesets-api/add-rule/) and [Create an account ruleset](/api/resources/rulesets/methods/create/) for more information. ::: diff --git a/src/content/docs/magic-firewall/how-to/use-rules-list.mdx b/src/content/docs/magic-firewall/how-to/use-rules-list.mdx index 0ae7afb558290c5..efc41f17fea1aab 100644 --- a/src/content/docs/magic-firewall/how-to/use-rules-list.mdx +++ b/src/content/docs/magic-firewall/how-to/use-rules-list.mdx @@ -14,7 +14,7 @@ IP lists are defined at the account level and can be used to match against `ip.s To use this feature: -## 1. Create a [new IP list](/api/operations/lists-create-a-list). +## 1. Create a [new IP list](/api/resources/rules/subresources/lists/methods/create/). For example: @@ -32,7 +32,7 @@ curl https://api.cloudflare.com/client/v4/accounts/{account_id}/rules/lists \ ## 2. Add IPs to the list -Next, [create list items](/api/operations/lists-create-list-items). This will add elements to the current list. +Next, [create list items](/api/resources/rules/subresources/lists/subresources/items/methods/create/). This will add elements to the current list. ```bash curl https://api.cloudflare.com/client/v4/accounts/{account_id}/rules/lists/{list_id}/items \ diff --git a/src/content/docs/magic-firewall/packet-captures/collect-pcaps.mdx b/src/content/docs/magic-firewall/packet-captures/collect-pcaps.mdx index 73fdb0ced4349da..29a9be27f0c1b53 100644 --- a/src/content/docs/magic-firewall/packet-captures/collect-pcaps.mdx +++ b/src/content/docs/magic-firewall/packet-captures/collect-pcaps.mdx @@ -55,7 +55,7 @@ Currently, you can only send one collect request per minute for sample PCAPs, an
-For full PCAP requests, refer to the required parameters listed at [Create full PCAP requests](/api/operations/magic-pcap-collection-create-pcap-request). Note that full packet captures require two more parameters than sample packets. +For full PCAP requests, refer to the required parameters listed at [Create full PCAP requests](/api/resources/magic_transit/subresources/pcaps/methods/create/). Note that full packet captures require two more parameters than sample packets. The full PCAP request endpoint also contains optional fields you can use to limit the amount of packets captured. Both full and sample packet requests contain an optional `filter_v1` parameter you can use to filter packets by IPv4 Source address, for example. For a full list of the filter options, refer to the parameter lists above. @@ -105,7 +105,7 @@ While the collection is in progress, the response returns the `status` field as
-To create a sample PCAP request, send a JSON body with the required parameter listed at [Create sample PCAP request](/api/operations/magic-pcap-collection-create-pcap-request). +To create a sample PCAP request, send a JSON body with the required parameter listed at [Create sample PCAP request](/api/resources/magic_transit/subresources/pcaps/methods/create/). Leave `filter_v1` to collect all packets without any filtering. diff --git a/src/content/docs/magic-firewall/packet-captures/pcaps-bucket-setup.mdx b/src/content/docs/magic-firewall/packet-captures/pcaps-bucket-setup.mdx index 3151a993f4cebc4..0ff1dbfe6dcf025 100644 --- a/src/content/docs/magic-firewall/packet-captures/pcaps-bucket-setup.mdx +++ b/src/content/docs/magic-firewall/packet-captures/pcaps-bucket-setup.mdx @@ -192,7 +192,7 @@ curl https://api.cloudflare.com/client/v4/accounts/{account_id}/pcaps/ownership }' ``` -The [response](/api/operations/magic-pcap-collection-add-buckets-for-full-packet-captures) has a `"filename"` parameter with the name of a file that Cloudflare wrote to your R2 bucket. You need to download it for the next step. Example: +The [response](/api/resources/magic_transit/subresources/pcaps/subresources/ownership/methods/create/) has a `"filename"` parameter with the name of a file that Cloudflare wrote to your R2 bucket. You need to download it for the next step. Example: ```json { @@ -212,4 +212,4 @@ The [response](/api/operations/magic-pcap-collection-add-buckets-for-full-packet ### Validate bucket ownership -Refer to the [Validate a bucket](#validate-a-bucket) API instructions for more details on the entire process to [validate your R2 bucket](/api/operations/magic-pcap-collection-validate-buckets-for-full-packet-captures). When specifying the R2 destination for this validation, exclude the secret and access keys from the URL. +Refer to the [Validate a bucket](#validate-a-bucket) API instructions for more details on the entire process to [validate your R2 bucket](/api/resources/magic_transit/subresources/pcaps/subresources/ownership/methods/validate/). When specifying the R2 destination for this validation, exclude the secret and access keys from the URL. diff --git a/src/content/docs/magic-network-monitoring/api.mdx b/src/content/docs/magic-network-monitoring/api.mdx index 8c74912b541c8e2..bc5428223c9f36c 100644 --- a/src/content/docs/magic-network-monitoring/api.mdx +++ b/src/content/docs/magic-network-monitoring/api.mdx @@ -6,18 +6,18 @@ sidebar: --- -Use Magic Network Monitoring's API to configure your [account](/api/operations/magic-network-monitoring-configuration-list-account-configuration) and [rules](/api/operations/magic-network-monitoring-rules-list-rules). +Use Magic Network Monitoring's API to configure your [account](/api/resources/magic_network_monitoring/subresources/configs/methods/get/) and [rules](/api/resources/magic_network_monitoring/subresources/rules/methods/list/). ## Account configuration -Refer to [account configuration](/api/operations/magic-network-monitoring-configuration-list-account-configuration) to: +Refer to [account configuration](/api/resources/magic_network_monitoring/subresources/configs/methods/get/) to: - Create, list, update, and delete Magic Network Monitoring configurations - List default sampling, router IPs, and rules for an account ## Rules configuration -Refer to [rules configuration](/api/operations/magic-network-monitoring-rules-list-rules) to: +Refer to [rules configuration](/api/resources/magic_network_monitoring/subresources/rules/methods/list/) to: - Create, list, update, and delete rules - Update advertisement for a rule diff --git a/src/content/docs/magic-network-monitoring/faq.mdx b/src/content/docs/magic-network-monitoring/faq.mdx index a177283cf58d2f2..73ddb88066dc0d3 100644 --- a/src/content/docs/magic-network-monitoring/faq.mdx +++ b/src/content/docs/magic-network-monitoring/faq.mdx @@ -33,7 +33,7 @@ No. Auto-advertisement only works with API-controlled advertisement, not BGP-con ## In the API, Magic Network Monitoring rules have a `bandwidth_threshold` data field. Does the value for this field refer to bytes transferred or current throughput? -The threshold for a [Magic Network Monitoring (MNM) rule](/api/operations/magic-network-monitoring-rules-list-rules) has two values. The first value is `bandwidth_threshold`. This value is a measure of the total ingress throughput on a network at any given moment. The second value is `duration`. The `duration`value refers to the amount of time that `bandwidth_threshold` must be exceeded before an alert is sent to the customer. +The threshold for a [Magic Network Monitoring (MNM) rule](/api/resources/magic_network_monitoring/subresources/rules/methods/list/) has two values. The first value is `bandwidth_threshold`. This value is a measure of the total ingress throughput on a network at any given moment. The second value is `duration`. The `duration`value refers to the amount of time that `bandwidth_threshold` must be exceeded before an alert is sent to the customer. For example, you create a MNM rule with the following parameters: diff --git a/src/content/docs/magic-network-monitoring/rules/index.mdx b/src/content/docs/magic-network-monitoring/rules/index.mdx index 83c477ee69e2dcc..a2ea229e813fb5b 100644 --- a/src/content/docs/magic-network-monitoring/rules/index.mdx +++ b/src/content/docs/magic-network-monitoring/rules/index.mdx @@ -46,7 +46,7 @@ Follow the previous steps to [create](#create-rules) or [edit](#edit-or-delete-r ## Enable per-prefix thresholds with the API -You can also use the [Magic Network Monitoring API](/api/operations/magic-network-monitoring-rules-list-rules) to configure custom thresholds for specific prefixes. +You can also use the [Magic Network Monitoring API](/api/resources/magic_network_monitoring/subresources/rules/methods/list/) to configure custom thresholds for specific prefixes. The system uses the concept of rules, and each rule consists of a group of prefixes. All prefixes inside a rule are evaluated as a whole, and you should set up a rule if you want the prefixes' aggregated traffic to trigger an alert or advertisement. For thresholds on singular prefixes or IPs, you can create an individual rule with one prefix and the desired threshold. @@ -76,7 +76,7 @@ For more granular thresholds, create a more focused rule as shown below. ] ``` -Refer to the [Magic Network Monitoring API documentation](/api/operations/magic-network-monitoring-rules-list-rules) for more information. +Refer to the [Magic Network Monitoring API documentation](/api/resources/magic_network_monitoring/subresources/rules/methods/list/) for more information. ## Notifications diff --git a/src/content/docs/magic-network-monitoring/tutorials/encrypt-network-flow-data.mdx b/src/content/docs/magic-network-monitoring/tutorials/encrypt-network-flow-data.mdx index f418f35316ec9af..13f72a40d879bbd 100644 --- a/src/content/docs/magic-network-monitoring/tutorials/encrypt-network-flow-data.mdx +++ b/src/content/docs/magic-network-monitoring/tutorials/encrypt-network-flow-data.mdx @@ -15,7 +15,7 @@ To learn more about the WARP client, and to install the WARP client on Linux, ma ## 1. Configure your WARP devices -Follow the instructions in the [Magic Network Monitoring API](/api/operations/magic-network-monitoring-configuration-update-account-configuration-fields) to configure your WARP devices. +Follow the instructions in the [Magic Network Monitoring API](/api/resources/magic_network_monitoring/subresources/configs/methods/edit/) to configure your WARP devices. The `warp_devices` array at the account level is a list of WARP devices through which you can send encrypted flows. Each WARP device must have: diff --git a/src/content/docs/magic-transit/how-to/configure-magic-tunnel-alerts.mdx b/src/content/docs/magic-transit/how-to/configure-magic-tunnel-alerts.mdx index 6edb83080fdef8c..5060997166440cf 100644 --- a/src/content/docs/magic-transit/how-to/configure-magic-tunnel-alerts.mdx +++ b/src/content/docs/magic-transit/how-to/configure-magic-tunnel-alerts.mdx @@ -34,7 +34,7 @@ import { Render, Tabs, TabItem } from "~/components"; Refer to the [documentation for Notifications](/notifications/get-started/) to learn about specific permissions you need to access the service via the API. ::: -Send a [`POST` request](/api/operations/notification-policies-create-a-notification-policy) to create a Magic Transit tunnel health alert. You can set tunnel health alerts with any SLO value between `0` and `99.99`. +Send a [`POST` request](/api/resources/alerting/subresources/policies/methods/create/) to create a Magic Transit tunnel health alert. You can set tunnel health alerts with any SLO value between `0` and `99.99`. ```bash curl https://api.cloudflare.com/client/v4/accounts/account_id/alerting/v3/policies \ diff --git a/src/content/docs/magic-transit/how-to/run-endpoint-health-checks.mdx b/src/content/docs/magic-transit/how-to/run-endpoint-health-checks.mdx index f6abb438e51ffef..b772eec6796e99e 100644 --- a/src/content/docs/magic-transit/how-to/run-endpoint-health-checks.mdx +++ b/src/content/docs/magic-transit/how-to/run-endpoint-health-checks.mdx @@ -13,7 +13,7 @@ When choosing which endpoint IP addresses to monitor with health checks, use the - Provide one IP address for each of the prefixes Cloudflare will advertise. - Redundant IPs routed via the same ISP and infrastructure are not necessary but are useful when troubleshooting. -Cloudflare pings health check IPs from within the [published Cloudflare IP range](https://www.cloudflare.com/ips/), which is also available via the [Cloudflare API](/api/operations/cloudflare-i-ps-cloudflare-ip-details). +Cloudflare pings health check IPs from within the [published Cloudflare IP range](https://www.cloudflare.com/ips/), which is also available via the [Cloudflare API](/api/resources/ips/methods/list/). Refer to the table below for an example of an endpoint health check configuration. diff --git a/src/content/docs/magic-transit/on-demand.mdx b/src/content/docs/magic-transit/on-demand.mdx index 42127fbbaf93bd6..6e5cb48e4169432 100644 --- a/src/content/docs/magic-transit/on-demand.mdx +++ b/src/content/docs/magic-transit/on-demand.mdx @@ -9,7 +9,7 @@ head: --- -Customers with access to the Magic Transit on-demand option can [configure prefix advertisement](/byoip/concepts/dynamic-advertisement/best-practices/#configure-dynamic-advertisement) from the **IP Prefixes** page in their Cloudflare account home or via the [Cloudflare API](/api/operations/ip-address-management-dynamic-advertisement-get-advertisement-status). +Customers with access to the Magic Transit on-demand option can [configure prefix advertisement](/byoip/concepts/dynamic-advertisement/best-practices/#configure-dynamic-advertisement) from the **IP Prefixes** page in their Cloudflare account home or via the [Cloudflare API](/api/resources/addressing/subresources/prefixes/subresources/bgp/subresources/statuses/methods/get/). A common workflow is to enable prefix advertisement during an attack so that you can take advantage of Cloudflare protection and then disable advertisement once the incident is resolved. Prefixes using BGP-controlled advertisements cannot be used in conjunction with dynamic advertisement (via dashboard/API). Please specify your preferred on-demand advertisement method during the prefix onboarding. diff --git a/src/content/docs/magic-wan/configuration/common-settings/configure-magic-tunnel-alerts.mdx b/src/content/docs/magic-wan/configuration/common-settings/configure-magic-tunnel-alerts.mdx index 7a8f51c8bd8e5ec..ad4a460287dfee0 100644 --- a/src/content/docs/magic-wan/configuration/common-settings/configure-magic-tunnel-alerts.mdx +++ b/src/content/docs/magic-wan/configuration/common-settings/configure-magic-tunnel-alerts.mdx @@ -32,7 +32,7 @@ import { Render, Tabs, TabItem } from "~/components"; Refer to the [documentation for Notifications](/notifications/get-started/) to learn about specific permissions you need to access the service via the API. ::: -Send a [`POST` request](/api/operations/notification-policies-create-a-notification-policy) to create a Magic WAN tunnel health alert. You can set tunnel health alerts with any SLO value between `0` and `99.99`. +Send a [`POST` request](/api/resources/alerting/subresources/policies/methods/create/) to create a Magic WAN tunnel health alert. You can set tunnel health alerts with any SLO value between `0` and `99.99`. ```bash curl https://api.cloudflare.com/client/v4/accounts/account_id/alerting/v3/policies \ diff --git a/src/content/docs/magic-wan/configuration/connector/network-options/application-based-policies/breakout-traffic.mdx b/src/content/docs/magic-wan/configuration/connector/network-options/application-based-policies/breakout-traffic.mdx index 634e7af0fa76ba5..7fd687adec3c6ec 100644 --- a/src/content/docs/magic-wan/configuration/connector/network-options/application-based-policies/breakout-traffic.mdx +++ b/src/content/docs/magic-wan/configuration/connector/network-options/application-based-policies/breakout-traffic.mdx @@ -55,7 +55,7 @@ The traffic for that application will now go directly to the Internet and bypass -1. Send a [`GET` request](/api/operations/magic-account-apps-list-apps) to list the applications associated with an account. +1. Send a [`GET` request](/api/resources/magic_transit/subresources/apps/methods/list/) to list the applications associated with an account. Example: @@ -83,7 +83,7 @@ The traffic for that application will now go directly to the Internet and bypass Take note of the `"managed_app_id"` value for any application you want to configure. -2. Send a [`POST` request](/api/operations/magic-site-app-configs-add-app-config) to add new apps the breakout traffic policy. +2. Send a [`POST` request](/api/resources/magic_transit/subresources/sites/subresources/app_configuration/methods/create/) to add new apps the breakout traffic policy. Example: @@ -127,7 +127,7 @@ The traffic for that application will now go directly to the Internet and bypass -1. Send a [`GET` request](/api/operations/magic-site-app-configs-list-app-configs) to list the applications associated with a site. +1. Send a [`GET` request](/api/resources/magic_transit/subresources/sites/subresources/app_configuration/methods/list/) to list the applications associated with a site. Example: @@ -155,7 +155,7 @@ The traffic for that application will now go directly to the Internet and bypass Take note of the `"id"` value for the application that want to delete. -2. Send a [`DELETE` request](/api/operations/magic-site-app-configs-delete-app-config) to delete an application from the breakout traffic policy. +2. Send a [`DELETE` request](/api/resources/magic_transit/subresources/sites/subresources/app_configuration/methods/delete/) to delete an application from the breakout traffic policy. ```bash curl --request DELETE \ diff --git a/src/content/docs/magic-wan/configuration/connector/network-options/application-based-policies/prioritized-traffic.mdx b/src/content/docs/magic-wan/configuration/connector/network-options/application-based-policies/prioritized-traffic.mdx index 324d66991b1845e..cd3f038c0de8e8b 100644 --- a/src/content/docs/magic-wan/configuration/connector/network-options/application-based-policies/prioritized-traffic.mdx +++ b/src/content/docs/magic-wan/configuration/connector/network-options/application-based-policies/prioritized-traffic.mdx @@ -36,7 +36,7 @@ The traffic for the applications you chose are now processed first by Connector. -1. Send a [`GET` request](/api/operations/magic-account-apps-list-apps) to list the applications associated with an account. +1. Send a [`GET` request](/api/resources/magic_transit/subresources/apps/methods/list/) to list the applications associated with an account. Example: @@ -64,7 +64,7 @@ The traffic for the applications you chose are now processed first by Connector. Take note of the `"managed_app_id"` value for any application you want to configure. -2. Send a [`POST` request](/api/operations/magic-site-app-configs-add-app-config) to add new apps the priority traffic policy. +2. Send a [`POST` request](/api/resources/magic_transit/subresources/sites/subresources/app_configuration/methods/create/) to add new apps the priority traffic policy. Example: @@ -106,7 +106,7 @@ The traffic for the applications you chose are now processed first by Connector. -1. Send a [`GET` request](/api/operations/magic-site-app-configs-list-app-configs) to list the applications associated with a site. +1. Send a [`GET` request](/api/resources/magic_transit/subresources/sites/subresources/app_configuration/methods/list/) to list the applications associated with a site. Example: @@ -134,7 +134,7 @@ The traffic for the applications you chose are now processed first by Connector. Take note of the `"id"` value for the application that want to delete. -2. Send a `DELETE` request [using the API](/api/operations/magic-site-app-configs-delete-app-config) to delete an application from the breakout traffic policy. +2. Send a `DELETE` request [using the API](/api/resources/magic_transit/subresources/sites/subresources/app_configuration/methods/delete/) to delete an application from the breakout traffic policy. ```bash curl --request DELETE \ diff --git a/src/content/docs/magic-wan/configuration/connector/network-options/dhcp/dhcp-relay.mdx b/src/content/docs/magic-wan/configuration/connector/network-options/dhcp/dhcp-relay.mdx index 769e35721869190..c48ae48f1d8559f 100644 --- a/src/content/docs/magic-wan/configuration/connector/network-options/dhcp/dhcp-relay.mdx +++ b/src/content/docs/magic-wan/configuration/connector/network-options/dhcp/dhcp-relay.mdx @@ -42,7 +42,7 @@ To configure DHCP relay: -Create a [`PUT` request](/api/operations/magic-site-lans-update-lan) to update the LAN where you want to enable DHCP relay: +Create a [`PUT` request](/api/resources/magic_transit/subresources/sites/subresources/lans/methods/update/) to update the LAN where you want to enable DHCP relay: Example: diff --git a/src/content/docs/magic-wan/configuration/connector/network-options/dhcp/dhcp-server.mdx b/src/content/docs/magic-wan/configuration/connector/network-options/dhcp/dhcp-server.mdx index a5c54bd8ca25187..3abd012ec9e7fc4 100644 --- a/src/content/docs/magic-wan/configuration/connector/network-options/dhcp/dhcp-server.mdx +++ b/src/content/docs/magic-wan/configuration/connector/network-options/dhcp/dhcp-server.mdx @@ -33,7 +33,7 @@ When you use a static IP address, Magic WAN Connector can also act as a DHCP ser -Create a [`PUT` request](/api/operations/magic-site-lans-update-lan) to update the LAN where you want to enable DHCP server: +Create a [`PUT` request](/api/resources/magic_transit/subresources/sites/subresources/lans/methods/update/) to update the LAN where you want to enable DHCP server: Example: diff --git a/src/content/docs/magic-wan/configuration/connector/network-options/dhcp/dhcp-static-address-reservation.mdx b/src/content/docs/magic-wan/configuration/connector/network-options/dhcp/dhcp-static-address-reservation.mdx index b65599fc3c5fcf8..b120153936624c4 100644 --- a/src/content/docs/magic-wan/configuration/connector/network-options/dhcp/dhcp-static-address-reservation.mdx +++ b/src/content/docs/magic-wan/configuration/connector/network-options/dhcp/dhcp-static-address-reservation.mdx @@ -19,7 +19,7 @@ If you configure your Connector to be a DHCP server, you can also assign IP addr -Create a [`PUT` request](/api/operations/magic-site-lans-update-lan) to update the LAN where you want to reserve addresses: +Create a [`PUT` request](/api/resources/magic_transit/subresources/sites/subresources/lans/methods/update/) to update the LAN where you want to reserve addresses: Example: diff --git a/src/content/docs/magic-wan/configuration/connector/network-options/network-segmentation.mdx b/src/content/docs/magic-wan/configuration/connector/network-options/network-segmentation.mdx index 358686f9a2a3d7c..4eee4d59bccc123 100644 --- a/src/content/docs/magic-wan/configuration/connector/network-options/network-segmentation.mdx +++ b/src/content/docs/magic-wan/configuration/connector/network-options/network-segmentation.mdx @@ -59,7 +59,7 @@ Follow the steps below to create a new LAN policy to segment your network. Only -Create a `POST` request [using the API](/api/operations/magic-site-acls-create-acl) to create a network policy. +Create a `POST` request [using the API](/api/resources/magic_transit/subresources/sites/subresources/acls/methods/create/) to create a network policy. Example: @@ -153,7 +153,7 @@ The new policy will ensure that traffic between the specified LANs flows locally -Create a `PUT` request [using the API](/api/operations/magic-site-acls-update-acl) to edit a network policy. +Create a `PUT` request [using the API](/api/resources/magic_transit/subresources/sites/subresources/acls/methods/update/) to edit a network policy. Example: @@ -214,7 +214,7 @@ https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/sites/{site_id} -Create a `DELETE` request [using the API](/api/operations/magic-site-acls-delete-acl) to delete a network policy. +Create a `DELETE` request [using the API](/api/resources/magic_transit/subresources/sites/subresources/acls/methods/delete/) to delete a network policy. Example: diff --git a/src/content/docs/magic-wan/configuration/manually/third-party/aruba-edgeconnect.mdx b/src/content/docs/magic-wan/configuration/manually/third-party/aruba-edgeconnect.mdx index 803bb418f1311d1..52e96f701382e97 100644 --- a/src/content/docs/magic-wan/configuration/manually/third-party/aruba-edgeconnect.mdx +++ b/src/content/docs/magic-wan/configuration/manually/third-party/aruba-edgeconnect.mdx @@ -143,7 +143,7 @@ The service name used to send traffic through the tunnel created in the next ste ![Diagram of GCP, Aruba Orchestratror, and Cloudflare products for IPsec tunnels](~/assets/images/magic-wan/third-party/aruba-edge-connect/gcp-edgeconnect-diagram-ipsec.png) -For additional information on creating IPsec tunnels, refer to [API documentation for IPsec tunnels](/api/operations/magic-ipsec-tunnels-create-ipsec-tunnels). +For additional information on creating IPsec tunnels, refer to [API documentation for IPsec tunnels](/api/resources/magic_transit/subresources/ipsec_tunnels/methods/create/). - `X-Auth-Email`: Your Cloudflare email ID - `X-Auth-Key`: Seen in the URL (`dash.cloudflare.com//....`) diff --git a/src/content/docs/magic-wan/configuration/manually/third-party/strongswan.mdx b/src/content/docs/magic-wan/configuration/manually/third-party/strongswan.mdx index c1c7d5050ed02b1..5c6906d97035b9b 100644 --- a/src/content/docs/magic-wan/configuration/manually/third-party/strongswan.mdx +++ b/src/content/docs/magic-wan/configuration/manually/third-party/strongswan.mdx @@ -9,7 +9,7 @@ This tutorial explains how to set up strongSwan along with Magic WAN. You will l Start by configuring the [bidirectional health checks](/magic-wan/configuration/manually/how-to/configure-tunnels/#add-tunnels) target for Magic WAN. For this particular tutorial, we are using `172.64.240.252` as the target IP address, and `type` as the request. -This can be set up [with the API](/api/operations/magic-ipsec-tunnels-update-ipsec-tunnel). For example: +This can be set up [with the API](/api/resources/magic_transit/subresources/ipsec_tunnels/methods/update/). For example: ```bash curl --request PUT \ diff --git a/src/content/docs/network/ip-geolocation.mdx b/src/content/docs/network/ip-geolocation.mdx index 26354a72f58d84e..3fa8a683d947c70 100644 --- a/src/content/docs/network/ip-geolocation.mdx +++ b/src/content/docs/network/ip-geolocation.mdx @@ -30,7 +30,7 @@ To enable **IP Geolocation** in the dashboard: -To enable **IP Geolocation** with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `ip_geolocation` as the setting name in the URI path, and the `value` parameter set to `"on"`. +To enable **IP Geolocation** with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `ip_geolocation` as the setting name in the URI path, and the `value` parameter set to `"on"`. diff --git a/src/content/docs/network/ipv6-compatibility.mdx b/src/content/docs/network/ipv6-compatibility.mdx index 10dc049d998d8e0..95cc4dc0d83e51d 100644 --- a/src/content/docs/network/ipv6-compatibility.mdx +++ b/src/content/docs/network/ipv6-compatibility.mdx @@ -40,7 +40,7 @@ To disable **IPv6 Compatibility** in the dashboard: -To disable **IPv6 Compatibility** with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `ipv6` as the setting name in the URI path, and the `value` parameter set to `"off"`. +To disable **IPv6 Compatibility** with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `ipv6` as the setting name in the URI path, and the `value` parameter set to `"off"`. diff --git a/src/content/docs/network/onion-routing.mdx b/src/content/docs/network/onion-routing.mdx index d2e68b335cadf15..2a7bd93c7ac74ac 100644 --- a/src/content/docs/network/onion-routing.mdx +++ b/src/content/docs/network/onion-routing.mdx @@ -41,6 +41,6 @@ To enable **Onion Routing** in the dashboard: -To enable **Onion Routing** with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `opportunistic_onion` as the setting name in the URI path, and the `value` parameter set to `"on"`. +To enable **Onion Routing** with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `opportunistic_onion` as the setting name in the URI path, and the `value` parameter set to `"on"`. diff --git a/src/content/docs/network/pseudo-ipv4.mdx b/src/content/docs/network/pseudo-ipv4.mdx index aea8183bfb08e06..c3264c3ef638ea2 100644 --- a/src/content/docs/network/pseudo-ipv4.mdx +++ b/src/content/docs/network/pseudo-ipv4.mdx @@ -52,6 +52,6 @@ To change the **Pseudo IPv4** setting in the dashboard: -To change **Pseudo IPv4** with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `pseudo_ipv4` as the setting name in the URI path, and the `value` parameter set to your desired value: `"off"`, `"add_header"`, or `"overwrite_header"`. +To change **Pseudo IPv4** with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `pseudo_ipv4` as the setting name in the URI path, and the `value` parameter set to your desired value: `"off"`, `"add_header"`, or `"overwrite_header"`. diff --git a/src/content/docs/network/response-buffering.mdx b/src/content/docs/network/response-buffering.mdx index 4e996ba321c31ae..762c5f774ca40d6 100644 --- a/src/content/docs/network/response-buffering.mdx +++ b/src/content/docs/network/response-buffering.mdx @@ -30,6 +30,6 @@ To enable **Response Buffering** in the dashboard: -To enable **Response Buffering** with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `response_buffering` as the setting name in the URI path, and the `value` parameter set to `"on"`. +To enable **Response Buffering** with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `response_buffering` as the setting name in the URI path, and the `value` parameter set to `"on"`. diff --git a/src/content/docs/network/websockets.mdx b/src/content/docs/network/websockets.mdx index ebe01883db21fe6..184d2b91175ae4b 100644 --- a/src/content/docs/network/websockets.mdx +++ b/src/content/docs/network/websockets.mdx @@ -24,7 +24,7 @@ To enable **WebSockets** connections to your origin server in the dashboard: -To enable **WebSockets** connections to your origin server with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `websockets` as the setting name in the URI path, and the `value` parameter set to `"on"`. +To enable **WebSockets** connections to your origin server with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `websockets` as the setting name in the URI path, and the `value` parameter set to `"on"`. diff --git a/src/content/docs/notifications/api-reference.mdx b/src/content/docs/notifications/api-reference.mdx index 9b38df346bb4142..97077703bdb6597 100644 --- a/src/content/docs/notifications/api-reference.mdx +++ b/src/content/docs/notifications/api-reference.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: API reference -external_link: /api/operations/notification-alert-types-get-alert-types +external_link: /api/resources/alerting/subresources/available_alerts/methods/list/ sidebar: order: 8 diff --git a/src/content/docs/notifications/notification-history.mdx b/src/content/docs/notifications/notification-history.mdx index ba3895a7d07a82e..9d4f0a2f41048fa 100644 --- a/src/content/docs/notifications/notification-history.mdx +++ b/src/content/docs/notifications/notification-history.mdx @@ -10,7 +10,7 @@ Notification History is a log of notifications that have been sent to your accou ## How to access Notification History -Currently, customers can access Notification History [via the Cloudflare API](/api/operations/notification-history-list-history). Using `GET`, customers can retrieve a list of history records for notifications sent to an account. The records are displayed for the last 30 or 90 days, based on the type of plan. +Currently, customers can access Notification History [via the Cloudflare API](/api/resources/alerting/subresources/history/methods/list/). Using `GET`, customers can retrieve a list of history records for notifications sent to an account. The records are displayed for the last 30 or 90 days, based on the type of plan. ```txt title="Syntax" GET accounts/{account_id}/alerting/v3/history diff --git a/src/content/docs/page-shield/reference/page-shield-api.mdx b/src/content/docs/page-shield/reference/page-shield-api.mdx index 3081d4f07c4e323..dd5c8b3b549ca16 100644 --- a/src/content/docs/page-shield/reference/page-shield-api.mdx +++ b/src/content/docs/page-shield/reference/page-shield-api.mdx @@ -7,7 +7,7 @@ sidebar: import { GlossaryTooltip } from "~/components"; -You can enable and disable Page Shield, configure its settings, and fetch information about detected scripts and connections using the [Page Shield API](/api/operations/page-shield-get-settings). +You can enable and disable Page Shield, configure its settings, and fetch information about detected scripts and connections using the [Page Shield API](/api/resources/page_shield/methods/get/). To authenticate API requests you need an [API token](/fundamentals/api/get-started/create-token/). For more information on the required API token permissions, refer to [Roles and permissions](/page-shield/reference/roles-and-permissions/). @@ -17,7 +17,7 @@ Refer to [API deprecations](/fundamentals/api/reference/deprecations/) for detai ## Endpoints -You can obtain the complete endpoint by appending the [Page Shield API](/api/operations/page-shield-get-settings) endpoints to the Cloudflare API base URL: +You can obtain the complete endpoint by appending the [Page Shield API](/api/resources/page_shield/methods/get/) endpoints to the Cloudflare API base URL: ```txt https://api.cloudflare.com/client/v4 @@ -25,7 +25,7 @@ https://api.cloudflare.com/client/v4 The `{zone_id}` argument is the zone ID (a hexadecimal string). You can find this value in the Cloudflare dashboard or using the Cloudflare API's [`/zones` endpoint](/fundamentals/setup/find-account-and-zone-ids/). -The `{script_id}` argument is the script ID (a hexadecimal string). This value is included in the response of the [List Page Shield scripts](/api/operations/page-shield-list-scripts) operation for every detected script. +The `{script_id}` argument is the script ID (a hexadecimal string). This value is included in the response of the [List Page Shield scripts](/api/resources/page_shield/subresources/scripts/methods/list/) operation for every detected script. The `{connection_id}` argument is the connection ID (a hexadecimal string). This value is included in the response of the List Page Shield connections API operation for every detected connection. @@ -47,19 +47,19 @@ The following table summarizes the available operations: | [Update a Page Shield policy][12] | `PUT zones/{zone_id}/page_shield/policies/{policy_id}` | Updates an existing CSP policy. | | [Delete a Page Shield policy][13] | `DELETE zones/{zone_id}/page_shield/policies/{policy_id}` | Deletes an existing CSP policy. | -[1]: /api/operations/page-shield-get-settings -[2]: /api/operations/page-shield-update-settings -[3]: /api/operations/page-shield-list-scripts -[4]: /api/operations/page-shield-get-script -[5]: /api/operations/page-shield-list-connections -[6]: /api/operations/page-shield-get-connection -[7]: /api/operations/page-shield-list-cookies -[8]: /api/operations/page-shield-get-cookie -[9]: /api/operations/page-shield-list-policies -[10]: /api/operations/page-shield-get-policy -[11]: /api/operations/page-shield-create-policy -[12]: /api/operations/page-shield-update-policy -[13]: /api/operations/page-shield-delete-policy +[1]: /api/resources/page_shield/methods/get/ +[2]: /api/resources/page_shield/methods/update/ +[3]: /api/resources/page_shield/subresources/scripts/methods/list/ +[4]: /api/resources/page_shield/subresources/scripts/methods/get/ +[5]: /api/resources/page_shield/subresources/connections/methods/list/ +[6]: /api/resources/page_shield/subresources/connections/methods/get/ +[7]: /api/resources/page_shield/subresources/cookies/methods/list/ +[8]: /api/resources/page_shield/subresources/cookies/methods/get/ +[9]: /api/resources/page_shield/subresources/policies/methods/list/ +[10]: /api/resources/page_shield/subresources/policies/methods/get/ +[11]: /api/resources/page_shield/subresources/policies/methods/create/ +[12]: /api/resources/page_shield/subresources/policies/methods/update/ +[13]: /api/resources/page_shield/subresources/policies/methods/delete/ ## API notes @@ -167,7 +167,7 @@ curl "https://api.cloudflare.com/api/v4/zones/{zone_id}/page_shield/scripts?host Some fields displayed in the example response may not be available, depending on your Cloudflare plan. -For details on the available filtering, paging, and sorting parameters, refer to the [API reference](/api/operations/page-shield-list-scripts). +For details on the available filtering, paging, and sorting parameters, refer to the [API reference](/api/resources/page_shield/subresources/scripts/methods/list/). ### Fetch list of infrequently reported scripts @@ -219,7 +219,7 @@ curl "https://api.cloudflare.com/api/v4/zones/{zone_id}/page_shield/scripts?stat Some fields displayed in the example response may not be available, depending on your Cloudflare plan. -For details on the available filtering, paging, and sorting parameters, refer to the [API reference](/api/operations/page-shield-list-scripts). +For details on the available filtering, paging, and sorting parameters, refer to the [API reference](/api/resources/page_shield/subresources/scripts/methods/list/). ### Get details of a detected script @@ -323,7 +323,7 @@ curl "https://api.cloudflare.com/api/v4/zones/{zone_id}/page_shield/connections? } ``` -For details on the available filtering, paging, and sorting parameters, refer to the [API reference](/api/operations/page-shield-list-scripts). +For details on the available filtering, paging, and sorting parameters, refer to the [API reference](/api/resources/page_shield/subresources/scripts/methods/list/). ### Get details of a detected connection diff --git a/src/content/docs/pages/configuration/api.mdx b/src/content/docs/pages/configuration/api.mdx index 55e8c5311276a7e..30a3e16f33379bb 100644 --- a/src/content/docs/pages/configuration/api.mdx +++ b/src/content/docs/pages/configuration/api.mdx @@ -4,7 +4,7 @@ title: REST API --- -The [Pages API](/api/operations/pages-project-get-projects) empowers you to build automations and integrate Pages with your development workflow. At a high level, the API endpoints let you manage deployments and builds and configure projects. Cloudflare supports [Deploy Hooks](/pages/configuration/deploy-hooks/) for headless CMS deployments. Refer to the [API documentation](https://api.cloudflare.com/) for a full breakdown of object types and endpoints. +The [Pages API](/api/resources/pages/subresources/projects/methods/list/) empowers you to build automations and integrate Pages with your development workflow. At a high level, the API endpoints let you manage deployments and builds and configure projects. Cloudflare supports [Deploy Hooks](/pages/configuration/deploy-hooks/) for headless CMS deployments. Refer to the [API documentation](https://api.cloudflare.com/) for a full breakdown of object types and endpoints. ## How to use the API @@ -159,6 +159,6 @@ export default { ## Related resources -* [Pages API Docs](/api/operations/pages-project-get-projects) +* [Pages API Docs](/api/resources/pages/subresources/projects/methods/list/) * [Workers Getting Started Guide](/workers/get-started/guide/) * [Workers Cron Triggers](/workers/configuration/cron-triggers/) diff --git a/src/content/docs/queues/configuration/batching-retries.mdx b/src/content/docs/queues/configuration/batching-retries.mdx index 0e4d9f38af33720..361cd9afcdce534 100644 --- a/src/content/docs/queues/configuration/batching-retries.mdx +++ b/src/content/docs/queues/configuration/batching-retries.mdx @@ -215,7 +215,7 @@ import { WranglerConfig } from "~/components"; If you use both the `wrangler` CLI and `wrangler.toml` to change the settings associated with a queue or a queue consumer, the most recent configuration change will take effect. -Refer to the [Queues REST API documentation](/api/operations/queue-v2-list-queue-consumers) to learn how to configure message delays and retry delays programmatically. +Refer to the [Queues REST API documentation](/api/resources/queues/subresources/consumers/methods/get/) to learn how to configure message delays and retry delays programmatically. ### Message delay precedence diff --git a/src/content/docs/queues/configuration/pull-consumers.mdx b/src/content/docs/queues/configuration/pull-consumers.mdx index 4772cf3869a2db9..6fce655387eed77 100644 --- a/src/content/docs/queues/configuration/pull-consumers.mdx +++ b/src/content/docs/queues/configuration/pull-consumers.mdx @@ -114,7 +114,7 @@ You will need to note the token down: it will only be displayed once. ## 3. Pull messages -To pull a message, make a HTTP POST request to the [Queues REST API](/api/operations/queue-v2-messages-pull) with a JSON-encoded body that optionally specifies a `visibility_timeout` and a `batch_size`, or an empty JSON object (`{}`): +To pull a message, make a HTTP POST request to the [Queues REST API](/api/resources/queues/subresources/messages/methods/pull/) with a JSON-encoded body that optionally specifies a `visibility_timeout` and a `batch_size`, or an empty JSON object (`{}`): ```ts // POST /accounts/${CF_ACCOUNT_ID}/queues/${QUEUE_ID}/messages/pull with the timeout & batch size @@ -173,7 +173,7 @@ Pull consumers follow a "short polling" approach: if there are messages availabl :::note -The [`pull`](/api/operations/queue-v2-messages-pull) and [`ack`](/api/operations/queue-v2-messages-ack) endpoints use the new `/queues/queue_id/messages/{action}` API format, as defined in the Queues API documentation. +The [`pull`](/api/resources/queues/subresources/messages/methods/pull/) and [`ack`](/api/resources/queues/subresources/messages/methods/ack/) endpoints use the new `/queues/queue_id/messages/{action}` API format, as defined in the Queues API documentation. The undocumented `/queues/queue_id/{action}` endpoints are not supported and will be deprecated as of June 30th, 2024. @@ -206,7 +206,7 @@ Multiple consumers can be useful in cases where you have multiple upstream resou Messages pulled by a consumer need to be either acknowledged or marked for retry. -To acknowledge and/or mark messages to be retried, make a HTTP `POST` request to `/ack` endpoint of your queue per the [Queues REST API](/api/operations/queue-v2-messages-ack) by providing an array of `lease_id` objects to acknowledge and/or retry: +To acknowledge and/or mark messages to be retried, make a HTTP `POST` request to `/ack` endpoint of your queue per the [Queues REST API](/api/resources/queues/subresources/messages/methods/ack/) by providing an array of `lease_id` objects to acknowledge and/or retry: ```ts // POST /accounts/${CF_ACCOUNT_ID}/queues/${QUEUE_ID}/messages/ack with the lease_ids @@ -297,6 +297,6 @@ Your consumer will need to decode the `json` and `bytes` types before operating ## Next steps -- Review the [REST API documentation](/api/operations/queue-v2-create-queue-consumer) and schema for Queues. +- Review the [REST API documentation](/api/resources/queues/subresources/consumers/methods/create/) and schema for Queues. - Learn more about [how to make API calls](/fundamentals/api/how-to/make-api-calls/) to the Cloudflare API. - Understand [what limit apply](/queues/platform/limits/) when consuming and writing to a queue. diff --git a/src/content/docs/queues/queues-api.mdx b/src/content/docs/queues/queues-api.mdx index 6017ff942c22c25..4e5a307e19424b8 100644 --- a/src/content/docs/queues/queues-api.mdx +++ b/src/content/docs/queues/queues-api.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: Queues REST API -external_link: /api/operations/queue-v2-create-queue +external_link: /api/resources/queues/methods/create/ sidebar: order: 10 diff --git a/src/content/docs/r2/api/s3/tokens.mdx b/src/content/docs/r2/api/s3/tokens.mdx index b13decf41829074..69eb9826bb2fafb 100644 --- a/src/content/docs/r2/api/s3/tokens.mdx +++ b/src/content/docs/r2/api/s3/tokens.mdx @@ -177,7 +177,7 @@ Determine what [permission groups](/fundamentals/api/how-to/create-via-api/#perm ### Get S3 API credentials from an API token -You can get the Access Key ID and Secret Access Key values from the response of the [Create Token](/api/operations/user-api-tokens-create-token) API: +You can get the Access Key ID and Secret Access Key values from the response of the [Create Token](/api/resources/user/subresources/tokens/methods/create/) API: * Access Key ID: The `id` of the API token. * Secret Access Key: The SHA-256 hash of the API token `value`. @@ -186,7 +186,7 @@ Refer to [Authenticate against R2 API using auth tokens](/r2/examples/authentica ## Temporary access credentials -If you need to create temporary credentials for a bucket or a prefix/object within a bucket, you can use the [temp-access-credentials endpoint](/api/operations/r2-create-temp-access-credentials) in the API. You will need an existing R2 token to pass in as the parent access key id. You can use the credentials from the API result for an S3-compatible request by setting the credential variables like so: +If you need to create temporary credentials for a bucket or a prefix/object within a bucket, you can use the [temp-access-credentials endpoint](/api/resources/r2/subresources/temporary_credentials/methods/create/) in the API. You will need an existing R2 token to pass in as the parent access key id. You can use the credentials from the API result for an S3-compatible request by setting the credential variables like so: ``` AWS_ACCESS_KEY_ID = diff --git a/src/content/docs/r2/buckets/object-lifecycles.mdx b/src/content/docs/r2/buckets/object-lifecycles.mdx index 67e80dabda98f44..186f405e329dc3a 100644 --- a/src/content/docs/r2/buckets/object-lifecycles.mdx +++ b/src/content/docs/r2/buckets/object-lifecycles.mdx @@ -50,7 +50,7 @@ Alternatively you can set the entire lifecycle configuration for a bucket from a npx wrangler r2 bucket lifecycle set --file ``` -The JSON file should be in the format of the request body of the [put object lifecycle configuration API](/api/operations/r2-put-bucket-lifecycle-configuration). +The JSON file should be in the format of the request body of the [put object lifecycle configuration API](/api/resources/r2/subresources/buckets/subresources/lifecycle/methods/update/). ### S3 API diff --git a/src/content/docs/r2/buckets/public-buckets.mdx b/src/content/docs/r2/buckets/public-buckets.mdx index a280718552366a8..33df4683cfafe58 100644 --- a/src/content/docs/r2/buckets/public-buckets.mdx +++ b/src/content/docs/r2/buckets/public-buckets.mdx @@ -52,7 +52,7 @@ Disable public access to your [`r2.dev` subdomain](#disable-managed-public-acces ### Minimum TLS Version -To specify the minimum TLS version of a custom hostname of an R2 bucket, you can issue an API call to edit [R2 custom domain settings](/api/operations/r2-edit-custom-domain-settings). +To specify the minimum TLS version of a custom hostname of an R2 bucket, you can issue an API call to edit [R2 custom domain settings](/api/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/update/). ## Connect a bucket to a custom domain diff --git a/src/content/docs/r2/data-migration/sippy.mdx b/src/content/docs/r2/data-migration/sippy.mdx index 6e8babcb5f01f89..1bd2c17df0988ad 100644 --- a/src/content/docs/r2/data-migration/sippy.mdx +++ b/src/content/docs/r2/data-migration/sippy.mdx @@ -66,7 +66,7 @@ This will prompt you to select between supported object storage providers and le ### Enable Sippy via API -For information on required parameters and examples of how to enable Sippy, refer to the [API documentation](/api/operations/r2-put-bucket-sippy-config). For information about getting started with the Cloudflare API, refer to [Make API calls](/fundamentals/api/how-to/make-api-calls/). +For information on required parameters and examples of how to enable Sippy, refer to the [API documentation](/api/resources/r2/subresources/buckets/subresources/sippy/methods/update/). For information about getting started with the Cloudflare API, refer to [Make API calls](/fundamentals/api/how-to/make-api-calls/). :::note @@ -135,7 +135,7 @@ npx wrangler r2 bucket sippy disable ### API -For more information on required parameters and examples of how to disable Sippy, refer to the [API documentation](/api/operations/r2-delete-bucket-sippy-config). +For more information on required parameters and examples of how to disable Sippy, refer to the [API documentation](/api/resources/r2/subresources/buckets/subresources/sippy/methods/delete/). ## Supported cloud storage providers diff --git a/src/content/docs/radar/api-reference.mdx b/src/content/docs/radar/api-reference.mdx index d21c0944421def3..05c1f6e82d02ff9 100644 --- a/src/content/docs/radar/api-reference.mdx +++ b/src/content/docs/radar/api-reference.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: API reference -external_link: /api/operations/radar-get-annotations-outages +external_link: /api/resources/radar/subresources/annotations/subresources/outages/methods/get/ sidebar: order: 6 diff --git a/src/content/docs/radar/get-started/first-request.mdx b/src/content/docs/radar/get-started/first-request.mdx index 961a63263646dd8..d31474ac85dbdd6 100644 --- a/src/content/docs/radar/get-started/first-request.mdx +++ b/src/content/docs/radar/get-started/first-request.mdx @@ -15,7 +15,7 @@ Once you have the token, you are ready to make your first request to Radar's API ## Example using cURL -In the following example, we will access the global percentage distribution of device types (like mobile and desktop traffic) for the last seven days. For more information, refer to [Get device types summary](/api/operations/radar-get-http-summary-by-device-type) endpoint: +In the following example, we will access the global percentage distribution of device types (like mobile and desktop traffic) for the last seven days. For more information, refer to [Get device types summary](/api/resources/radar/subresources/http/subresources/summary/methods/device_type/) endpoint: ```bash curl "https://api.cloudflare.com/client/v4/radar/http/summary/device_type?dateRange=7d&format=json" \ diff --git a/src/content/docs/radar/get-started/making-comparisons.mdx b/src/content/docs/radar/get-started/making-comparisons.mdx index b939851516d34d4..bcbb318f0e5bdbe 100644 --- a/src/content/docs/radar/get-started/making-comparisons.mdx +++ b/src/content/docs/radar/get-started/making-comparisons.mdx @@ -8,7 +8,7 @@ sidebar: When comparing time series, across locations/time ranges/etc., in endpoints that normalize values using [min-max](/radar/concepts/normalization), you must do so in the same request. This is done by asking for multiple series. All values will then be normalized using the same minimum and maximum value and can safely be compared against each other. -[Netflows](/radar/investigate/netflows) values are normalized using [min0-max](/radar/concepts/normalization), so we will use it as an example. Refer to [Get NetFlow time series](/api/operations/radar-get-netflows-timeseries) for more information. +[Netflows](/radar/investigate/netflows) values are normalized using [min0-max](/radar/concepts/normalization), so we will use it as an example. Refer to [Get NetFlow time series](/api/resources/radar/subresources/netflows/methods/timeseries/) for more information. ## Compare locations @@ -27,7 +27,7 @@ The second series has the following parameters: `name=pt_data&dateRange=7d&location=PT` -All of these parameters are arrays and it is the position in the array that defines the series the filter belongs to. Refer to [NetFlow's endpoint](/api/operations/radar-get-netflows-timeseries) for more information on the available parameters. +All of these parameters are arrays and it is the position in the array that defines the series the filter belongs to. Refer to [NetFlow's endpoint](/api/resources/radar/subresources/netflows/methods/timeseries/) for more information on the available parameters. The response (shortened below for brevity) uses the provided `name` property to wrap the timestamps and corresponding values. If we chart this data, it becomes obvious that Cloudflare received much less traffic from Portugal than from the United States. @@ -108,7 +108,7 @@ The second series has these parameters: `name=tonga_outage&dateStart=2022-01-15T02%3A00%3A00Z&&dateEnd=2022-01-15T05%3A00%3A00Z&location=TO` -In the above example, we requested for an [aggregation interval](/radar/concepts/aggregation-intervals) of one hour (`aggInterval=1h`), so that the results could be shown in this page. `format` and `aggInterval` are not arrays, as specified in the [API reference](/api/operations/radar-get-netflows-timeseries), and apply globally to all series in the request. +In the above example, we requested for an [aggregation interval](/radar/concepts/aggregation-intervals) of one hour (`aggInterval=1h`), so that the results could be shown in this page. `format` and `aggInterval` are not arrays, as specified in the [API reference](/api/resources/radar/subresources/netflows/methods/timeseries/), and apply globally to all series in the request. The `result` property should return a response like this: diff --git a/src/content/docs/radar/glossary.mdx b/src/content/docs/radar/glossary.mdx index 5f370dbdc224d6c..6d41eed80f76966 100644 --- a/src/content/docs/radar/glossary.mdx +++ b/src/content/docs/radar/glossary.mdx @@ -66,7 +66,7 @@ of the table are defined as follows: * `Confidence`: The level of confidence that we have on the event being a true hijacks. Values can be `High`, `Medium`, or `Low`. * `Tags`: The relevant evidence presented as short tags, presenting key facts we compiled using additional data sources, such as RPKI validation results or network relationship. -You can also access the detection result programmatically via our [public API](https://developers.cloudflare.com/api/operations/radar-get-bgp-hijacks-events) ([CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/) license). +You can also access the detection result programmatically via our [public API](https://developers.cloudflare.com/api/resources/radar/subresources/bgp/subresources/hijacks/subresources/events/methods/list/) ([CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/) license). ## Certificates diff --git a/src/content/docs/radar/investigate/application-layer-attacks.mdx b/src/content/docs/radar/investigate/application-layer-attacks.mdx index ae342cfcbc7fd82..448c2031e59debc 100644 --- a/src/content/docs/radar/investigate/application-layer-attacks.mdx +++ b/src/content/docs/radar/investigate/application-layer-attacks.mdx @@ -10,7 +10,7 @@ While in [HTTP requests](/radar/investigate/http-requests) you can examine all k :::note[Mitigated traffic] -Mitigated traffic is any HTTP request from an end-user that has a terminating action applied by the Cloudflare platform. These include actions like `BLOCK` or [challenges](/waf/reference/cloudflare-challenges/). +Mitigated traffic is any HTTP request from an end-user that has a terminating action applied by the Cloudflare platform. These include actions like `BLOCK` or [challenges](/waf/reference/cloudflare-challenges/). ::: Since we are examining attacks, we can inspect both sides of an attack — both the source location and the target location of the attack. For the source of the attack Cloudflare uses the location the attack is coming from associated with the IP (note that the human orchestrator of the attack may be in a different location than the computer the attack is originating from). For the target location of the attacks, Cloudflare uses the billing location associated with the zone under attack. @@ -61,7 +61,7 @@ From the abbreviated response below, we can conclude that distributed denial-of- } ``` -For more information refer to [Get layer 7 attacks by mitigation technique, over time](/api/operations/radar-get-attacks-layer7-timeseries-group). +For more information refer to [Get layer 7 attacks by mitigation technique, over time](/api/resources/radar/subresources/attacks/subresources/layer7/subresources/timeseries_groups/). ### Summary @@ -88,7 +88,7 @@ curl "https://api.cloudflare.com/client/v4/radar/attacks/layer7/summary?location This response means that 75% of all mitigated requests coming from Great Britain were mitigated by the [WAF](/waf/) product. -For more information refer to [Get layer 7 attacks summary](/api/operations/radar-get-attacks-layer7-summary). +For more information refer to [Get layer 7 attacks summary](/api/resources/radar/subresources/attacks/subresources/layer7/subresources/summary/methods/get/). ### Top @@ -144,7 +144,7 @@ curl "https://api.cloudflare.com/client/v4/radar/attacks/layer7/top/locations/ta During the specified date range, mitigation requests to zones with a billing address located in Belgium represent 18%. -For more information refer to [Get layer 7 top target locations](/api/operations/radar-get-attacks-layer7-top-target-location). +For more information refer to [Get layer 7 top target locations](/api/resources/radar/subresources/attacks/subresources/layer7/subresources/top/subresources/locations/methods/target/). #### Example: Top attacks @@ -202,7 +202,7 @@ This means that 3.79% of all mitigated requests are from and to the US, 3.6% of This response came from a query that is using attack `magnitude` as the sum of mitigated requests. To use the number of unique zones attacked as the metric, for example, use `attack_magnitude=AFFECTED_ZONES`. -For more information refer to [Get layer 7 top attack pairs](/api/operations/radar-get-attacks-layer7-top-attacks). +For more information refer to [Get layer 7 top attack pairs](/api/resources/radar/subresources/attacks/subresources/layer7/subresources/top/methods/attacks/). ## Next steps diff --git a/src/content/docs/radar/investigate/bgp-anomalies.mdx b/src/content/docs/radar/investigate/bgp-anomalies.mdx index 476e9e6c1f990de..c5d1f629fbd6418 100644 --- a/src/content/docs/radar/investigate/bgp-anomalies.mdx +++ b/src/content/docs/radar/investigate/bgp-anomalies.mdx @@ -427,5 +427,5 @@ async function send_email_alert(hijacker, prefixes, victims) { Refer to our API documentation for [BGP route leaks][route-leak-api-doc] and [BGP hijacks][hijack-api-doc] for more information on these topics. -[route-leak-api-doc]: /api/operations/radar-get-bgp-route-leak-events -[hijack-api-doc]: /api/operations/radar-get-bgp-hijacks-events +[route-leak-api-doc]: /api/resources/radar/subresources/bgp/subresources/leaks/subresources/events/methods/list/ +[hijack-api-doc]: /api/resources/radar/subresources/bgp/subresources/hijacks/subresources/events/methods/list/ diff --git a/src/content/docs/radar/investigate/dns.mdx b/src/content/docs/radar/investigate/dns.mdx index c0658a6111d19cc..d6d416038d46c67 100644 --- a/src/content/docs/radar/investigate/dns.mdx +++ b/src/content/docs/radar/investigate/dns.mdx @@ -63,7 +63,7 @@ As expected, most queries come from Russia. Note that these examples return the total number of DNS queries from a location to a hostname, *out* of the total DNS queries to a given hostname. In this sense, it is expected that locations with higher population numbers — like the United States — frequently appear in the top spots, even if the actual percentage is low. ::: -You can also provide multiple hostnames. Refer to [Get DNS top locations](/api/operations/radar-get-dns-top-locations) for more information. This is useful when the application you want to explore uses several hostnames to serve its content (like a hostname for the main website, another hostname dedicated to its API, etc.). +You can also provide multiple hostnames. Refer to [Get DNS top locations](/api/resources/radar/subresources/dns/subresources/top/methods/locations/) for more information. This is useful when the application you want to explore uses several hostnames to serve its content (like a hostname for the main website, another hostname dedicated to its API, etc.). ## Next steps diff --git a/src/content/docs/radar/investigate/domain-ranking-datasets.mdx b/src/content/docs/radar/investigate/domain-ranking-datasets.mdx index 81f3052de451ee2..6bec0edb6d838bf 100644 --- a/src/content/docs/radar/investigate/domain-ranking-datasets.mdx +++ b/src/content/docs/radar/investigate/domain-ranking-datasets.mdx @@ -45,13 +45,13 @@ curl "https://api.cloudflare.com/client/v4/radar/ranking/top?name=top&limit=5" \ } ``` -For more information refer to [Get top domains](/api/operations/radar-get-ranking-top-domains). +For more information refer to [Get top domains](/api/resources/radar/subresources/ranking/methods/top/). #### Example: Download top `x` ranking bucket file As mentioned in the [blog post](https://blog.cloudflare.com/radar-domain-rankings/), Cloudflare provides an ordered rank for the top 100 domains, but for the remainder it only provides ranking buckets — like top 200 thousand, top one million, -etc.. These are available through Cloudflare's [datasets endpoints](/api/operations/radar-get-reports-datasets). +etc.. These are available through Cloudflare's [datasets endpoints](/api/resources/radar/subresources/datasets/methods/list/). In the following example we will request the last available domain ranking buckets: @@ -82,7 +82,7 @@ curl "https://api.cloudflare.com/client/v4/radar/datasets?limit=10&datasetType=R } ``` -If you are interested in a specific top (like the top one million), go through the `meta.top` property. After finding the top you are looking for, get its `id` to fetch the dataset using the [`GET dataset download url`](/api/operations/radar-post-reports-dataset-download-url) endpoint. +If you are interested in a specific top (like the top one million), go through the `meta.top` property. After finding the top you are looking for, get its `id` to fetch the dataset using the [`GET dataset download url`](/api/resources/radar/subresources/datasets/methods/download/) endpoint. Then you can request a download url: @@ -106,9 +106,9 @@ curl "https://api.cloudflare.com/client/v4/radar/datasets/download" \ #### Example: Get the last top `x` ranking bucket This endpoint allows you to directly request the latest top x bucket available (optionally at a given date) -[Get dataset stream](/api/operations/radar-get-reports-dataset-download) endpoint. +[Get dataset stream](/api/resources/radar/subresources/datasets/methods/get/) endpoint. -The dataset alias can be retrieved from the [Get datasets](/api/operations/radar-get-reports-datasets) endpoint +The dataset alias can be retrieved from the [Get datasets](/api/resources/radar/subresources/datasets/methods/list/) endpoint as the example above. This stream endpoint is only available for datasets generated after 2023-01-08. diff --git a/src/content/docs/radar/investigate/http-requests.mdx b/src/content/docs/radar/investigate/http-requests.mdx index 67edac990bc6bc5..eb0728f97b2b2a3 100644 --- a/src/content/docs/radar/investigate/http-requests.mdx +++ b/src/content/docs/radar/investigate/http-requests.mdx @@ -10,7 +10,7 @@ While in [Netflows](/radar/investigate/netflows/) we can inspect bytes and packe :::note -HTTP traffic includes both HTTP and HTTPS traffic coming from end users. +HTTP traffic includes both HTTP and HTTPS traffic coming from end users. ::: Most of the charts in the [Adoption and Usage](https://radar.cloudflare.com/adoption-and-usage) section on Radar come from this data source. @@ -68,10 +68,10 @@ Mobile devices tend to be considerably more present when examining human generat :::note -Note that device classification comes from the [User-agent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent) header. Ultimately, this classification depends on the user agent(s) that bots use. +Note that device classification comes from the [User-agent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent) header. Ultimately, this classification depends on the user agent(s) that bots use. ::: -For more information refer to [Get device types time series](/api/operations/radar-get-http-timeseries-group-by-device-type). +For more information refer to [Get device types time series](/api/resources/radar/subresources/http/subresources/timeseries_groups/methods/device_type/). ### Summary @@ -99,7 +99,7 @@ Here is the abbreviated response: } ``` -For more information refer to the [API reference](/api/operations/radar-get-http-summary-by-device-type) for this endpoint. +For more information refer to the [API reference](/api/resources/radar/subresources/http/subresources/summary/methods/device_type/) for this endpoint. #### Example: breakdown by IP version and human/bot traffic @@ -125,7 +125,7 @@ This returns the following: Bots tend to use more IPv4 addresses. -It is also interesting to know how your ISP fares in IPv6 adoption. If you know your ISP’s autonomous system number (ASN), you can use the `asn` parameter to query for this information. Refer to the [API reference](/api/operations/radar-get-http-summary-by-ip-version) for other parameters. +It is also interesting to know how your ISP fares in IPv6 adoption. If you know your ISP’s autonomous system number (ASN), you can use the `asn` parameter to query for this information. Refer to the [API reference](/api/resources/radar/subresources/http/subresources/summary/methods/ip_version/) for other parameters. If you do not know your ISP’s ASN, you can use [Radar](https://radar.cloudflare.com/ip) to find what it is. @@ -168,7 +168,7 @@ curl "https://api.cloudflare.com/client/v4/radar/http/top/locations/ip_version/I According to the returned data, India is leading in IPv6 adoption. -For more information refer to the [API reference](/api/operations/radar-get-http-top-locations-by-ip-version) for this endpoint. +For more information refer to the [API reference](/api/resources/radar/subresources/http/subresources/locations/subresources/ip_version/methods/get/) for this endpoint. ## Next steps diff --git a/src/content/docs/radar/investigate/netflows.mdx b/src/content/docs/radar/investigate/netflows.mdx index a77a232c4f52661..369f4cf2e4dfefb 100644 --- a/src/content/docs/radar/investigate/netflows.mdx +++ b/src/content/docs/radar/investigate/netflows.mdx @@ -16,7 +16,7 @@ Netflows includes all types of traffic from Cloudflare's routers, not just traff #### Example: filtering by product -Besides comparing time series across locations or date ranges (discussed in [Make comparisons](/radar/get-started/making-comparisons/)), we can also examine `ALL` traffic versus only `HTTP` traffic using the `product` filter. For more information, refer to the [API reference](/api/operations/radar-get-netflows-timeseries) for this endpoint. +Besides comparing time series across locations or date ranges (discussed in [Make comparisons](/radar/get-started/making-comparisons/)), we can also examine `ALL` traffic versus only `HTTP` traffic using the `product` filter. For more information, refer to the [API reference](/api/resources/radar/subresources/netflows/methods/timeseries/) for this endpoint. :::note[NetFlow products] diff --git a/src/content/docs/radar/investigate/network-layer-attacks.mdx b/src/content/docs/radar/investigate/network-layer-attacks.mdx index 53cb679a7937ac8..5a1e6a2528ba902 100644 --- a/src/content/docs/radar/investigate/network-layer-attacks.mdx +++ b/src/content/docs/radar/investigate/network-layer-attacks.mdx @@ -63,7 +63,7 @@ If we inspect the abbreviated response below, we can conclude that globally, at We can also conclude that the distribution of network layer attacks coming from Singapore — or, more accurately, reaching Cloudflare's data center located in Singapore — differs quite a bit from the worldwide distribution. At those times, the distribution of network layer attacks clearly favors [TCP](https://www.cloudflare.com/learning/ddos/glossary/tcp-ip/). -For more information refer to the [API reference](/api/operations/radar-get-attacks-layer3-timeseries-by-bytes) for this endpoint. +For more information refer to the [API reference](/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries/) for this endpoint. ### Summary @@ -100,7 +100,7 @@ curl "https://api.cloudflare.com/client/v4/radar/attacks/layer3/summary?location The response shows that the attacks coming from Russia to other locations tended to use the [UDP](https://www.cloudflare.com/en-gb/learning/ddos/glossary/user-datagram-protocol-udp/) network protocol at those timestamps. -For more information refer to the [API reference](/api/operations/radar-get-attacks-layer3-timeseries-by-bytes) for this endpoint. +For more information refer to the [API reference](/api/resources/radar/subresources/attacks/subresources/layer3/methods/timeseries/) for this endpoint. ## Next steps diff --git a/src/content/docs/radar/investigate/outages.mdx b/src/content/docs/radar/investigate/outages.mdx index 9c7c193ee0d1e0a..504f0586063617b 100644 --- a/src/content/docs/radar/investigate/outages.mdx +++ b/src/content/docs/radar/investigate/outages.mdx @@ -63,6 +63,6 @@ curl "https://api.cloudflare.com/client/v4/radar/annotations/outages?limit=5&off } ``` -Refer to the [API reference](/api/operations/radar-get-annotations-outages) for more information regarding this endpoint. +Refer to the [API reference](/api/resources/radar/subresources/annotations/subresources/outages/methods/get/) for more information regarding this endpoint. Having data on a given outage allows you to examine its impact through both [Netflows](/radar/investigate/netflows/) (like in the [Tonga outage](/radar/get-started/making-comparisons/#use-specific-timestamps) and [others](https://blog.cloudflare.com/q3-2022-internet-disruption-summary/)) and [HTTP](/radar/investigate/http-requests/) data (for example, did the outage affect more mobile than desktop traffic?). diff --git a/src/content/docs/radar/investigate/url-scanner.mdx b/src/content/docs/radar/investigate/url-scanner.mdx index 09e2204fb1f3090..91977d37ce1553d 100644 --- a/src/content/docs/radar/investigate/url-scanner.mdx +++ b/src/content/docs/radar/investigate/url-scanner.mdx @@ -8,7 +8,7 @@ sidebar: import { GlossaryTooltip } from "~/components" -To better understand Internet usage around the world, use Cloudflare's URL Scanner. With Cloudflare's URL Scanner, you have the ability to investigate the details of a domain, IP, URL, or ASN. Cloudflare's URL Scanner is available in the Security Center of the Cloudflare dashboard, [Cloudflare Radar](https://radar.cloudflare.com/scan) and the Cloudflare [API](/api/operations/urlscanner-search-scans). +To better understand Internet usage around the world, use Cloudflare's URL Scanner. With Cloudflare's URL Scanner, you have the ability to investigate the details of a domain, IP, URL, or ASN. Cloudflare's URL Scanner is available in the Security Center of the Cloudflare dashboard, [Cloudflare Radar](https://radar.cloudflare.com/scan) and the Cloudflare [API](/api/resources/url_scanner/subresources/scans/methods/list/). ## Use the API @@ -110,9 +110,9 @@ Some examples of more specific properties include: * `page.securityViolations` - CSP or [SRI](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) violations. * `verdicts.overall.malicious` - Whether the website was considered malicious *at the time of the scan*. Please check the remaining properties for each subsystem(s) for specific threats detected. -The [Get URL Scan](/api/operations/urlscanner-get-scan) API endpoint documentation contains the full response schema. +The [Get URL Scan](/api/resources/url_scanner/subresources/scans/methods/get/) API endpoint documentation contains the full response schema. -To fetch the scan's [screenshots](/api/operations/urlscanner-get-scan-screenshot) or full [network log](/api/operations/urlscanner-get-scan-har) refer to the corresponding endpoints' documentation. +To fetch the scan's [screenshots](/api/resources/url_scanner/subresources/scans/methods/get/-screenshot) or full [network log](/api/resources/url_scanner/subresources/scans/methods/get/-har) refer to the corresponding endpoints' documentation. ### Search scans @@ -134,6 +134,6 @@ curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/urlscanner/scan You can also search for the hash in the URL Scanner API. -Go to [Search URL scans](/api/operations/urlscanner-search-scans) in the API documentation for the full list of available options. +Go to [Search URL scans](/api/resources/url_scanner/subresources/scans/methods/list/) in the API documentation for the full list of available options. Alternatively, you can search for the hash on the [Cloudflare dashboard](https://dash.cloudflare.com/) by selecting your account > **Security Center** > **Investigate** > Enter the hash > Select **Search**. \ No newline at end of file diff --git a/src/content/docs/reference-architecture/design-guides/designing-ztna-access-policies.mdx b/src/content/docs/reference-architecture/design-guides/designing-ztna-access-policies.mdx index 1c7a89f43a3a366..6def3a0239bc23f 100644 --- a/src/content/docs/reference-architecture/design-guides/designing-ztna-access-policies.mdx +++ b/src/content/docs/reference-architecture/design-guides/designing-ztna-access-policies.mdx @@ -196,7 +196,7 @@ There are many different [types of selectors](/cloudflare-one/policies/access/#s You can set rules based on the IP range of the incoming request. This could be allowing access only from your corporate network IP ranges. - **Is it possible to verify device or user information from a list?** - Sometimes, you might want to grant or restrict access based on specific device or user characteristics that do not fit neatly into other categories. This is where [lists](/cloudflare-one/policies/gateway/lists/) come in handy: you can define or import a list of contractor emails, or a list of approved device serial numbers and use those as criteria within an Access policy. These lists can be updated manually or via our [API](/api/operations/zero-trust-lists-create-zero-trust-list), allowing for integration with other device or user management systems. + Sometimes, you might want to grant or restrict access based on specific device or user characteristics that do not fit neatly into other categories. This is where [lists](/cloudflare-one/policies/gateway/lists/) come in handy: you can define or import a list of contractor emails, or a list of approved device serial numbers and use those as criteria within an Access policy. These lists can be updated manually or via our [API](/api/resources/zero_trust/subresources/gateway/subresources/lists/methods/create/), allowing for integration with other device or user management systems. - **Is the device's security posture adequate?** This is where the device client provides telemetry on the native device making the access request. It accomplishes this by performing device-level scans. Is the device's hard drive encrypted? The agent can check if technologies like BitLocker or FileVault are active, in addition to checking for specific volume names. If you are protecting a sensitive application, or something that holds critical information, this is an effective requirement to enforce. diff --git a/src/content/docs/reference-architecture/diagrams/ai/ai-composable.mdx b/src/content/docs/reference-architecture/diagrams/ai/ai-composable.mdx index 2246dae4515164b..f031fe6fa332c70 100644 --- a/src/content/docs/reference-architecture/diagrams/ai/ai-composable.mdx +++ b/src/content/docs/reference-architecture/diagrams/ai/ai-composable.mdx @@ -37,8 +37,8 @@ Cloudflare's AI platform has been designed with these principles in mind. The ar ![Figure 1: Composable AI architecture](~/assets/images/reference-architecture/ai-composable/ai-composable.svg "Figure 1: Composable AI architecture") 1. **Compute**: The compute layer is the core of the application. All business logic, as well as use of other components, is defined here. The compute layer interacts with other services such as inference services, vector search, databases and data storage. Serverless solutions such as [Cloudflare Workers](/workers/) offer fast iteration and automatic scaling, which allows developers to focus on the use case instead of infrastructure management. Importantly for composability is the support of standard interfaces such as HTTP or TCP, which the Workers' runtime both supports via the [`fetch()` API](/workers/runtime-apis/fetch/) and [`connect()` API](/workers/runtime-apis/tcp-sockets/) respectively. -2. **Inference**: AI inference is responsible for the AI-capabilities of the application. Operational models vary between self-hosting models or consuming Inference-as-a-service providers such as [Workers AI](/workers-ai/). In the latter case, [REST APIs](/api/operations/workers-ai-post-run-model) make interacting with inference services from any service/client easy to implement. Using platform-specific integrations such as [Bindings](/workers-ai/configuration/bindings/) for interaction between Workers and other services enable simplified development as complexity such as authentication is abstracted away. -3. **Vector Search**: Certain use cases such as [RAG](/reference-architecture/diagrams/ai/ai-rag/) leverage vector search for similarity matching. Operational models vary between self-hosting databases or consuming vector-specific database-as-a-service (DBaaS) providers such as [Vectorize](/vectorize/). In the latter case, [REST APIs](/api/operations/vectorize-list-vectorize-indexes) make interacting with it from any service/client easy to implement. Using platform-specific integrations such as [Bindings](/vectorize/get-started/embeddings/#3-bind-your-worker-to-your-index) for interaction between Workers and other services enable simplified development as complexity such as authentication is abstracted away. +2. **Inference**: AI inference is responsible for the AI-capabilities of the application. Operational models vary between self-hosting models or consuming Inference-as-a-service providers such as [Workers AI](/workers-ai/). In the latter case, [REST APIs](/api/resources/ai/methods/run/) make interacting with inference services from any service/client easy to implement. Using platform-specific integrations such as [Bindings](/workers-ai/configuration/bindings/) for interaction between Workers and other services enable simplified development as complexity such as authentication is abstracted away. +3. **Vector Search**: Certain use cases such as [RAG](/reference-architecture/diagrams/ai/ai-rag/) leverage vector search for similarity matching. Operational models vary between self-hosting databases or consuming vector-specific database-as-a-service (DBaaS) providers such as [Vectorize](/vectorize/). In the latter case, [REST APIs](/api/resources/vectorize/subresources/indexes/methods/list/) make interacting with it from any service/client easy to implement. Using platform-specific integrations such as [Bindings](/vectorize/get-started/embeddings/#3-bind-your-worker-to-your-index) for interaction between Workers and other services enable simplified development as complexity such as authentication is abstracted away. 4. **Data & Storage**: Databases and data storage add state to AI applications. User management, session storage and persisting data are common requirements for AI applications. Depending on the use case, different solutions are required such as relationship databases or object storage. A variety of solutions for self-hosted or managed services exist. On Cloudflare, this could be for instance [D1](/d1/) and [R2](/r2/). REST APIs make interacting with inference services from any service/client easy to implement. Using platform-specific integrations such as Bindings for interaction between Workers and data and database services enable simplified development as complexity such as authentication is abstracted away. ## Related resources diff --git a/src/content/docs/reference-architecture/diagrams/sase/gateway-dns-for-isp.mdx b/src/content/docs/reference-architecture/diagrams/sase/gateway-dns-for-isp.mdx index ad653b6365c6903..36bed91e826cfde 100644 --- a/src/content/docs/reference-architecture/diagrams/sase/gateway-dns-for-isp.mdx +++ b/src/content/docs/reference-architecture/diagrams/sase/gateway-dns-for-isp.mdx @@ -39,7 +39,7 @@ DNS filtering is then enforced through DNS policies set up by the service provid To achieve more precise control over which domains are allowed or blocked, the service provider can configure additional Allowed Domain and Blocked Domains policies. By setting these policies with [lower precedence](/cloudflare-one/policies/gateway/order-of-enforcement/#order-of-precedence) than the Security Risks policy, the service provider can override the Security Risks policy for specific domains. -To streamline the management of allowed and blocked domains, use [lists](/cloudflare-one/policies/gateway/lists/). Lists are easily updated through the dashboard or via [APIs](/api/operations/zero-trust-lists-update-zero-trust-list), making policy adjustments more efficient. +To streamline the management of allowed and blocked domains, use [lists](/cloudflare-one/policies/gateway/lists/). Lists are easily updated through the dashboard or via [APIs](/api/resources/zero_trust/subresources/gateway/subresources/lists/methods/update/), making policy adjustments more efficient. ![Figure 3: DNS policies are applied according to their order of precedence. In this example, the 'Allow List Policy' and 'Block List Policy' will be considered before the 'Security List' policy.](~/assets/images/reference-architecture/gateway-dns-for-isp/gateway-dns-for-isp-image-03.svg) diff --git a/src/content/docs/registrar/api-reference.mdx b/src/content/docs/registrar/api-reference.mdx index d893ab562c16184..cb25c3b77086907 100644 --- a/src/content/docs/registrar/api-reference.mdx +++ b/src/content/docs/registrar/api-reference.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: API reference -external_link: /api/operations/registrar-domains-list-domains +external_link: /api/resources/registrar/subresources/domains/methods/list/ sidebar: order: 8 diff --git a/src/content/docs/rules/compression-rules/examples/disable-all-brotli.mdx b/src/content/docs/rules/compression-rules/examples/disable-all-brotli.mdx index 9f83add5789d0a5..d14535df6e234f9 100644 --- a/src/content/docs/rules/compression-rules/examples/disable-all-brotli.mdx +++ b/src/content/docs/rules/compression-rules/examples/disable-all-brotli.mdx @@ -32,7 +32,7 @@ If the client does not support Gzip compression, the response will be uncompress -The following example sets the rules of an existing [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) (with ID `{ruleset_id}`) for the `http_response_compression` phase to a single compression rule, using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation: +The following example sets the rules of an existing [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) (with ID `{ruleset_id}`) for the `http_response_compression` phase to a single compression rule, using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation: ```bash curl --request PUT \ diff --git a/src/content/docs/rules/compression-rules/examples/disable-compression-avif.mdx b/src/content/docs/rules/compression-rules/examples/disable-compression-avif.mdx index e2dbaa6b7607cfd..8137005151410d4 100644 --- a/src/content/docs/rules/compression-rules/examples/disable-compression-avif.mdx +++ b/src/content/docs/rules/compression-rules/examples/disable-compression-avif.mdx @@ -34,7 +34,7 @@ The following example rule will disable compression for AVIF images, based on ei -The following example sets the rules of an existing [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) (with ID `{ruleset_id}`) for the `http_response_compression` phase to a single compression rule, using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation: +The following example sets the rules of an existing [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) (with ID `{ruleset_id}`) for the `http_response_compression` phase to a single compression rule, using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation: ```bash wrap curl --request PUT \ diff --git a/src/content/docs/rules/compression-rules/examples/enable-zstandard.mdx b/src/content/docs/rules/compression-rules/examples/enable-zstandard.mdx index 4b500557dae2122..e9bdc75d1ab3edd 100644 --- a/src/content/docs/rules/compression-rules/examples/enable-zstandard.mdx +++ b/src/content/docs/rules/compression-rules/examples/enable-zstandard.mdx @@ -30,7 +30,7 @@ The following example rule will turn on Zstandard compression for response conte -The following example sets the rules of an existing [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) (with ID `{ruleset_id}`) for the `http_response_compression` phase to a single compression rule, using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation: +The following example sets the rules of an existing [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) (with ID `{ruleset_id}`) for the `http_response_compression` phase to a single compression rule, using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation: ```bash wrap curl --request PUT \ diff --git a/src/content/docs/rules/compression-rules/examples/gzip-for-csv.mdx b/src/content/docs/rules/compression-rules/examples/gzip-for-csv.mdx index 63a4634d9fa00ec..bcc73dbbb1527b2 100644 --- a/src/content/docs/rules/compression-rules/examples/gzip-for-csv.mdx +++ b/src/content/docs/rules/compression-rules/examples/gzip-for-csv.mdx @@ -32,7 +32,7 @@ The following example rule will configure Gzip compression as the preferred comp -The following example sets the rules of an existing [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) (with ID `{ruleset_id}`) for the `http_response_compression` phase to a single compression rule, using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation: +The following example sets the rules of an existing [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) (with ID `{ruleset_id}`) for the `http_response_compression` phase to a single compression rule, using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation: ```bash curl --request PUT \ diff --git a/src/content/docs/rules/compression-rules/examples/only-brotli-url-path.mdx b/src/content/docs/rules/compression-rules/examples/only-brotli-url-path.mdx index cff403c3f717832..d4b428fba26b462 100644 --- a/src/content/docs/rules/compression-rules/examples/only-brotli-url-path.mdx +++ b/src/content/docs/rules/compression-rules/examples/only-brotli-url-path.mdx @@ -34,7 +34,7 @@ Since the rule configuration does not include _Auto_ at the end of the custom al -The following example sets the rules of an existing [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) (with ID `{ruleset_id}`) for the `http_response_compression` phase to a single compression rule, using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation: +The following example sets the rules of an existing [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) (with ID `{ruleset_id}`) for the `http_response_compression` phase to a single compression rule, using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation: ```bash curl --request PUT \ diff --git a/src/content/docs/rules/configuration-rules/create-api.mdx b/src/content/docs/rules/configuration-rules/create-api.mdx index 546f3688515fcc3..4f0ac6e05bfd237 100644 --- a/src/content/docs/rules/configuration-rules/create-api.mdx +++ b/src/content/docs/rules/configuration-rules/create-api.mdx @@ -33,7 +33,7 @@ Make sure your API token has the [required permissions](#required-api-token-perm
-The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single configuration rule — enabling Email Obfuscation and Browser Integrity Check for the contacts page — using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation: +The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single configuration rule — enabling Email Obfuscation and Browser Integrity Check for the contacts page — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation: ```bash title="Request" curl --request PUT \ @@ -61,7 +61,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
-The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single configuration rule — turning on I'm Under Attack mode for the administration area — using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation: +The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single configuration rule — turning on I'm Under Attack mode for the administration area — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation: ```bash title="Request" curl --request PUT \ diff --git a/src/content/docs/rules/custom-error-responses/create-api.mdx b/src/content/docs/rules/custom-error-responses/create-api.mdx index da65ec4dff40e22..e7845e10e0ee68f 100644 --- a/src/content/docs/rules/custom-error-responses/create-api.mdx +++ b/src/content/docs/rules/custom-error-responses/create-api.mdx @@ -24,10 +24,10 @@ The first rule in the `http_custom_errors` phase ruleset that matches will be ap Follow this workflow to create a custom error response rule for a given zone via API: -1. Use the [List zone rulesets](/api/operations/listZoneRulesets) operation to check if there is already a ruleset for the `http_custom_errors` phase at the zone level. -2. If the phase ruleset does not exist, create it using the [Update a zone entry point ruleset](/api/operations/updateZoneEntrypointRuleset) operation, which allows you to create a ruleset if it does not exist and update all the rules in the ruleset. Create the ruleset in the `http_custom_errors` phase. +1. Use the [List zone rulesets](/api/resources/rulesets/methods/list/) operation to check if there is already a ruleset for the `http_custom_errors` phase at the zone level. +2. If the phase ruleset does not exist, create it using the [Update a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/update/) operation, which allows you to create a ruleset if it does not exist and update all the rules in the ruleset. Create the ruleset in the `http_custom_errors` phase. - If the phase ruleset already exists, use the [Update a zone entry point ruleset](/api/operations/updateZoneEntrypointRuleset) operation to replace all the rules in the ruleset, or the [Add rule to ruleset](/ruleset-engine/rulesets-api/add-rule/) operation to add a rule to the existing rules in the ruleset. + If the phase ruleset already exists, use the [Update a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/update/) operation to replace all the rules in the ruleset, or the [Add rule to ruleset](/ruleset-engine/rulesets-api/add-rule/) operation to add a rule to the existing rules in the ruleset. ## Example API calls @@ -62,7 +62,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/phases/http_custom }' ``` -This `PUT` request, corresponding to the [Update a zone entry point ruleset](/api/operations/updateZoneEntrypointRuleset) operation, replaces any existing rules in the `http_custom_errors` phase entry point ruleset. +This `PUT` request, corresponding to the [Update a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/update/) operation, replaces any existing rules in the `http_custom_errors` phase entry point ruleset. ### Custom HTML response with updated status code @@ -89,7 +89,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/phases/http_custom }' ``` -This `PUT` request, corresponding to the [Update a zone entry point ruleset](/api/operations/updateZoneEntrypointRuleset) operation, replaces any existing rules in the `http_custom_errors` phase entry point ruleset. +This `PUT` request, corresponding to the [Update a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/update/) operation, replaces any existing rules in the `http_custom_errors` phase entry point ruleset. ### Custom HTML response for Cloudflare 1020 errors @@ -115,7 +115,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/phases/http_custom }' ``` -This `PUT` request, corresponding to the [Update a zone entry point ruleset](/api/operations/updateZoneEntrypointRuleset) operation, replaces any existing rules in the `http_custom_errors` phase entry point ruleset. +This `PUT` request, corresponding to the [Update a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/update/) operation, replaces any existing rules in the `http_custom_errors` phase entry point ruleset. --- diff --git a/src/content/docs/rules/origin-rules/create-api.mdx b/src/content/docs/rules/origin-rules/create-api.mdx index 3386adf6478f12b..ac344025ca5cbb8 100644 --- a/src/content/docs/rules/origin-rules/create-api.mdx +++ b/src/content/docs/rules/origin-rules/create-api.mdx @@ -33,7 +33,7 @@ Make sure your API token has the [required permissions](#required-api-token-perm
-The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single origin rule — overriding the HTTP `Host` header — using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation. The response will contain the complete definition of the ruleset you updated. +The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single origin rule — overriding the HTTP `Host` header — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation. The response will contain the complete definition of the ruleset you updated. ```bash curl --request PUT \ @@ -89,7 +89,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
-The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single origin rule — overriding the SNI value of incoming requests addressed at `admin.example.com` — using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation. +The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single origin rule — overriding the SNI value of incoming requests addressed at `admin.example.com` — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation. ```bash curl --request PUT \ @@ -116,7 +116,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
-The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single origin rule — overriding the resolved DNS record and the `Host` header of incoming requests — using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation. The response will contain the complete definition of the ruleset you updated. +The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single origin rule — overriding the resolved DNS record and the `Host` header of incoming requests — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation. The response will contain the complete definition of the ruleset you updated. ```bash curl --request PUT \ @@ -178,7 +178,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
-The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single origin rule — overriding the port of incoming requests — using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation. The response will contain the complete definition of the ruleset you updated. +The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single origin rule — overriding the port of incoming requests — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation. The response will contain the complete definition of the ruleset you updated. ```bash curl --request PUT \ diff --git a/src/content/docs/rules/page-rules/manage.mdx b/src/content/docs/rules/page-rules/manage.mdx index 2788e5cc6669225..74310a6b52a381e 100644 --- a/src/content/docs/rules/page-rules/manage.mdx +++ b/src/content/docs/rules/page-rules/manage.mdx @@ -35,7 +35,7 @@ For ideas about what rules you can create, refer to [recommended rules](/rules/p -To create a page rule using the API, send a [`POST` request](/api/operations/page-rules-create-a-page-rule). +To create a page rule using the API, send a [`POST` request](/api/resources/page_rules/methods/create/). You may also want to review the documentation on [wildcard matching](/rules/page-rules/reference/wildcard-matching/), [available settings](/rules/page-rules/reference/settings/), and [recommended rules](/rules/page-rules/reference/recommended-rules/). @@ -63,9 +63,9 @@ To edit a page rule in the dashboard: -To update one or more fields using the API, send a [`PATCH` request](/api/operations/page-rules-edit-a-page-rule). +To update one or more fields using the API, send a [`PATCH` request](/api/resources/page_rules/methods/edit/). -To entirely replace the configuration of a page rule, send a [`PUT` request](/api/operations/page-rules-update-a-page-rule). +To entirely replace the configuration of a page rule, send a [`PUT` request](/api/resources/page_rules/methods/update/). @@ -81,6 +81,6 @@ To delete a page rule in the dashboard: -To delete a page rule using the API, send a [`DELETE` request](/api/operations/page-rules-delete-a-page-rule). +To delete a page rule using the API, send a [`DELETE` request](/api/resources/page_rules/methods/delete/). diff --git a/src/content/docs/rules/transform/managed-transforms/configure.mdx b/src/content/docs/rules/transform/managed-transforms/configure.mdx index 56aae3beeae4b37..03378aa38c2e3f1 100644 --- a/src/content/docs/rules/transform/managed-transforms/configure.mdx +++ b/src/content/docs/rules/transform/managed-transforms/configure.mdx @@ -23,7 +23,7 @@ import { Details, TabItem, Tabs } from "~/components"; **1. Get list of available Managed Transforms** -Check the Managed Transform's current status and availability using the [List Managed Transforms](/api/operations/managed-transforms-list-managed-transforms) operation. +Check the Managed Transform's current status and availability using the [List Managed Transforms](/api/resources/managed_transforms/methods/list/) operation. The following example request obtains a list of available Managed Transforms, organized by request or response, with information about their current status (`enabled` field) and if you can update them, based on conflicts with other enabled Managed Transforms (`has_conflict` field). @@ -98,7 +98,7 @@ curl https://api.cloudflare.com/client/v4/zones/{zone_id}/managed_headers \ **2. Change the status of Managed Transforms** -Change the status of the [desired Managed Transforms](/rules/transform/managed-transforms/reference/) using the [Update status of Managed Transforms](/api/operations/managed-transforms-update-status-of-managed-transforms) operation. +Change the status of the [desired Managed Transforms](/rules/transform/managed-transforms/reference/) using the [Update status of Managed Transforms](/api/resources/managed_transforms/methods/edit/) operation. Add the Managed Transforms you wish to change to the request body, and update their status in the `enabled` field. You cannot enable a Managed Transform that has a conflict with a currently enabled Managed Transform (that is, an item where `has_conflict` is `true`). diff --git a/src/content/docs/rules/transform/request-header-modification/create-api.mdx b/src/content/docs/rules/transform/request-header-modification/create-api.mdx index a20cf9dc4c81a68..305a40387a508de 100644 --- a/src/content/docs/rules/transform/request-header-modification/create-api.mdx +++ b/src/content/docs/rules/transform/request-header-modification/create-api.mdx @@ -37,7 +37,7 @@ Make sure your API token has the [required permissions](#required-api-token-perm
-The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single HTTP request header modification rule — adding an HTTP request header with a static value — using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation. The response will contain the complete definition of the ruleset you updated. +The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single HTTP request header modification rule — adding an HTTP request header with a static value — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation. The response will contain the complete definition of the ruleset you updated. ```bash curl --request PUT \ @@ -103,7 +103,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
-The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single HTTP request header modification rule — adding an HTTP request header with a dynamic value — using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation. The response will contain the complete definition of the ruleset you updated. +The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single HTTP request header modification rule — adding an HTTP request header with a dynamic value — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation. The response will contain the complete definition of the ruleset you updated. ```bash curl --request PUT \ @@ -169,7 +169,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
-The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single HTTP request header modification rule — removing an HTTP request header — using the [Update a zone ruleset](/api/operations/updateZoneRuleset). The response will contain the complete definition of the ruleset you updated. +The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single HTTP request header modification rule — removing an HTTP request header — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/). The response will contain the complete definition of the ruleset you updated. ```bash curl --request PUT \ diff --git a/src/content/docs/rules/transform/response-header-modification/create-api.mdx b/src/content/docs/rules/transform/response-header-modification/create-api.mdx index c56d3efee329f06..d876356e429a92f 100644 --- a/src/content/docs/rules/transform/response-header-modification/create-api.mdx +++ b/src/content/docs/rules/transform/response-header-modification/create-api.mdx @@ -36,7 +36,7 @@ Make sure your API token has the [required permissions](#required-api-token-perm
-The following example configures the rules of an existing phase ruleset (`{ruleset_id}`) to a single HTTP response header modification rule — setting an HTTP response header to a static value — using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation. The response will contain the complete definition of the ruleset you updated. +The following example configures the rules of an existing phase ruleset (`{ruleset_id}`) to a single HTTP response header modification rule — setting an HTTP response header to a static value — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation. The response will contain the complete definition of the ruleset you updated. ```bash curl --request PUT \ @@ -102,7 +102,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
-The following example configures the rules of an existing phase ruleset (`{ruleset_id}`) to a single HTTP response header modification rule — setting an HTTP response header to a dynamic value — using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation. The response will contain the complete definition of the ruleset you updated. +The following example configures the rules of an existing phase ruleset (`{ruleset_id}`) to a single HTTP response header modification rule — setting an HTTP response header to a dynamic value — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation. The response will contain the complete definition of the ruleset you updated. ```bash curl --request PUT \ @@ -168,7 +168,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
-The following example configures the rules of an existing phase ruleset (`{ruleset_id}`) to a single HTTP response header modification rule — adding a `set-cookie` HTTP response header with a static value — using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation. By configuring the rule with the `add` operation you will keep any existing `set-cookie` headers that may already exist in the response. The response will contain the complete definition of the ruleset you updated. +The following example configures the rules of an existing phase ruleset (`{ruleset_id}`) to a single HTTP response header modification rule — adding a `set-cookie` HTTP response header with a static value — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation. By configuring the rule with the `add` operation you will keep any existing `set-cookie` headers that may already exist in the response. The response will contain the complete definition of the ruleset you updated. ```bash curl --request PUT \ @@ -234,7 +234,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
-The following example sets the rules of an existing phase ruleset (``) to a single HTTP response header modification rule — removing an HTTP response header — using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation. The response will contain the complete definition of the ruleset you updated. +The following example sets the rules of an existing phase ruleset (``) to a single HTTP response header modification rule — removing an HTTP response header — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation. The response will contain the complete definition of the ruleset you updated. ```bash curl --request PUT \ diff --git a/src/content/docs/rules/transform/url-rewrite/create-api.mdx b/src/content/docs/rules/transform/url-rewrite/create-api.mdx index d7faec50d961aed..99f21616b820a8f 100644 --- a/src/content/docs/rules/transform/url-rewrite/create-api.mdx +++ b/src/content/docs/rules/transform/url-rewrite/create-api.mdx @@ -33,7 +33,7 @@ Make sure your API token has the [required permissions](#required-api-token-perm
-The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single rewrite URL rule — performing a static rewrite of the URI path — using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation. The response will contain the complete definition of the ruleset you updated. +The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single rewrite URL rule — performing a static rewrite of the URI path — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation. The response will contain the complete definition of the ruleset you updated. ```bash curl --request PUT \ @@ -97,7 +97,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
-The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single rewrite URL rule — performing a dynamic rewrite of the URI path — using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation. The response will contain the complete definition of the ruleset you updated. +The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single rewrite URL rule — performing a dynamic rewrite of the URI path — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation. The response will contain the complete definition of the ruleset you updated. ```bash curl --request PUT \ diff --git a/src/content/docs/rules/url-forwarding/bulk-redirects/create-api.mdx b/src/content/docs/rules/url-forwarding/bulk-redirects/create-api.mdx index 00277f6f9b86482..8e7ce054cfbf3a3 100644 --- a/src/content/docs/rules/url-forwarding/bulk-redirects/create-api.mdx +++ b/src/content/docs/rules/url-forwarding/bulk-redirects/create-api.mdx @@ -22,7 +22,7 @@ To create Bulk Redirects via API, you must: ## 1. Create a Bulk Redirect List via API -Use the [Create a list](/api/operations/lists-create-a-list) operation to create a new Bulk Redirect List. The list `kind` must be `redirect`. +Use the [Create a list](/api/resources/rules/subresources/lists/methods/create/) operation to create a new Bulk Redirect List. The list `kind` must be `redirect`. ```bash curl https://api.cloudflare.com/client/v4/accounts/{account_id}/rules/lists \ @@ -59,7 +59,7 @@ For more information on list operations, refer to the [Lists API](/waf/tools/lis ## 2. Add items to the list -Use the [Create list items](/api/operations/lists-create-list-items) operation to add URL redirect items to the list. Enter the list ID from the previous step in the endpoint URL: +Use the [Create list items](/api/resources/rules/subresources/lists/subresources/items/methods/create/) operation to add URL redirect items to the list. Enter the list ID from the previous step in the endpoint URL: ```bash curl https://api.cloudflare.com/client/v4/accounts/{account_id}/rules/lists/f848b6ccb07647749411f504d6f88794/items \ @@ -93,7 +93,7 @@ curl https://api.cloudflare.com/client/v4/accounts/{account_id}/rules/lists/f848 } ``` -This is an asynchronous operation. The response will contain an `operation_id` which you will use to check if the operation completed successfully using the [Get bulk operation status](/api/operations/lists-get-bulk-operation-status) operation: +This is an asynchronous operation. The response will contain an `operation_id` which you will use to check if the operation completed successfully using the [Get bulk operation status](/api/resources/rules/subresources/lists/subresources/bulk_operations/methods/get/) operation: ```bash curl https://api.cloudflare.com/client/v4/accounts/{account_id}/rules/lists/bulk_operations/92558f8b296d4dbe9d0419e0e53f6622 \ @@ -126,7 +126,7 @@ A Bulk Redirect Rule must have: - `action` set to `redirect` - An `action_parameters` object with additional configuration settings — refer to [API JSON objects: Bulk Redirect Rule](/rules/url-forwarding/bulk-redirects/reference/json-objects/#bulk-redirect-rule) for details. -The following request of the [Create an account ruleset](/api/operations/createAccountRuleset) operation creates a phase entry point ruleset for the `http_request_redirect` phase at the account level, and defines a single redirect rule. Use this operation if you have not created a phase entry point ruleset for the `http_request_redirect` phase yet. +The following request of the [Create an account ruleset](/api/resources/rulesets/methods/create/) operation creates a phase entry point ruleset for the `http_request_redirect` phase at the account level, and defines a single redirect rule. Use this operation if you have not created a phase entry point ruleset for the `http_request_redirect` phase yet. ```bash curl https://api.cloudflare.com/client/v4/accounts/{account_id}/rulesets \ @@ -184,7 +184,7 @@ curl https://api.cloudflare.com/client/v4/accounts/{account_id}/rulesets \ } ``` -If there is already a phase entry point ruleset for the `http_request_redirect` phase, use the [Update an account ruleset](/api/operations/updateAccountRuleset) operation instead, like in the following example: +If there is already a phase entry point ruleset for the `http_request_redirect` phase, use the [Update an account ruleset](/api/resources/rulesets/methods/update/) operation instead, like in the following example: ```bash curl --request PUT \ diff --git a/src/content/docs/rules/url-forwarding/single-redirects/create-api.mdx b/src/content/docs/rules/url-forwarding/single-redirects/create-api.mdx index 256685b1e56f3a7..db836591886f2b4 100644 --- a/src/content/docs/rules/url-forwarding/single-redirects/create-api.mdx +++ b/src/content/docs/rules/url-forwarding/single-redirects/create-api.mdx @@ -26,7 +26,7 @@ A redirect rule must have: ## Example requests -The following request of the [Create a zone ruleset](/api/operations/createZoneRuleset) operation creates a phase entry point ruleset for the `http_request_dynamic_redirect` phase at the zone level, and defines a single redirect rule with a dynamic URL redirect. Use this operation if you have not created a phase entry point ruleset for the `http_request_dynamic_redirect` phase yet. +The following request of the [Create a zone ruleset](/api/resources/rulesets/methods/create/) operation creates a phase entry point ruleset for the `http_request_dynamic_redirect` phase at the zone level, and defines a single redirect rule with a dynamic URL redirect. Use this operation if you have not created a phase entry point ruleset for the `http_request_dynamic_redirect` phase yet. ```bash title="Request" curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets \ @@ -94,7 +94,7 @@ curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets \
-If there is already a phase entry point ruleset for the `http_request_dynamic_redirect` phase, use the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation instead, like in the following example: +If there is already a phase entry point ruleset for the `http_request_dynamic_redirect` phase, use the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation instead, like in the following example: ```bash title="Request" curl --request PUT \ diff --git a/src/content/docs/ruleset-engine/basic-operations/add-rule-phase-rulesets.mdx b/src/content/docs/ruleset-engine/basic-operations/add-rule-phase-rulesets.mdx index 124707a535c5a19..70e2a4f1f17c017 100644 --- a/src/content/docs/ruleset-engine/basic-operations/add-rule-phase-rulesets.mdx +++ b/src/content/docs/ruleset-engine/basic-operations/add-rule-phase-rulesets.mdx @@ -20,7 +20,7 @@ Instead of relying on the automatic creation of an entry point ruleset, you can
-The following example sets the rules of a phase entry point ruleset at the zone level for the `http_request_firewall_managed` phase using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation. +The following example sets the rules of a phase entry point ruleset at the zone level for the `http_request_firewall_managed` phase using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation. ```bash curl --request PUT \ @@ -90,7 +90,7 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/phases/http_request_firewal
-The following example adds a single rule to a phase entry point ruleset (with ID `{ruleset_id}`) at the zone level using the [Create a zone ruleset rule](/api/operations/createZoneRulesetRule) operation. +The following example adds a single rule to a phase entry point ruleset (with ID `{ruleset_id}`) at the zone level using the [Create a zone ruleset rule](/api/resources/rulesets/methods/create/) operation. ```bash curl https://api.cloudflare.com/client/v4/zone/{zone_id}/rulesets/{ruleset_id}/rules \ diff --git a/src/content/docs/ruleset-engine/custom-rulesets/add-rules-ruleset.mdx b/src/content/docs/ruleset-engine/custom-rulesets/add-rules-ruleset.mdx index 48cb2bcca19ae1c..7ceca22b9d81d92 100644 --- a/src/content/docs/ruleset-engine/custom-rulesets/add-rules-ruleset.mdx +++ b/src/content/docs/ruleset-engine/custom-rulesets/add-rules-ruleset.mdx @@ -5,16 +5,16 @@ sidebar: order: 3 --- -To add rules to an existing custom ruleset, use the [Update an account ruleset](/api/operations/updateAccountRuleset) operation and pass the rules in an array. Each rule has an expression and an action. +To add rules to an existing custom ruleset, use the [Update an account ruleset](/api/resources/rulesets/methods/update/) operation and pass the rules in an array. Each rule has an expression and an action. :::note[Choosing the appropriate API method] -When you add rules to a custom ruleset using the [Update an account ruleset](/api/operations/updateAccountRuleset) operation, you replace all the rules in the ruleset with the rules in the request. Use this API method when adding or updating several rules at once. This method will update the ruleset version number only once. +When you add rules to a custom ruleset using the [Update an account ruleset](/api/resources/rulesets/methods/update/) operation, you replace all the rules in the ruleset with the rules in the request. Use this API method when adding or updating several rules at once. This method will update the ruleset version number only once. You can use other API operations depending on the type of operation: -- Add a single rule to an existing custom ruleset: Use the [Create an account ruleset rule](/api/operations/createAccountRulesetRule) operation. -- Update a single rule in a custom ruleset: Use the [Update an account ruleset rule](/api/operations/updateAccountRulesetRule) operation. +- Add a single rule to an existing custom ruleset: Use the [Create an account ruleset rule](/api/resources/rulesets/methods/create/Rule) operation. +- Update a single rule in a custom ruleset: Use the [Update an account ruleset rule](/api/resources/rulesets/subresources/rules/methods/edit/) operation. ::: @@ -85,7 +85,7 @@ https://api.cloudflare.com/client/v4/accounts/{account_id}/rulesets/{custom_rule ## Update rules -To update one or more rules in a custom ruleset, use the [Update an account ruleset](/api/operations/updateAccountRuleset) operation. Include the ID of the rules you want to modify in the rules array and add the fields you wish to update. The request replaces the entire ruleset with a new version. Therefore, you must include the ID of all the rules you wish to keep. +To update one or more rules in a custom ruleset, use the [Update an account ruleset](/api/resources/rulesets/methods/update/) operation. Include the ID of the rules you want to modify in the rules array and add the fields you wish to update. The request replaces the entire ruleset with a new version. Therefore, you must include the ID of all the rules you wish to keep. The following request edits one rule in a custom ruleset and updates the execution order of the rules. diff --git a/src/content/docs/ruleset-engine/custom-rulesets/create-custom-ruleset.mdx b/src/content/docs/ruleset-engine/custom-rulesets/create-custom-ruleset.mdx index b3479d9ff9f6a9b..bff91e0f152010e 100644 --- a/src/content/docs/ruleset-engine/custom-rulesets/create-custom-ruleset.mdx +++ b/src/content/docs/ruleset-engine/custom-rulesets/create-custom-ruleset.mdx @@ -5,7 +5,7 @@ sidebar: order: 2 --- -Use the [Create an account ruleset](/api/operations/createAccountRuleset) operation to create a custom ruleset, making sure that you: +Use the [Create an account ruleset](/api/resources/rulesets/methods/create/) operation to create a custom ruleset, making sure that you: - Set the `kind` field to `custom`. - Specify the name of the phase where you want to create the custom ruleset in the `phase` field. diff --git a/src/content/docs/ruleset-engine/managed-rulesets/deploy-managed-ruleset.mdx b/src/content/docs/ruleset-engine/managed-rulesets/deploy-managed-ruleset.mdx index 4a9022a55db872e..c0fdf2ad60c15e1 100644 --- a/src/content/docs/ruleset-engine/managed-rulesets/deploy-managed-ruleset.mdx +++ b/src/content/docs/ruleset-engine/managed-rulesets/deploy-managed-ruleset.mdx @@ -16,7 +16,7 @@ To deploy a managed ruleset to a phase, use the [Rulesets API](/ruleset-engine/r Use the following workflow to deploy a managed ruleset to a phase at the zone level. 1. Get your [zone ID](/fundamentals/setup/find-account-and-zone-ids/). -2. Invoke the [List account rulesets](/api/operations/listAccountRulesets) operation to obtain the available managed rulesets. Managed rulesets exist at the account level, but you can deploy them to a zone. Find the ruleset ID of the managed ruleset you want to deploy. +2. Invoke the [List account rulesets](/api/resources/rulesets/methods/list/) operation to obtain the available managed rulesets. Managed rulesets exist at the account level, but you can deploy them to a zone. Find the ruleset ID of the managed ruleset you want to deploy. 3. Identify the [phase](/ruleset-engine/about/phases/) where you want to deploy the managed ruleset. Ensure that the managed ruleset belongs to the same phase where you want to deploy it. To learn more about the available phases supported by each Cloudflare product, refer to the specific documentation for that product, or the [Phases list](/ruleset-engine/reference/phases-list/). 4. Add a rule to the zone-level phase [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) that executes the managed ruleset. Refer to the following example for details on this step. @@ -31,7 +31,7 @@ In this example, the managed ruleset executes the behavior configured by Cloudfl Use the following workflow to deploy a managed ruleset to a phase at the account level. 1. Get your [account ID](/fundamentals/setup/find-account-and-zone-ids/). -2. Invoke the [List account rulesets](/api/operations/listAccountRulesets) operation to obtain the available managed rulesets. Find the ruleset ID of the managed ruleset you want to deploy. +2. Invoke the [List account rulesets](/api/resources/rulesets/methods/list/) operation to obtain the available managed rulesets. Find the ruleset ID of the managed ruleset you want to deploy. 3. Identify the [phase](/ruleset-engine/about/phases/) where you want to deploy the managed ruleset. Ensure that the managed ruleset belongs to the same phase where you want to deploy it. To learn more about the available phases supported by each Cloudflare product, refer to the specific documentation for that product, or the [Phases list](/ruleset-engine/reference/phases-list/). 4. Add a rule to the account-level phase [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) that executes the managed ruleset. Use parentheses to enclose any custom conditions in the rule expression and end your expression with `and cf.zone.plan eq "ENT"` so that it only applies to zones on an Enterprise plan. Refer to the following example for details on this step. diff --git a/src/content/docs/ruleset-engine/rulesets-api/add-rule.mdx b/src/content/docs/ruleset-engine/rulesets-api/add-rule.mdx index 0f35c748bac4c0f..0e323ef4dd3f7ce 100644 --- a/src/content/docs/ruleset-engine/rulesets-api/add-rule.mdx +++ b/src/content/docs/ruleset-engine/rulesets-api/add-rule.mdx @@ -17,8 +17,8 @@ Use one of the following API endpoints: | [Create an account ruleset rule][ar-account] | `POST /accounts/{account_id}/rulesets/{ruleset_id}/rules` | | [Create a zone ruleset rule][ar-zone] | `POST /zones/{zone_id}/rulesets/{ruleset_id}/rules` | -[ar-account]: /api/operations/createAccountRulesetRule -[ar-zone]: /api/operations/createZoneRulesetRule +[ar-account]: /api/resources/rulesets/methods/create/Rule +[ar-zone]: /api/resources/rulesets/methods/create/ Include the rule definition in the request body. @@ -28,7 +28,7 @@ Invoking this method creates a new version of the ruleset. ## Example -The following example adds a rule to ruleset `{ruleset_id}` of zone `{zone_id}`. The ruleset ID was previously obtained using the [List zone rulesets](/api/operations/listZoneRulesets) operation, and corresponds to the entry point ruleset for the `http_request_firewall_custom` phase. +The following example adds a rule to ruleset `{ruleset_id}` of zone `{zone_id}`. The ruleset ID was previously obtained using the [List zone rulesets](/api/resources/rulesets/methods/list/) operation, and corresponds to the entry point ruleset for the `http_request_firewall_custom` phase. The response will include the complete ruleset after adding the rule. diff --git a/src/content/docs/ruleset-engine/rulesets-api/create.mdx b/src/content/docs/ruleset-engine/rulesets-api/create.mdx index 15f76dda6c4b412..780a48bbe3037ea 100644 --- a/src/content/docs/ruleset-engine/rulesets-api/create.mdx +++ b/src/content/docs/ruleset-engine/rulesets-api/create.mdx @@ -17,8 +17,8 @@ Use one of the following API endpoints: | [Create an account ruleset][cr-account] | `POST /accounts/{account_id}/rulesets` | | [Create a zone ruleset][cr-zone] | `POST /zones/{zone_id}/rulesets` | -[cr-account]: /api/operations/createAccountRuleset -[cr-zone]: /api/operations/createZoneRuleset +[cr-account]: /api/resources/rulesets/methods/create/ +[cr-zone]: /api/resources/rulesets/methods/create/ The following parameters are required: diff --git a/src/content/docs/ruleset-engine/rulesets-api/delete-rule.mdx b/src/content/docs/ruleset-engine/rulesets-api/delete-rule.mdx index e3922e0ac077614..2fe8427be0844c0 100644 --- a/src/content/docs/ruleset-engine/rulesets-api/delete-rule.mdx +++ b/src/content/docs/ruleset-engine/rulesets-api/delete-rule.mdx @@ -15,8 +15,8 @@ Use one of the following API endpoints: | [Delete an account ruleset rule][dr-account] | `DELETE /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}` | | [Delete a zone ruleset rule][dr-zone] | `DELETE /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}` | -[dr-account]: /api/operations/deleteAccountRulesetRule -[dr-zone]: /api/operations/deleteZoneRulesetRule +[dr-account]: /api/resources/rulesets/subresources/rules/methods/delete/ +[dr-zone]: /api/resources/rulesets/methods/delete/ If the delete operation succeeds, the API method call returns a `200 OK` HTTP status code with the complete ruleset in the response body. diff --git a/src/content/docs/ruleset-engine/rulesets-api/delete.mdx b/src/content/docs/ruleset-engine/rulesets-api/delete.mdx index c0184ed33d9a3aa..949f003fef90eec 100644 --- a/src/content/docs/ruleset-engine/rulesets-api/delete.mdx +++ b/src/content/docs/ruleset-engine/rulesets-api/delete.mdx @@ -22,8 +22,8 @@ Use one of the following API endpoints: | [Delete an account ruleset][dr-account] | `DELETE /accounts/{account_id}/rulesets/{ruleset_id}` | | [Delete a zone ruleset][dr-zone] | `DELETE /zones/{zone_id}/rulesets/{ruleset_id}` | -[dr-account]: /api/operations/deleteAccountRuleset -[dr-zone]: /api/operations/deleteZoneRuleset +[dr-account]: /api/resources/rulesets/methods/delete/ +[dr-zone]: /api/resources/rulesets/methods/delete/ If the delete operation succeeds, the API method call returns a `204 No Content` HTTP status code. @@ -56,8 +56,8 @@ Use one of the following API endpoints: | [Delete an account ruleset version][drv-account] | `DELETE /accounts/{account_id}/rulesets/{ruleset_id}/versions/{version_number}` | | [Delete a zone ruleset version][drv-zone] | `DELETE /zones/{zone_id}/rulesets/{ruleset_id}/versions/{version_number}` | -[drv-account]: /api/operations/deleteAccountRulesetVersion -[drv-zone]: /api/operations/deleteZoneRulesetVersion +[drv-account]: /api/resources/rulesets/methods/delete/Version +[drv-zone]: /api/resources/rulesets/subresources/versions/methods/delete/ If the delete operation succeeds, the method call returns a `204 No Content` HTTP status code. diff --git a/src/content/docs/ruleset-engine/rulesets-api/endpoints.mdx b/src/content/docs/ruleset-engine/rulesets-api/endpoints.mdx index 14cde98b687b180..467c86afdf28890 100644 --- a/src/content/docs/ruleset-engine/rulesets-api/endpoints.mdx +++ b/src/content/docs/ruleset-engine/rulesets-api/endpoints.mdx @@ -35,9 +35,9 @@ For help with endpoints and pagination, refer to [Getting Started: Endpoints](/f The Rulesets API endpoints require a value for `{account_id}` or `{zone_id}`. -To retrieve a list of accounts you have access to, use the [List Accounts](/api/operations/accounts-list-accounts) operation. Note the IDs of the accounts you want to manage. +To retrieve a list of accounts you have access to, use the [List Accounts](/api/resources/accounts/methods/list/) operation. Note the IDs of the accounts you want to manage. -To retrieve a list of zones you have access to, use the [List Zones](/api/operations/zones-get) operation. Note the IDs of the zones you want to manage. +To retrieve a list of zones you have access to, use the [List Zones](/api/resources/zones/methods/list/) operation. Note the IDs of the zones you want to manage. ::: diff --git a/src/content/docs/ruleset-engine/rulesets-api/update-rule.mdx b/src/content/docs/ruleset-engine/rulesets-api/update-rule.mdx index 221ec6dca0d003b..17e249550c2c9cf 100644 --- a/src/content/docs/ruleset-engine/rulesets-api/update-rule.mdx +++ b/src/content/docs/ruleset-engine/rulesets-api/update-rule.mdx @@ -17,8 +17,8 @@ Use one of the following API endpoints: | [Update an account ruleset rule][ur-account] | `PATCH /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}` | | [Update a zone ruleset rule][ur-zone] | `PATCH /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}` | -[ur-account]: /api/operations/updateAccountRulesetRule -[ur-zone]: /api/operations/updateZoneRulesetRule +[ur-account]: /api/resources/rulesets/subresources/rules/methods/edit/ +[ur-zone]: /api/resources/rulesets/methods/update/ You can update the definition of the rule, changing its fields, or change the order of the rule in the ruleset. Invoking this method creates a new version of the ruleset. diff --git a/src/content/docs/ruleset-engine/rulesets-api/update.mdx b/src/content/docs/ruleset-engine/rulesets-api/update.mdx index b6fbe13a352e918..63f6383bac7bc3b 100644 --- a/src/content/docs/ruleset-engine/rulesets-api/update.mdx +++ b/src/content/docs/ruleset-engine/rulesets-api/update.mdx @@ -17,10 +17,10 @@ Use one of the following API endpoints: | [Update an account entry point ruleset][uep-account] | `PUT /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint` | | [Update a zone entry point ruleset][uep-zone] | `PUT /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint` | -[ur-account]: /api/operations/updateAccountRuleset -[ur-zone]: /api/operations/updateZoneRuleset -[uep-account]: /api/operations/updateAccountEntrypointRuleset -[uep-zone]: /api/operations/updateZoneEntrypointRuleset +[ur-account]: /api/resources/rulesets/methods/update/ +[ur-zone]: /api/resources/rulesets/methods/update/ +[uep-account]: /api/resources/rulesets/subresources/phases/methods/update/ +[uep-zone]: /api/resources/rulesets/subresources/phases/methods/update/ :::note You cannot update the name of the ruleset or its type. Do not include these fields in the `data` field of your `PUT` request. diff --git a/src/content/docs/ruleset-engine/rulesets-api/view.mdx b/src/content/docs/ruleset-engine/rulesets-api/view.mdx index 6e2b2cd5474629d..97d37fcfd359939 100644 --- a/src/content/docs/ruleset-engine/rulesets-api/view.mdx +++ b/src/content/docs/ruleset-engine/rulesets-api/view.mdx @@ -23,8 +23,8 @@ Use one of the following API endpoints: | [List account rulesets][lr-account] | `GET /accounts/{account_id}/rulesets` | | [List zone rulesets][lr-zone] | `GET /zones/{zone_id}/rulesets` | -[lr-account]: /api/operations/listAccountRulesets -[lr-zone]: /api/operations/listZoneRulesets +[lr-account]: /api/resources/rulesets/methods/list/ +[lr-zone]: /api/resources/rulesets/methods/list/ The result includes rulesets across all phases at a given level (account or zone). The `phase` field in each result element indicates the [phase](/ruleset-engine/about/phases/) where that ruleset is defined. @@ -75,10 +75,10 @@ Use one of the following API endpoints: | [Get an account entry point ruleset][gep-account] | `GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint` | | [Get a zone entry point ruleset][gep-zone] | `GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint` | -[gr-account]: /api/operations/getAccountRuleset -[gr-zone]: /api/operations/getZoneRuleset -[gep-account]: /api/operations/getAccountEntrypointRuleset -[gep-zone]: /api/operations/getZoneEntrypointRuleset +[gr-account]: /api/resources/rulesets/methods/get/ +[gr-zone]: /api/resources/rulesets/methods/get/ +[gep-account]: /api/resources/rulesets/subresources/phases/methods/get/ +[gep-zone]: /api/resources/rulesets/subresources/phases/methods/get/ :::note You can only use the _Get a zone ruleset_ operation for zone-level phase entry points (entry points where `kind` is set to `zone`). @@ -138,10 +138,10 @@ Use one of the following API endpoints: | [List account entry point ruleset versions][lev-account] | `GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions` | | [List zone entry point ruleset versions][lev-zone] | `GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint/versions` | -[lv-account]: /api/operations/listAccountRulesetVersions -[lv-zone]: /api/operations/listZoneRulesetVersions -[lev-account]: /api/operations/listAccountEntrypointRulesetVersions -[lev-zone]: /api/operations/listZoneEntrypointRulesetVersions +[lv-account]: /api/resources/rulesets/subresources/versions/methods/list/ +[lv-zone]: /api/resources/rulesets/subresources/versions/methods/list/ +[lev-account]: /api/resources/rulesets/subresources/phases/subresources/versions/methods/list/ +[lev-zone]: /api/resources/rulesets/subresources/phases/subresources/versions/methods/list/ The result contains the ruleset properties of each version, but it does not include the list of rules. Refer to [View a specific version of a ruleset](#view-a-specific-version-of-a-ruleset) for instructions on obtaining this information. @@ -195,10 +195,10 @@ Use one of the following API endpoints: | [Get an account entry point ruleset version][gerv-account] | `GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions/{version_number}` | | [Get a zone entry point ruleset version][gerv-zone] | `GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint/versions/{version_number}` | -[grv-account]: /api/operations/getAccountRulesetVersion -[grv-zone]: /api/operations/getZoneRulesetVersion -[gerv-account]: /api/operations/getAccountEntrypointRulesetVersion -[gerv-zone]: /api/operations/getZoneEntrypointRulesetVersion +[grv-account]: /api/resources/rulesets/methods/get/Version +[grv-zone]: /api/resources/rulesets/subresources/versions/methods/get/ +[gerv-account]: /api/resources/rulesets/subresources/phases/methods/get/Version +[gerv-zone]: /api/resources/rulesets/subresources/phases/subresources/versions/methods/get/ When the specified phase entry point ruleset does not exist, this API method returns a `404 Not Found` HTTP status code. @@ -241,67 +241,3 @@ curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id}/ :::note When you view a specific version of a managed ruleset, each rule listed in the result can have one or more associated categories/tags, and it will not contain an expression. ::: - -## List rules in a managed ruleset with a specific tag - -Returns a list of all the rules in a managed ruleset with a specific tag. - -| Operation | Method + Endpoint | -| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| [List rules in account ruleset version by tag][lrbt] | `GET /accounts/{account_id}/rulesets/{managed_ruleset_id}/versions/{version_number}/by_tag/{tag_name}` | - -[lrbt]: /api/operations/listAccountRulesetVersionRulesByTag - -### Example - -```bash -curl https://api.cloudflare.com/client/v4/accounts/{account_id}/rulesets/{ruleset_id}/versions/2/by_tag/wordpress \ ---header "Authorization: Bearer " -``` - -```json output -{ - "result": { - "id": "", - "name": "Cloudflare Managed Ruleset", - "description": "Managed ruleset created by Cloudflare", - "kind": "managed", - "version": "4", - "rules": [ - { - "id": "", - "version": "3", - "action": "log", - "categories": [ - "cve-2014-5265", - "cve-2014-5266", - "cve-2014-5267", - "dos", - "drupal", - "wordpress" - ], - "description": "Drupal, WordPress - DoS - XMLRPC - CVE:CVE-2014-5265, CVE:CVE-2014-5266, CVE:CVE-2014-5267", - "last_updated": "2023-03-19T16:54:32.942986Z", - "ref": "", - "enabled": true - }, - { - "id": "", - "version": "3", - "action": "block", - "categories": ["broken-access-control", "cve-2018-12895", "wordpress"], - "description": "WordPress - Broken Access Control - CVE:CVE-2018-12895", - "last_updated": "2023-03-19T16:54:32.942986Z", - "ref": "", - "enabled": true - } - // (...) - ], - "last_updated": "2023-03-19T16:54:32.942986Z", - "phase": "http_request_firewall_managed" - }, - "success": true, - "errors": [], - "messages": [] -} -``` diff --git a/src/content/docs/security-center/indicator-feeds.mdx b/src/content/docs/security-center/indicator-feeds.mdx index 037efedd21f7b2b..8494942ee3b90bc 100644 --- a/src/content/docs/security-center/indicator-feeds.mdx +++ b/src/content/docs/security-center/indicator-feeds.mdx @@ -29,10 +29,10 @@ If your organization is interested in becoming a provider or a subscriber, conta ### Create a Custom Indicator Feed -Providers can create and manage a Custom Indicator Feed with the [Custom Indicator Feeds API endpoints](/api/operations/custom-indicator-feeds-get-indicator-feeds): +Providers can create and manage a Custom Indicator Feed with the [Custom Indicator Feeds API endpoints](/api/resources/intel/subresources/indicator_feeds/methods/list/): 1. Contact your account team to configure your account as an indicator feed provider. -2. Create a feed with the [Create new indicator feed endpoint](/api/operations/custom-indicator-feeds-create-indicator-feeds). Make note of the `feed_id` generated for your feed. For example: +2. Create a feed with the [Create new indicator feed endpoint](/api/resources/intel/subresources/indicator_feeds/methods/create/). Make note of the `feed_id` generated for your feed. For example: ```bash title="Create new indicator feed" curl "https://api.cloudflare.com/client/v4/accounts//intel/indicator-feeds" \ @@ -60,7 +60,7 @@ Providers can create and manage a Custom Indicator Feed with the [Custom Indicat } ``` -3. Upload data to the feed with the [Update indicator feed data endpoint](/api/operations/custom-indicator-feeds-update-indicator-feed-data). Uploaded indicator data must be in a [`.stix2`](https://oasis-open.github.io/cti-documentation/stix/intro) formatted file. +3. Upload data to the feed with the [Update indicator feed data endpoint](/api/resources/intel/subresources/indicator_feeds/subresources/snapshots/methods/update/). Uploaded indicator data must be in a [`.stix2`](https://oasis-open.github.io/cti-documentation/stix/intro) formatted file. ```bash title="Update indicator feed data" curl --request PUT \ @@ -88,7 +88,7 @@ Providers can create and manage a Custom Indicator Feed with the [Custom Indicat Indicator feeds use a snapshot system. To update feeds with new data, providers must upload a file containing all previous and new indicators. ::: -4. (Optional) Verify the status of your feed upload with the [Get indicator feed data endpoint](/api/operations/custom-indicator-feeds-get-indicator-feed-data). For example: +4. (Optional) Verify the status of your feed upload with the [Get indicator feed data endpoint](/api/resources/intel/subresources/indicator_feeds/methods/data/). For example: ```bash title="Get indicator feed data" curl --request GET \ @@ -114,7 +114,7 @@ Providers can create and manage a Custom Indicator Feed with the [Custom Indicat } ``` -5. Grant access to subscribers with the [Grant permission to indicator feed endpoint](/api/operations/custom-indicator-feeds-add-permission). You can add subscribers to the feed's allowed subscribers list using their [account IDs](/fundamentals/setup/find-account-and-zone-ids/). For example: +5. Grant access to subscribers with the [Grant permission to indicator feed endpoint](/api/resources/intel/subresources/indicator_feeds/subresources/permissions/methods/create/). You can add subscribers to the feed's allowed subscribers list using their [account IDs](/fundamentals/setup/find-account-and-zone-ids/). For example: ```bash title="Update indicator feed data" curl --request PUT \ diff --git a/src/content/docs/security-center/intel-apis/index.mdx b/src/content/docs/security-center/intel-apis/index.mdx index 4740f70cac2baaf..cbb44b1f1e0c42f 100644 --- a/src/content/docs/security-center/intel-apis/index.mdx +++ b/src/content/docs/security-center/intel-apis/index.mdx @@ -11,17 +11,17 @@ Cloudflare provides a series of endpoints covering various areas of internet sec | Intelligence Endpoint | Definition | | ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [ASN Intelligence](/api/operations/asn-intelligence-get-asn-overview) | Provides an overview of the Autonomous System Number (ASN) and a list of subnets for it. | -| [Custom Indicator Feed Download](/api/operations/custom-indicator-feeds-download-indicator-feed-data) | Provides the ability to download any custom indicator feeds that users create. | -| [Domain Intelligence](/api/operations/domain-intelligence-get-domain-details) | Provides security details and statistics about a domain. | -| [Domain History](/api/operations/domain-history-get-domain-history) | Provides historical security threat and content categories that are currently and previously assigned to a domain. | -| [IP Intelligence](/api/operations/ip-intelligence-get-ip-overview) | Provides the geolocation, ASN, infrastructure type of the ASN, and any security threat categories of an IP address. | -| [Passive DNS by IP](/api/operations/passive-dns-by-ip-get-passive-dns-by-ip) | Provides a list of all the domains, including first seen and last seen dates, that have resolved to a specific IP address. | -| [Phishing Intelligence](/api/operations/phishing-url-information-get-results-for-a-url-scan) | Provides phishing details about a URL. | -| [Miscategorization Intelligence](/api/operations/miscategorization-create-miscategorization) | Enables users to submit requests for modifying a domain's category, subsequently undergoing review by the Cloudflare Intelligence team. | -| [Priority Intelligence Requirements](/api/operations/cloudforce-one-priority-new) | Provides a structured approach to identifying intelligence gaps, formulating precise requirements, and organizing them into categories. | -| [Request for Information](/api/operations/cloudforce-one-request-new) | Creates a targeted inquiry for specific intelligence insights to help organizations understand and respond to imminent security threats and vulnerabilities. | -| [WHOIS](/api/operations/whois-record-get-whois-record) | Provides the WHOIS registration information for a specific domain. | +| [ASN Intelligence](/api/resources/intel/subresources/asn/methods/get/) | Provides an overview of the Autonomous System Number (ASN) and a list of subnets for it. | +| [Custom Indicator Feed Download](/api/resources/intel/subresources/indicator_feeds/subresources/downloads/methods/get/) | Provides the ability to download any custom indicator feeds that users create. | +| [Domain Intelligence](/api/resources/intel/subresources/domains/methods/get/) | Provides security details and statistics about a domain. | +| [Domain History](/api/resources/intel/subresources/domain_history/methods/get/) | Provides historical security threat and content categories that are currently and previously assigned to a domain. | +| [IP Intelligence](/api/resources/intel/subresources/ips/methods/get/) | Provides the geolocation, ASN, infrastructure type of the ASN, and any security threat categories of an IP address. | +| [Passive DNS by IP](/api/resources/intel/subresources/dns/methods/list/) | Provides a list of all the domains, including first seen and last seen dates, that have resolved to a specific IP address. | +| [Phishing Intelligence](/api/resources/brand_protection/methods/url_info/) | Provides phishing details about a URL. | +| [Miscategorization Intelligence](/api/resources/intel/subresources/miscategorizations/methods/create/) | Enables users to submit requests for modifying a domain's category, subsequently undergoing review by the Cloudflare Intelligence team. | +| [Priority Intelligence Requirements](/api/resources/cloudforce_one/subresources/requests/subresources/priority/methods/create/) | Provides a structured approach to identifying intelligence gaps, formulating precise requirements, and organizing them into categories. | +| [Request for Information](/api/resources/cloudforce_one/subresources/requests/methods/create/) | Creates a targeted inquiry for specific intelligence insights to help organizations understand and respond to imminent security threats and vulnerabilities. | +| [WHOIS](/api/resources/intel/subresources/whois/methods/get/) | Provides the WHOIS registration information for a specific domain. | | [DDoS Botnet Threat Feed](/ddos-protection/botnet-threat-feed/)
(early access) | Provides information to service providers about their own IP addresses that have participated in HTTP DDoS attacks as observed from Cloudflare's global network. | ## API Examples diff --git a/src/content/docs/security-center/intel-apis/manage-miscategorization-reports.mdx b/src/content/docs/security-center/intel-apis/manage-miscategorization-reports.mdx index 2669932414ee7a2..76a444f6b0388e7 100644 --- a/src/content/docs/security-center/intel-apis/manage-miscategorization-reports.mdx +++ b/src/content/docs/security-center/intel-apis/manage-miscategorization-reports.mdx @@ -10,7 +10,7 @@ This guide will show you how to manage miscategorization of reports. To complete 1. Create an [API token](/fundamentals/api/get-started/create-token/) if you do not have one already. 2. Choose **Custom Token**. 3. Name the token, and grant permissions. -4. Send a `POST` request to the miscategorization [API endpoint](https://developers.cloudflare.com/api/operations/miscategorization-create-miscategorization). You can find an example below: +4. Send a `POST` request to the miscategorization [API endpoint](https://developers.cloudflare.com/api/resources/intel/subresources/miscategorizations/methods/create/). You can find an example below: ```json title="Example of a POST request to miscategorization API" diff --git a/src/content/docs/security-center/investigate/change-categorization.mdx b/src/content/docs/security-center/investigate/change-categorization.mdx index 4ce566997eeac8f..ddf80c8c91b0f2d 100644 --- a/src/content/docs/security-center/investigate/change-categorization.mdx +++ b/src/content/docs/security-center/investigate/change-categorization.mdx @@ -60,7 +60,7 @@ To request a categorization change via the API: | --------------------- | ------------ | | Include | All accounts | -2. Make a call to the [miscategorization endpoint](/api/operations/miscategorization-create-miscategorization) including the domain name and any categories you would like to add or remove. For example: +2. Make a call to the [miscategorization endpoint](/api/resources/intel/subresources/miscategorizations/methods/create/) including the domain name and any categories you would like to add or remove. For example: ```bash curl https://api.cloudflare.com/client/v4/accounts/{account_id}/intel/miscategorization \ diff --git a/src/content/docs/spectrum/get-started.mdx b/src/content/docs/spectrum/get-started.mdx index fd9530ee2bd9e1f..1b93a8a4decb719 100644 --- a/src/content/docs/spectrum/get-started.mdx +++ b/src/content/docs/spectrum/get-started.mdx @@ -10,7 +10,7 @@ import { Details, Render } from "~/components" Spectrum is available on all paid plans. Pro and Business support selected protocols only, whereas Enterprise supports all TCP and UDP based traffic. Refer to [Configuration options](/spectrum/reference/configuration-options/) for more configuration details. -To create a Spectrum application, you can either use an IP address, a CNAME Record or a load balancer. Independently of the method you use, you can create the application through the dashboard or via [API](/api/operations/spectrum-applications-list-spectrum-applications). +To create a Spectrum application, you can either use an IP address, a CNAME Record or a load balancer. Independently of the method you use, you can create the application through the dashboard or via [API](/api/resources/spectrum/subresources/apps/methods/list/). Certain fields in Spectrum request and response bodies require an Enterprise plan. Refer to the [Settings by plan](/spectrum/reference/settings-by-plan/) page for more details. diff --git a/src/content/docs/spectrum/reference/analytics.mdx b/src/content/docs/spectrum/reference/analytics.mdx index cdeffe4096ac466..43d963b62ae597a 100644 --- a/src/content/docs/spectrum/reference/analytics.mdx +++ b/src/content/docs/spectrum/reference/analytics.mdx @@ -87,4 +87,4 @@ curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/spectrum/analytics/ev --header "X-Auth-Key: " ``` -Refer to the [Spectrum API documentation](/api/operations/spectrum-aggregate-analytics-get-current-aggregated-analytics) for more examples of API requests. +Refer to the [Spectrum API documentation](/api/resources/spectrum/subresources/analytics/subresources/aggregates/subresources/currents/methods/get/) for more examples of API requests. diff --git a/src/content/docs/spectrum/reference/configuration-options.mdx b/src/content/docs/spectrum/reference/configuration-options.mdx index 9ef2a773c61e11e..8a491294b181aa0 100644 --- a/src/content/docs/spectrum/reference/configuration-options.mdx +++ b/src/content/docs/spectrum/reference/configuration-options.mdx @@ -104,7 +104,7 @@ Spectrum offers three modes of TLS termination: 'Flexible', 'Full', and 'Full (S TLS versions supported by Spectrum include TLS 1.1, TLS 1.2, and TLS 1.3. -You can manage this through the Spectrum app at the Cloudflare dashboard, or using the [Spectrum API endpoint](/api/operations/spectrum-applications-update-spectrum-application-configuration-using-a-name-for-the-origin). +You can manage this through the Spectrum app at the Cloudflare dashboard, or using the [Spectrum API endpoint](/api/resources/spectrum/subresources/apps/methods/update/). :::note[Note] diff --git a/src/content/docs/spectrum/reference/settings-by-plan.mdx b/src/content/docs/spectrum/reference/settings-by-plan.mdx index b19c28c41947215..bf3f051fb4173ed 100644 --- a/src/content/docs/spectrum/reference/settings-by-plan.mdx +++ b/src/content/docs/spectrum/reference/settings-by-plan.mdx @@ -29,5 +29,5 @@ Spectrum properties requiring an Enterprise plan: -Review the [Spectrum API documentation](/api/operations/spectrum-applications-list-spectrum-applications) for example API requests. +Review the [Spectrum API documentation](/api/resources/spectrum/subresources/apps/methods/list/) for example API requests. diff --git a/src/content/docs/speed/optimization/content/prefetch-urls.mdx b/src/content/docs/speed/optimization/content/prefetch-urls.mdx index c3e5d3fdba95dff..7aea1e06f47e994 100644 --- a/src/content/docs/speed/optimization/content/prefetch-urls.mdx +++ b/src/content/docs/speed/optimization/content/prefetch-urls.mdx @@ -33,7 +33,7 @@ To enable **Prefetch URLs** in the dashboard: -To enable or disable **Prefetch URLs** with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `prefetch_preload` as the setting name in the URI path, and the `value` parameter set to your desired setting (`"on"` or `"off"`). +To enable or disable **Prefetch URLs** with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `prefetch_preload` as the setting name in the URI path, and the `value` parameter set to your desired setting (`"on"` or `"off"`). diff --git a/src/content/docs/speed/optimization/content/rocket-loader/enable.mdx b/src/content/docs/speed/optimization/content/rocket-loader/enable.mdx index 9f2c6b1249344f8..60f378ce2445b4a 100644 --- a/src/content/docs/speed/optimization/content/rocket-loader/enable.mdx +++ b/src/content/docs/speed/optimization/content/rocket-loader/enable.mdx @@ -25,7 +25,7 @@ To enable or disable **Rocket Loader** in the dashboard: -To enable or disable **Rocket Loader** with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `rocket_loader` as the setting name in the URI path, and the `value` parameter set to `"on"` or `"off"`. +To enable or disable **Rocket Loader** with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `rocket_loader` as the setting name in the URI path, and the `value` parameter set to `"on"` or `"off"`. diff --git a/src/content/docs/speed/optimization/protocol/0-rtt-connection-resumption.mdx b/src/content/docs/speed/optimization/protocol/0-rtt-connection-resumption.mdx index f99d35996f2f499..4489e6f65255fa8 100644 --- a/src/content/docs/speed/optimization/protocol/0-rtt-connection-resumption.mdx +++ b/src/content/docs/speed/optimization/protocol/0-rtt-connection-resumption.mdx @@ -33,7 +33,7 @@ To enable 0-RTT Connection Resumption in the dashboard: -To adjust your 0-RTT Connection Resumption settings with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `0rtt` as the setting name in the URI path, and the `value` parameter set to `"on"` or `"off"`. +To adjust your 0-RTT Connection Resumption settings with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `0rtt` as the setting name in the URI path, and the `value` parameter set to `"on"` or `"off"`. diff --git a/src/content/docs/speed/optimization/protocol/enhanced-http2-prioritization.mdx b/src/content/docs/speed/optimization/protocol/enhanced-http2-prioritization.mdx index 8696e0e5e9b5f80..4344beb14ef5891 100644 --- a/src/content/docs/speed/optimization/protocol/enhanced-http2-prioritization.mdx +++ b/src/content/docs/speed/optimization/protocol/enhanced-http2-prioritization.mdx @@ -35,6 +35,6 @@ To enable **Enhanced HTTP/2 Prioritization** in the Cloudflare dashboard: -To enable **Enhanced HTTP/2 Prioritization** using the Cloudflare API, send a [`PATCH` request](/api/operations/zone-settings-edit-single-setting) with `h2_prioritization` as the setting name in the URI path, and the `value` parameter set to `"on"`. +To enable **Enhanced HTTP/2 Prioritization** using the Cloudflare API, send a [`PATCH` request](/api/resources/zones/subresources/settings/methods/edit/) with `h2_prioritization` as the setting name in the URI path, and the `value` parameter set to `"on"`. diff --git a/src/content/docs/speed/optimization/protocol/http2.mdx b/src/content/docs/speed/optimization/protocol/http2.mdx index ee86fb9bfc85645..13906f7a73ace21 100644 --- a/src/content/docs/speed/optimization/protocol/http2.mdx +++ b/src/content/docs/speed/optimization/protocol/http2.mdx @@ -39,6 +39,6 @@ To disable **HTTP/2** in the dashboard: -To disable **HTTP/2** with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `http2` as the setting name in the URI path, and the `value` parameter set to `"off"`. +To disable **HTTP/2** with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `http2` as the setting name in the URI path, and the `value` parameter set to `"off"`. diff --git a/src/content/docs/speed/optimization/protocol/http3.mdx b/src/content/docs/speed/optimization/protocol/http3.mdx index 2984681761fc615..bc133a0d3dfc36e 100644 --- a/src/content/docs/speed/optimization/protocol/http3.mdx +++ b/src/content/docs/speed/optimization/protocol/http3.mdx @@ -41,6 +41,6 @@ To enable **HTTP/3** in the dashboard: -To enable **HTTP/3** with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `http3` as the setting name in the URI path, and the `value` parameter set to `"on"`. +To enable **HTTP/3** with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `http3` as the setting name in the URI path, and the `value` parameter set to `"on"`. diff --git a/src/content/docs/ssl/client-certificates/byo-ca.mdx b/src/content/docs/ssl/client-certificates/byo-ca.mdx index 3bb018eeabcd6de..a51deb5e6eaea3e 100644 --- a/src/content/docs/ssl/client-certificates/byo-ca.mdx +++ b/src/content/docs/ssl/client-certificates/byo-ca.mdx @@ -28,7 +28,7 @@ This is especially useful if you already have mTLS implemented and client certif ## Set up mTLS with your CA -1. Use the [Upload mTLS certificate endpoint](/api/operations/m-tls-certificate-management-upload-m-tls-certificate) to upload the CA root certificate. +1. Use the [Upload mTLS certificate endpoint](/api/resources/mtls_certificates/methods/create/) to upload the CA root certificate. @@ -46,7 +46,7 @@ This is especially useful if you already have mTLS implemented and client certif 2. Take note of the certificate ID (`id`) that is returned in the API response. -3. Use the [Replace Hostname Associations endpoint](/api/operations/client-certificate-for-a-zone-put-hostname-associations) to enable mTLS in each hostname that should use the CA for mTLS validation. Use the following parameters: +3. Use the [Replace Hostname Associations endpoint](/api/resources/certificate_authorities/subresources/hostname_associations/methods/update/) to enable mTLS in each hostname that should use the CA for mTLS validation. Use the following parameters: @@ -82,23 +82,21 @@ This is especially useful if you already have mTLS implemented and client certif If you want to remove a CA that you have previously uploaded, you must first remove any hostname associations that it has. -1. Make a request to the [Replace Hostname Associations endpoint](/api/operations/client-certificate-for-a-zone-put-hostname-associations), with an empty array for `hostnames` and specifying your CA certificate ID in `mtls_certificate_id`: +1. Make a request to the [Replace Hostname Associations endpoint](/api/resources/certificate_authorities/subresources/hostname_associations/methods/update/), with an empty array for `hostnames` and specifying your CA certificate ID in `mtls_certificate_id`: ```txt "hostnames": [], "mtls_certificate_id": "" ``` -2. Use the [Delete mTLS certificate endpoint](/api/operations/m-tls-certificate-management-delete-m-tls-certificate) to delete the certificate. +2. Use the [Delete mTLS certificate endpoint](/api/resources/mtls_certificates/methods/delete/) to delete the certificate. ## List CA hostname associations -You can also use the [API](/api/operations/client-certificate-for-a-zone-list-hostname-associations) to list the hostname associations. Make sure you include the query parameter `mtls_certificate_id`, where `mtls_certificate_id` is the certificate ID of the uploaded CA (step 2 above). +You can also use the [API](/api/resources/certificate_authorities/subresources/hostname_associations/methods/get/) to list the hostname associations. Make sure you include the query parameter `mtls_certificate_id`, where `mtls_certificate_id` is the certificate ID of the uploaded CA (step 2 above). ```bash curl "https://api.cloudflare.com/client/v4/zones/zone_id/certificate_authorities/hostname_associations?mtls_certificate_id={id_from_step_2}" \ --header "X-Auth-Email: " \ --header "X-Auth-Key: " -``` - - +``` \ No newline at end of file diff --git a/src/content/docs/ssl/edge-certificates/additional-options/always-use-https.mdx b/src/content/docs/ssl/edge-certificates/additional-options/always-use-https.mdx index 26e2088f378d664..9c371bd128b6c6b 100644 --- a/src/content/docs/ssl/edge-certificates/additional-options/always-use-https.mdx +++ b/src/content/docs/ssl/edge-certificates/additional-options/always-use-https.mdx @@ -46,7 +46,7 @@ To enable **Always Use HTTPS** in the dashboard: To enable or disable **Always Use HTTPS** with the API: 1. Make sure that your [SSL/TLS encryption mode](/ssl/origin-configuration/ssl-modes/off/) **is not** set to **Off**. -2. Send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `always_use_https` as the setting name in the URI path, and the `value` parameter set to your desired setting (`"on"` or `"off"`). +2. Send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `always_use_https` as the setting name in the URI path, and the `value` parameter set to your desired setting (`"on"` or `"off"`). diff --git a/src/content/docs/ssl/edge-certificates/additional-options/automatic-https-rewrites.mdx b/src/content/docs/ssl/edge-certificates/additional-options/automatic-https-rewrites.mdx index d2b3f167ef73b00..ceaa3505ba2957c 100644 --- a/src/content/docs/ssl/edge-certificates/additional-options/automatic-https-rewrites.mdx +++ b/src/content/docs/ssl/edge-certificates/additional-options/automatic-https-rewrites.mdx @@ -37,7 +37,7 @@ To enable **Automatic HTTPS Rewrites** in the dashboard: -To enable or disable **Automatic HTTPS Rewrites** with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `automatic_https_rewrites` as the setting name in the URI path, and the `value` parameter set to your desired setting (`"on"` or `"off"`). +To enable or disable **Automatic HTTPS Rewrites** with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `automatic_https_rewrites` as the setting name in the URI path, and the `value` parameter set to your desired setting (`"on"` or `"off"`). diff --git a/src/content/docs/ssl/edge-certificates/additional-options/cipher-suites/customize-cipher-suites.mdx b/src/content/docs/ssl/edge-certificates/additional-options/cipher-suites/customize-cipher-suites.mdx index 92903baefc10f43..3b990e104262f8b 100644 --- a/src/content/docs/ssl/edge-certificates/additional-options/cipher-suites/customize-cipher-suites.mdx +++ b/src/content/docs/ssl/edge-certificates/additional-options/cipher-suites/customize-cipher-suites.mdx @@ -37,8 +37,8 @@ Custom cipher suites is a hostname-level setting, which implies that: Currently, you can only customize cipher suites when using the API: -* [Zone](/api/operations/zone-settings-edit-single-setting) (using `ciphers` as the setting name in the URI path) -* [Per-hostname](/api/operations/per-hostname-tls-settings-put) (regular zones only) +* [Zone](/api/resources/zones/subresources/settings/methods/edit/) (using `ciphers` as the setting name in the URI path) +* [Per-hostname](/api/resources/hostnames/subresources/settings/subresources/tls/methods/update/) (regular zones only) * [Custom hostname](/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/enforce-mtls/#cipher-suites) (Cloudflare for SaaS zones only) ### Settings priority and ciphers order @@ -68,7 +68,7 @@ Note that: 3. Get the Zone ID from the [Overview page](https://dash.cloudflare.com/?to=/:account/:zone/) of the domain you want to specify cipher suites for. -4. Make an API call to either the [Edit zone setting](/api/operations/zone-settings-edit-single-setting) endpoint or the [Edit TLS setting for hostname](/api/operations/per-hostname-tls-settings-put) endpoint, specifying `ciphers` in the URL. List your array of chosen cipher suites in the `value` field. +4. Make an API call to either the [Edit zone setting](/api/resources/zones/subresources/settings/methods/edit/) endpoint or the [Edit TLS setting for hostname](/api/resources/hostnames/subresources/settings/subresources/tls/methods/update/) endpoint, specifying `ciphers` in the URL. List your array of chosen cipher suites in the `value` field. :::caution @@ -154,7 +154,7 @@ curl --request PATCH \ -To reset to the default cipher suites at zone level, use the [Edit zone setting](/api/operations/zone-settings-edit-single-setting) endpoint, specifying `ciphers` as the setting name in the URL, and send an empty array in the `value` field. +To reset to the default cipher suites at zone level, use the [Edit zone setting](/api/resources/zones/subresources/settings/methods/edit/) endpoint, specifying `ciphers` as the setting name in the URL, and send an empty array in the `value` field. ```bash curl --request PATCH \ @@ -167,7 +167,7 @@ curl --request PATCH \ -For specific hostname settings, use the [Delete TLS setting for hostname](/api/operations/per-hostname-tls-settings-delete) endpoint. +For specific hostname settings, use the [Delete TLS setting for hostname](/api/resources/hostnames/subresources/settings/subresources/tls/methods/delete/) endpoint. ```bash curl --request DELETE \ diff --git a/src/content/docs/ssl/edge-certificates/additional-options/cipher-suites/troubleshooting.mdx b/src/content/docs/ssl/edge-certificates/additional-options/cipher-suites/troubleshooting.mdx index 987113e54ff0c79..cd3a13559d17e1f 100644 --- a/src/content/docs/ssl/edge-certificates/additional-options/cipher-suites/troubleshooting.mdx +++ b/src/content/docs/ssl/edge-certificates/additional-options/cipher-suites/troubleshooting.mdx @@ -31,7 +31,7 @@ It is not possible to configure minimum TLS version nor cipher suites for [Cloud ## API requirements for custom hostname certificate -When using the [Edit Custom Hostname endpoint](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname), make sure to include `type` and `method` within the `ssl` object, as well as the `settings` specifications. +When using the [Edit Custom Hostname endpoint](/api/resources/custom_hostnames/methods/edit/), make sure to include `type` and `method` within the `ssl` object, as well as the `settings` specifications. Including the `settings` only will result in the error message `The SSL attribute is invalid. Please refer to the API documentation, check your input and try again`. diff --git a/src/content/docs/ssl/edge-certificates/additional-options/http-strict-transport-security.mdx b/src/content/docs/ssl/edge-certificates/additional-options/http-strict-transport-security.mdx index b3d2194872c93d2..d325a26cdd4b20e 100644 --- a/src/content/docs/ssl/edge-certificates/additional-options/http-strict-transport-security.mdx +++ b/src/content/docs/ssl/edge-certificates/additional-options/http-strict-transport-security.mdx @@ -64,7 +64,7 @@ To enable HSTS using the dashboard: -To enable HSTS with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `security_header` as the setting name in the URI path, and specify the `value` object that includes your HSTS settings. +To enable HSTS with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `security_header` as the setting name in the URI path, and specify the `value` object that includes your HSTS settings. diff --git a/src/content/docs/ssl/edge-certificates/additional-options/minimum-tls.mdx b/src/content/docs/ssl/edge-certificates/additional-options/minimum-tls.mdx index 384d183059f7398..ed9f55563b77a4e 100644 --- a/src/content/docs/ssl/edge-certificates/additional-options/minimum-tls.mdx +++ b/src/content/docs/ssl/edge-certificates/additional-options/minimum-tls.mdx @@ -50,7 +50,7 @@ To manage the TLS version applied to your whole zone when proxied through Cloudf -Use the [Edit zone setting](/api/operations/zone-settings-edit-single-setting) endpoint with `min_tls_version` as the setting name in the URI path, and specify your preferred minimum version in the `value` field. +Use the [Edit zone setting](/api/resources/zones/subresources/settings/methods/edit/) endpoint with `min_tls_version` as the setting name in the URI path, and specify your preferred minimum version in the `value` field. In the following example, the minimum TLS version for the zone will be set to `1.2`. Replace the zone ID and API token placeholders with your information, and adjust the `value` field with your chosen TLS version. @@ -73,8 +73,8 @@ curl --request PATCH \ This is currently only available via the API: -- Use the [Edit TLS setting for hostname](/api/operations/per-hostname-tls-settings-put) endpoint to specify different values for `min_tls_version`. -- Use the [Delete TLS setting for hostname](/api/operations/per-hostname-tls-settings-delete) endpoint to clear previously defined `min_tls_version` setting. +- Use the [Edit TLS setting for hostname](/api/resources/hostnames/subresources/settings/subresources/tls/methods/update/) endpoint to specify different values for `min_tls_version`. +- Use the [Delete TLS setting for hostname](/api/resources/hostnames/subresources/settings/subresources/tls/methods/delete/) endpoint to clear previously defined `min_tls_version` setting. Cloudflare uses the [hostname priority logic](/ssl/reference/certificate-and-hostname-priority/) to determine which setting to apply. diff --git a/src/content/docs/ssl/edge-certificates/additional-options/opportunistic-encryption.mdx b/src/content/docs/ssl/edge-certificates/additional-options/opportunistic-encryption.mdx index 91f5f5b3d2c1322..d972fb534177e80 100644 --- a/src/content/docs/ssl/edge-certificates/additional-options/opportunistic-encryption.mdx +++ b/src/content/docs/ssl/edge-certificates/additional-options/opportunistic-encryption.mdx @@ -27,7 +27,7 @@ To enable Opportunistic Encryption in the dashboard: -To adjust your Opportunistic Encryption settings with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `opportunistic_encryption` as the setting name in the URI path, and specify the `value` parameter with your desired setting (`"on"` or `"off"`). +To adjust your Opportunistic Encryption settings with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `opportunistic_encryption` as the setting name in the URI path, and specify the `value` parameter with your desired setting (`"on"` or `"off"`). diff --git a/src/content/docs/ssl/edge-certificates/additional-options/tls-13.mdx b/src/content/docs/ssl/edge-certificates/additional-options/tls-13.mdx index f8917debba16dd1..33eb9407de13bac 100644 --- a/src/content/docs/ssl/edge-certificates/additional-options/tls-13.mdx +++ b/src/content/docs/ssl/edge-certificates/additional-options/tls-13.mdx @@ -35,7 +35,7 @@ To enable TLS 1.3 in the dashboard: -To adjust your TLS 1.3 settings with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `tls_1_3` as the setting name in the URI path, and set the `value` parameter to your desired setting (`"on"` or `"off"`). +To adjust your TLS 1.3 settings with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `tls_1_3` as the setting name in the URI path, and set the `value` parameter to your desired setting (`"on"` or `"off"`). diff --git a/src/content/docs/ssl/edge-certificates/additional-options/total-tls/enable.mdx b/src/content/docs/ssl/edge-certificates/additional-options/total-tls/enable.mdx index b0470eebd6d6e3d..3720953bc686379 100644 --- a/src/content/docs/ssl/edge-certificates/additional-options/total-tls/enable.mdx +++ b/src/content/docs/ssl/edge-certificates/additional-options/total-tls/enable.mdx @@ -23,7 +23,7 @@ To enable Total TLS in the dashboard: -To enable Total TLS with the API, send a [`PATCH`](/api/operations/total-tls-enable-or-disable-total-tls) request with the `enabled` parameter set to your desired setting (`true` or `false`). +To enable Total TLS with the API, send a [`PATCH`](/api/resources/acm/subresources/total_tls/methods/create/) request with the `enabled` parameter set to your desired setting (`true` or `false`). You can also specify a desired certificate authority by adding a value to the `certificate_authority` parameter. diff --git a/src/content/docs/ssl/edge-certificates/advanced-certificate-manager/api-commands.mdx b/src/content/docs/ssl/edge-certificates/advanced-certificate-manager/api-commands.mdx index e2ee02a51c45f5a..56ecfa4cd14b528 100644 --- a/src/content/docs/ssl/edge-certificates/advanced-certificate-manager/api-commands.mdx +++ b/src/content/docs/ssl/edge-certificates/advanced-certificate-manager/api-commands.mdx @@ -12,10 +12,10 @@ Use the following API commands to manage advanced certificates. If you are using | Command | Method | Endpoint | Additional notes | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| [Order advanced certificate](/api/operations/certificate-packs-order-advanced-certificate-manager-certificate-pack) | `POST` | `zones/<>/ssl/certificate_packs/order` | | -| [Restart certificate validation](/api/operations/certificate-packs-restart-validation-for-advanced-certificate-manager-certificate-pack) | `PATCH` | `zones/<>/ssl/certificate_packs/<>` | | -| [Delete certificate pack](/api/operations/certificate-packs-delete-advanced-certificate-manager-certificate-pack) | `DELETE` | `zones/<>/ssl/certificate_packs/<>` | | -| [List certificate packs in a zone](/api/operations/certificate-packs-list-certificate-packs) | `GET` | `zones/<>/ssl/certificate_packs?status=all` | This API call returns all certificate packs for a domain (Universal, Custom, and Advanced). | -| List Cipher Suite settings: [Get zone setting](/api/operations/zone-settings-get-single-setting) with `ciphers` as the setting name in the URI path | `GET` | `zones/<>/settings/ciphers` | | -| Change Cipher Suite settings: [Edit zone setting](/api/operations/zone-settings-edit-single-setting) with `ciphers` as the setting name in the URI path | `PATCH` | `zones/<>/settings/ciphers` | To restore default settings, send a blank array in the `value` parameter. | +| [Order advanced certificate](/api/resources/ssl/subresources/certificate_packs/methods/create/) | `POST` | `zones/<>/ssl/certificate_packs/order` | | +| [Restart certificate validation](/api/resources/ssl/subresources/certificate_packs/methods/edit/) | `PATCH` | `zones/<>/ssl/certificate_packs/<>` | | +| [Delete certificate pack](/api/resources/ssl/subresources/certificate_packs/methods/delete/) | `DELETE` | `zones/<>/ssl/certificate_packs/<>` | | +| [List certificate packs in a zone](/api/resources/ssl/subresources/certificate_packs/methods/list/) | `GET` | `zones/<>/ssl/certificate_packs?status=all` | This API call returns all certificate packs for a domain (Universal, Custom, and Advanced). | +| List Cipher Suite settings: [Get zone setting](/api/resources/zones/subresources/settings/methods/get/) with `ciphers` as the setting name in the URI path | `GET` | `zones/<>/settings/ciphers` | | +| Change Cipher Suite settings: [Edit zone setting](/api/resources/zones/subresources/settings/methods/edit/) with `ciphers` as the setting name in the URI path | `PATCH` | `zones/<>/settings/ciphers` | To restore default settings, send a blank array in the `value` parameter. | diff --git a/src/content/docs/ssl/edge-certificates/advanced-certificate-manager/manage-certificates.mdx b/src/content/docs/ssl/edge-certificates/advanced-certificate-manager/manage-certificates.mdx index 9dcec57b7101ce2..7ea0302ca6c97c5 100644 --- a/src/content/docs/ssl/edge-certificates/advanced-certificate-manager/manage-certificates.mdx +++ b/src/content/docs/ssl/edge-certificates/advanced-certificate-manager/manage-certificates.mdx @@ -14,7 +14,7 @@ import { AvailableNotifications, Render, TabItem, Tabs } from "~/components"; If you are using an existing [Universal SSL certificate](/ssl/edge-certificates/universal-ssl/), Cloudflare will automatically replace this certificate once you finish ordering your advanced certificate. -Once you order a certificate, you can review the [certificate's status](/ssl/reference/certificate-statuses/) in the dashboard at **SSL/TLS** > **Edge Certificates** or via the API with a [GET request](/api/operations/certificate-packs-list-certificate-packs). +Once you order a certificate, you can review the [certificate's status](/ssl/reference/certificate-statuses/) in the dashboard at **SSL/TLS** > **Edge Certificates** or via the API with a [GET request](/api/resources/ssl/subresources/certificate_packs/methods/list/). @@ -34,7 +34,7 @@ To create a new advanced certificate in the dashboard: -To create a new certificate using the API, send a [POST request](/api/operations/certificate-packs-order-advanced-certificate-manager-certificate-pack) to the Cloudflare API. +To create a new certificate using the API, send a [POST request](/api/resources/ssl/subresources/certificate_packs/methods/create/) to the Cloudflare API. If you need certificates for hostnames longer than 64 characters ([RFC 5280](https://www.rfc-editor.org/rfc/rfc5280.html)), set the `cloudflare_branding` option to `true`. This will add `sni.cloudflaressl.com` in the Common Name (CN) field and will include the long hostname as a part of the Subject Alternative Name (SAN). @@ -61,7 +61,7 @@ To delete an advanced certificate in the dashboard: -To delete a certificate using the API, send a [DELETE request](/api/operations/certificate-packs-delete-advanced-certificate-manager-certificate-pack) to the Cloudflare API. +To delete a certificate using the API, send a [DELETE request](/api/resources/ssl/subresources/certificate_packs/methods/delete/) to the Cloudflare API. @@ -69,7 +69,7 @@ To delete a certificate using the API, send a [DELETE request](/api/operations/c ## Restart validation -To restart validation for a certificate in a `validation_timed_out` status, send a [PATCH request](/api/operations/certificate-packs-restart-validation-for-advanced-certificate-manager-certificate-pack) to the API. +To restart validation for a certificate in a `validation_timed_out` status, send a [PATCH request](/api/resources/ssl/subresources/certificate_packs/methods/edit/) to the API. --- diff --git a/src/content/docs/ssl/edge-certificates/caa-records.mdx b/src/content/docs/ssl/edge-certificates/caa-records.mdx index b14c07d6a118a47..b6017fa37e619f6 100644 --- a/src/content/docs/ssl/edge-certificates/caa-records.mdx +++ b/src/content/docs/ssl/edge-certificates/caa-records.mdx @@ -50,7 +50,7 @@ To add a CAA record in the dashboard, -To create a CAA record via the API, use this [POST endpoint](/api/operations/dns-records-for-a-zone-create-dns-record). +To create a CAA record via the API, use this [POST endpoint](/api/resources/dns/subresources/records/methods/create/). diff --git a/src/content/docs/ssl/edge-certificates/changing-dcv-method/methods/delegated-dcv.mdx b/src/content/docs/ssl/edge-certificates/changing-dcv-method/methods/delegated-dcv.mdx index 7c03596d8092c43..742626e2f4474d2 100644 --- a/src/content/docs/ssl/edge-certificates/changing-dcv-method/methods/delegated-dcv.mdx +++ b/src/content/docs/ssl/edge-certificates/changing-dcv-method/methods/delegated-dcv.mdx @@ -108,7 +108,7 @@ Note that settings that interfere with the validation URLs can cause issues in t :::note -If a hostname becomes unreachable during certificate renewal time, the certificate will not be able to be renewed automatically via Delegated DCV. Should you need to renew a certificate for a hostname that is not resolving currently, you can send a PATCH request to [the changing DCV method API endpoint](/api/operations/ssl-verification-edit-ssl-certificate-pack-validation-method) and change the method to TXT to proceed with manual renewal per [the TXT DCV method](/ssl/edge-certificates/changing-dcv-method/methods/txt/). +If a hostname becomes unreachable during certificate renewal time, the certificate will not be able to be renewed automatically via Delegated DCV. Should you need to renew a certificate for a hostname that is not resolving currently, you can send a PATCH request to [the changing DCV method API endpoint](/api/resources/ssl/subresources/verification/methods/edit/) and change the method to TXT to proceed with manual renewal per [the TXT DCV method](/ssl/edge-certificates/changing-dcv-method/methods/txt/). Once the hostname becomes resolvable again, [Delegated DCV](/ssl/edge-certificates/changing-dcv-method/methods/delegated-dcv/) will resume working as expected. ::: diff --git a/src/content/docs/ssl/edge-certificates/changing-dcv-method/methods/index.mdx b/src/content/docs/ssl/edge-certificates/changing-dcv-method/methods/index.mdx index 663b8180d0a0219..fe54c99187cd142 100644 --- a/src/content/docs/ssl/edge-certificates/changing-dcv-method/methods/index.mdx +++ b/src/content/docs/ssl/edge-certificates/changing-dcv-method/methods/index.mdx @@ -33,7 +33,7 @@ For guidance on when you need to perform DCV, refer to [Domain Control Validatio ## Verify DCV status -To verify the [DCV status](/ssl/reference/certificate-statuses/) of a certificate, either monitor the certificate's status in the dashboard at **SSL/TLS** > **Edge Certificates** or use the [Verification Status endpoint](/api/operations/ssl-verification-ssl-verification-details). +To verify the [DCV status](/ssl/reference/certificate-statuses/) of a certificate, either monitor the certificate's status in the dashboard at **SSL/TLS** > **Edge Certificates** or use the [Verification Status endpoint](/api/resources/ssl/subresources/verification/methods/get/). A status of `active` means that the certificate has been deployed to Cloudflare’s global network and will be served as soon as HTTP traffic is proxied to Cloudflare. diff --git a/src/content/docs/ssl/edge-certificates/changing-dcv-method/validation-backoff-schedule.mdx b/src/content/docs/ssl/edge-certificates/changing-dcv-method/validation-backoff-schedule.mdx index ddc331f09831d33..6b13c0b19338146 100644 --- a/src/content/docs/ssl/edge-certificates/changing-dcv-method/validation-backoff-schedule.mdx +++ b/src/content/docs/ssl/edge-certificates/changing-dcv-method/validation-backoff-schedule.mdx @@ -17,7 +17,7 @@ If you use [Delegated DCV](/ssl/edge-certificates/changing-dcv-method/methods/de :::note -You can also request an immediate recheck by using the [Edit SSL Certificate Pack Validation Method endpoint](/api/operations/ssl-verification-edit-ssl-certificate-pack-validation-method), specifying the same `validation_method` as the [method](/ssl/edge-certificates/changing-dcv-method/methods/) you currently use. +You can also request an immediate recheck by using the [Edit SSL Certificate Pack Validation Method endpoint](/api/resources/ssl/subresources/verification/methods/edit/), specifying the same `validation_method` as the [method](/ssl/edge-certificates/changing-dcv-method/methods/) you currently use. ::: *** diff --git a/src/content/docs/ssl/edge-certificates/custom-certificates/bundling-methodologies.mdx b/src/content/docs/ssl/edge-certificates/custom-certificates/bundling-methodologies.mdx index e1718a0eccb43dd..9274feb91364863 100644 --- a/src/content/docs/ssl/edge-certificates/custom-certificates/bundling-methodologies.mdx +++ b/src/content/docs/ssl/edge-certificates/custom-certificates/bundling-methodologies.mdx @@ -14,21 +14,21 @@ You can control the mechanics of how certificates are bundled by specifying a bu Cloudflare maintains intermediate and root certificates used for bundling on a [GitHub repository](https://github.com/cloudflare/cfssl_trust). As the certificates expire or are removed by certificate authorities, Cloudflare removes and adds them accordingly. -Expiration values for these certificates may appear in the `expires_on` field when you use the [Analyze Certificate endpoint](/api/operations/analyze-certificate-analyze-certificate) - often when the methodology you specify is [Compatible](#compatible). However, these expiration values reflect intermediate and root certificates - which are handled by Cloudflare -, not the leaf certificate you would have previously uploaded to Cloudflare. +Expiration values for these certificates may appear in the `expires_on` field when you use the [Analyze Certificate endpoint](/api/resources/ssl/subresources/analyze/methods/create/) - often when the methodology you specify is [Compatible](#compatible). However, these expiration values reflect intermediate and root certificates - which are handled by Cloudflare -, not the leaf certificate you would have previously uploaded to Cloudflare. ## Methodologies ### Compatible Compatible is the default methodology and uses **common and well distributed intermediate certificates** to complete the chain. This ensures that the resulting bundle is compatible with as many clients as possible. -The related value for the `bundle_method` parameter when using the [API](/api/operations/custom-ssl-for-a-zone-create-ssl-configuration) is `ubiquitous`. +The related value for the `bundle_method` parameter when using the [API](/api/resources/custom_certificates/methods/create/) is `ubiquitous`. ### Modern Modern consists of attempts to make the chain as efficient as possible, often by using **newer or fewer intermediate certificates**. -The related value for the `bundle_method` parameter when using the [API](/api/operations/custom-ssl-for-a-zone-create-ssl-configuration) is `optimal`. +The related value for the `bundle_method` parameter when using the [API](/api/resources/custom_certificates/methods/create/) is `optimal`. ### User-defined User-defined allows you to paste **your own certificate chain** and present that bundle to clients. You must specify any intermediates you wish to use, followed by the leaf. If you are using a self-signed certificate (not recommended), you must use this mode. -The related value for the `bundle_method` parameter when using the [API](/api/operations/custom-ssl-for-a-zone-create-ssl-configuration) is `force`. +The related value for the `bundle_method` parameter when using the [API](/api/resources/custom_certificates/methods/create/) is `force`. diff --git a/src/content/docs/ssl/edge-certificates/custom-certificates/uploading.mdx b/src/content/docs/ssl/edge-certificates/custom-certificates/uploading.mdx index 22017ed3ccd515a..b0126693b39e2d0 100644 --- a/src/content/docs/ssl/edge-certificates/custom-certificates/uploading.mdx +++ b/src/content/docs/ssl/edge-certificates/custom-certificates/uploading.mdx @@ -139,7 +139,7 @@ Custom certificates of the type `legacy_custom` are not compatible with [BYOIP]( 2. Upload your certificate and key -Use the [POST](/api/operations/custom-ssl-for-a-zone-create-ssl-configuration) endpoint to upload your certificate and key. +Use the [POST](/api/resources/custom_certificates/methods/create/) endpoint to upload your certificate and key. ```bash curl https://api.cloudflare.com/client/v4/zones/{zone_id}/custom_certificates \ @@ -180,7 +180,7 @@ To update a certificate in the dashboard: -To update a certificate using the API, send a [`PATCH`](/api/operations/custom-ssl-for-a-zone-edit-ssl-configuration) command. +To update a certificate using the API, send a [`PATCH`](/api/resources/custom_certificates/methods/edit/) command. diff --git a/src/content/docs/ssl/edge-certificates/geokey-manager/setup.mdx b/src/content/docs/ssl/edge-certificates/geokey-manager/setup.mdx index 70f68f4ad408d92..c42d22320b2b14c 100644 --- a/src/content/docs/ssl/edge-certificates/geokey-manager/setup.mdx +++ b/src/content/docs/ssl/edge-certificates/geokey-manager/setup.mdx @@ -26,7 +26,7 @@ Using the `policy` field, customers can define policies containing allow and blo To use Geo Key Manager v2 with the API, generally, follow the steps to [upload a custom certificate](/ssl/edge-certificates/custom-certificates/uploading/#upload-a-custom-certificate). -When sending the [`POST`](/api/operations/custom-ssl-for-a-zone-create-ssl-configuration) request, include the `policy` parameter to define policies containing allow and block lists of countries or regions where the private key should be stored. +When sending the [`POST`](/api/resources/custom_certificates/methods/create/) request, include the `policy` parameter to define policies containing allow and block lists of countries or regions where the private key should be stored. :::note @@ -90,7 +90,7 @@ To use Geo Key Manager in the dashboard: To use Geo Key Manager with the API, generally, follow the steps to [upload a custom certificate](/ssl/edge-certificates/custom-certificates/uploading/#upload-a-custom-certificate). -When sending the [`POST`](/api/operations/custom-ssl-for-a-zone-create-ssl-configuration) request, include the `geo_restrictions` parameter set to one of the following options: +When sending the [`POST`](/api/resources/custom_certificates/methods/create/) request, include the `geo_restrictions` parameter set to one of the following options: - `us` - `eu` diff --git a/src/content/docs/ssl/edge-certificates/universal-ssl/disable-universal-ssl.mdx b/src/content/docs/ssl/edge-certificates/universal-ssl/disable-universal-ssl.mdx index 5184683bd796019..ed52517a786a758 100644 --- a/src/content/docs/ssl/edge-certificates/universal-ssl/disable-universal-ssl.mdx +++ b/src/content/docs/ssl/edge-certificates/universal-ssl/disable-universal-ssl.mdx @@ -45,7 +45,7 @@ To disable Universal SSL in the dashboard: -To disable Universal SSL with the Cloudflare API, send a [`PATCH`](/api/operations/universal-ssl-settings-for-a-zone-edit-universal-ssl-settings) request and include the `"enabled": false` parameter. +To disable Universal SSL with the Cloudflare API, send a [`PATCH`](/api/resources/ssl/subresources/universal/subresources/settings/methods/edit/) request and include the `"enabled": false` parameter. @@ -66,6 +66,6 @@ To re-enable Universal SSL in the dashboard: -To re-enable Universal SSL with the Cloudflare API, send a [`PATCH`](/api/operations/universal-ssl-settings-for-a-zone-edit-universal-ssl-settings) request and include the `"enabled": true` parameter. +To re-enable Universal SSL with the Cloudflare API, send a [`PATCH`](/api/resources/ssl/subresources/universal/subresources/settings/methods/edit/) request and include the `"enabled": true` parameter. diff --git a/src/content/docs/ssl/edge-certificates/universal-ssl/enable-universal-ssl.mdx b/src/content/docs/ssl/edge-certificates/universal-ssl/enable-universal-ssl.mdx index 47cde9a73d8ef98..293117a6d4ec8ab 100644 --- a/src/content/docs/ssl/edge-certificates/universal-ssl/enable-universal-ssl.mdx +++ b/src/content/docs/ssl/edge-certificates/universal-ssl/enable-universal-ssl.mdx @@ -46,7 +46,7 @@ Unless you cover and validate multiple subdomains with an [advanced certificate] ## Verify your certificate is active -Once you enable Universal SSL, you can review the [activation status](/ssl/reference/certificate-statuses/) in the dashboard at **SSL/TLS** > **Edge Certificates** or via the API with a [GET request](/api/operations/certificate-packs-list-certificate-packs). +Once you enable Universal SSL, you can review the [activation status](/ssl/reference/certificate-statuses/) in the dashboard at **SSL/TLS** > **Edge Certificates** or via the API with a [GET request](/api/resources/ssl/subresources/certificate_packs/methods/list/). --- diff --git a/src/content/docs/ssl/edge-certificates/universal-ssl/troubleshooting.mdx b/src/content/docs/ssl/edge-certificates/universal-ssl/troubleshooting.mdx index 1ff6805a0adfdb9..ac4ab00a19f98a3 100644 --- a/src/content/docs/ssl/edge-certificates/universal-ssl/troubleshooting.mdx +++ b/src/content/docs/ssl/edge-certificates/universal-ssl/troubleshooting.mdx @@ -19,7 +19,7 @@ To resolve timeout issues, try one or more of the following options: * Change the **Proxy status** of related DNS records to **DNS only** (gray-clouded) and wait at least a minute. Then, change the **Proxy status** back to **Proxied** (orange-clouded). * [Disable Universal SSL](/ssl/edge-certificates/universal-ssl/disable-universal-ssl/) and wait at least a minute. Then, re-enable Universal SSL. -* Send a PATCH request to the [validation endpoint](/api/operations/ssl-verification-edit-ssl-certificate-pack-validation-method) using the same DCV method (API only). Please make sure that the `--data` field is not empty in your request. +* Send a PATCH request to the [validation endpoint](/api/resources/ssl/subresources/verification/methods/edit/) using the same DCV method (API only). Please make sure that the `--data` field is not empty in your request. * Follow the [APEX validation method](/ssl/edge-certificates/changing-dcv-method/methods/#perform-dcv). ## Other issues diff --git a/src/content/docs/ssl/keyless-ssl/configuration/cloudflare-tunnel.mdx b/src/content/docs/ssl/keyless-ssl/configuration/cloudflare-tunnel.mdx index 1e1551cd92a2f1e..6e8f318418ed8d0 100644 --- a/src/content/docs/ssl/keyless-ssl/configuration/cloudflare-tunnel.mdx +++ b/src/content/docs/ssl/keyless-ssl/configuration/cloudflare-tunnel.mdx @@ -33,7 +33,7 @@ Then, create a Cloudflare Tunnel. In these steps, you should choose the option to **Connect a network** and use the private IP address of your key server. -After you create the Tunnel, use the Cloudflare API to [List tunnel routes](/api/operations/tunnel-route-list-tunnel-routes), saving the following values for a future step: +After you create the Tunnel, use the Cloudflare API to [List tunnel routes](/api/resources/zero_trust/subresources/networks/subresources/routes/methods/list/), saving the following values for a future step: * `"virtual_network_id"` * `"network"` @@ -42,7 +42,7 @@ After you create the Tunnel, use the Cloudflare API to [List tunnel routes](/api -To upload a Keyless certificate with the API, send a [`POST`](/api/operations/keyless-ssl-for-a-zone-create-keyless-ssl-configuration) request that includes a `"tunnel"` object. +To upload a Keyless certificate with the API, send a [`POST`](/api/resources/keyless_certificates/methods/create/) request that includes a `"tunnel"` object. ```json "tunnel": { diff --git a/src/content/docs/ssl/keyless-ssl/configuration/public-dns.mdx b/src/content/docs/ssl/keyless-ssl/configuration/public-dns.mdx index 44caedc5c5a95eb..8237fd3f309451f 100644 --- a/src/content/docs/ssl/keyless-ssl/configuration/public-dns.mdx +++ b/src/content/docs/ssl/keyless-ssl/configuration/public-dns.mdx @@ -57,7 +57,7 @@ To create a Keyless certificate in the dashboard: -To create a Keyless certificate with the API, send a [`POST`](/api/operations/keyless-ssl-for-a-zone-create-keyless-ssl-configuration) request. +To create a Keyless certificate with the API, send a [`POST`](/api/resources/keyless_certificates/methods/create/) request. @@ -74,4 +74,4 @@ To create a Keyless certificate with the API, send a [`POST`](/api/operations/ke During TLS handshakes, Cloudflare's keyless client will initiate connections to the key server hostname or IP address you specify during certificate upload. By default, the keyless client will use a destination TCP port of 2407, but this can be changed during certificate upload or by editing the certificate details after upload. -Create WAF custom rules that allow your key server to accept connections from only Cloudflare. You can get Cloudflare's IPv4 and IPv6 addresses via the [IP details API endpoint](/api/operations/cloudflare-i-ps-cloudflare-ip-details). +Create WAF custom rules that allow your key server to accept connections from only Cloudflare. You can get Cloudflare's IPv4 and IPv6 addresses via the [IP details API endpoint](/api/resources/ips/methods/list/). diff --git a/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/aws-alb-integration.mdx b/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/aws-alb-integration.mdx index ff8c9ac14760bcf..0cc2b45139f59a4 100644 --- a/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/aws-alb-integration.mdx +++ b/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/aws-alb-integration.mdx @@ -69,7 +69,7 @@ curl --verbose https:// -2.[Associate the certificate with the hostname](/api/operations/per-hostname-authenticated-origin-pull-enable-or-disable-a-hostname-for-client-authentication) that should use it. +2.[Associate the certificate with the hostname](/api/resources/origin_tls_client_auth/subresources/hostnames/methods/update/) that should use it. ```bash curl --silent --request PUT \ @@ -110,7 +110,7 @@ Make sure your [encryption mode](/ssl/origin-configuration/ssl-modes/) is set to ## Rollback the Cloudflare configuration -1. Use a [`PUT` request](/api/operations/per-hostname-authenticated-origin-pull-enable-or-disable-a-hostname-for-client-authentication) to disable Authenticated Origin Pulls on the hostname. +1. Use a [`PUT` request](/api/resources/origin_tls_client_auth/subresources/hostnames/methods/update/) to disable Authenticated Origin Pulls on the hostname. ```bash curl -s --request PUT \ @@ -129,7 +129,7 @@ curl -s --request PUT \ }' ``` -2. (Optional) Use a [`GET` request](/api/operations/per-hostname-authenticated-origin-pull-list-certificates) to obtain a list of the client certificate IDs. You will need the ID of the certificate you want to remove for the following step. +2. (Optional) Use a [`GET` request](/api/resources/origin_tls_client_auth/subresources/hostnames/subresources/certificates/methods/list/) to obtain a list of the client certificate IDs. You will need the ID of the certificate you want to remove for the following step. ```bash curl "https://api.cloudflare.com/client/v4/zones/$ZONEID/origin_tls_client_auth/hostnames/certificates" \ @@ -137,7 +137,7 @@ curl "https://api.cloudflare.com/client/v4/zones/$ZONEID/origin_tls_client_auth/ --header "X-Auth-Key: $MYAUTHKEY" ``` -3. Use the [Delete hostname client certificate](/api/operations/per-hostname-authenticated-origin-pull-delete-hostname-client-certificate) endpoint to remove the certificate you had uploaded. +3. Use the [Delete hostname client certificate](/api/resources/origin_tls_client_auth/subresources/hostnames/subresources/certificates/methods/delete/) endpoint to remove the certificate you had uploaded. ```bash curl --request DELETE \ diff --git a/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/set-up/manage-certificates.mdx b/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/set-up/manage-certificates.mdx index 70e38af7d7d461f..912ea3fb653cbea 100644 --- a/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/set-up/manage-certificates.mdx +++ b/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/set-up/manage-certificates.mdx @@ -27,7 +27,7 @@ Since per-hostname certificates are more specific, they take precedence over zon ## Delete a certificate -Client certificates are not deleted from Cloudflare upon expiration unless a [delete](/api/operations/zone-level-authenticated-origin-pulls-delete-certificate) or [replace](/api/operations/zone-level-authenticated-origin-pulls-upload-certificate) request is sent to the Cloudflare API. +Client certificates are not deleted from Cloudflare upon expiration unless a [delete](/api/resources/origin_tls_client_auth/methods/delete/) or [replace](/api/resources/origin_tls_client_auth/methods/create/) request is sent to the Cloudflare API. However, requests are dropped at your origin if your origin only accepts a valid client certificate. @@ -35,14 +35,14 @@ However, requests are dropped at your origin if your origin only accepts a valid For hostname: -1. [Upload the new certificate](/api/operations/per-hostname-authenticated-origin-pull-upload-a-hostname-client-certificate). +1. [Upload the new certificate](/api/resources/origin_tls_client_auth/subresources/hostnames/subresources/certificates/methods/create/). -2. [Enable Authenticated Origin Pulls for that specific hostname](/api/operations/per-hostname-authenticated-origin-pull-enable-or-disable-a-hostname-for-client-authentication). +2. [Enable Authenticated Origin Pulls for that specific hostname](/api/resources/origin_tls_client_auth/subresources/hostnames/methods/update/). For global: -1. [Upload the new certificate](/api/operations/zone-level-authenticated-origin-pulls-upload-certificate). +1. [Upload the new certificate](/api/resources/origin_tls_client_auth/methods/create/). -2. [Check whether new certificate is Active](/api/operations/zone-level-authenticated-origin-pulls-get-certificate-details). +2. [Check whether new certificate is Active](/api/resources/origin_tls_client_auth/methods/get/). -3. Once certificate is active, [delete the previous certificate](/api/operations/zone-level-authenticated-origin-pulls-delete-certificate). +3. Once certificate is active, [delete the previous certificate](/api/resources/origin_tls_client_auth/methods/delete/). diff --git a/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/set-up/per-hostname.mdx b/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/set-up/per-hostname.mdx index 67ed6397927bf4c..215cfbe884bbcbf 100644 --- a/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/set-up/per-hostname.mdx +++ b/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/set-up/per-hostname.mdx @@ -27,7 +27,7 @@ Refer to the steps below for an example of how to generate a custom certificate ## 1. Upload custom certificate -Use the [`/origin_tls_client_auth/hostnames/certificates`](/api/operations/per-hostname-authenticated-origin-pull-upload-a-hostname-client-certificate) endpoint to upload your custom certificate. +Use the [`/origin_tls_client_auth/hostnames/certificates`](/api/resources/origin_tls_client_auth/subresources/hostnames/subresources/certificates/methods/create/) endpoint to upload your custom certificate. :::note @@ -48,7 +48,7 @@ In the API response, save the certificate `id` since it will be required in step ## 4. Enable Authenticated Origin Pulls for the hostname -Use the Cloudflare API to send a [`PUT`](/api/operations/per-hostname-authenticated-origin-pull-enable-or-disable-a-hostname-for-client-authentication) request to enable Authenticated Origin Pulls for specific hostnames. +Use the Cloudflare API to send a [`PUT`](/api/resources/origin_tls_client_auth/subresources/hostnames/methods/update/) request to enable Authenticated Origin Pulls for specific hostnames. If you had set up logging on your origin during step 2, test and confirm that Authenticated Origin Pulls is working. diff --git a/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/set-up/zone-level.mdx b/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/set-up/zone-level.mdx index b6f293472638d1e..e5ca768855d785f 100644 --- a/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/set-up/zone-level.mdx +++ b/src/content/docs/ssl/origin-configuration/authenticated-origin-pull/set-up/zone-level.mdx @@ -30,7 +30,7 @@ First, upload a certificate to your origin. To use a Cloudflare certificate (which uses a specific CA), [download the .PEM file](/ssl/static/authenticated_origin_pull_ca.pem) and upload it to your origin. This certificate is **not** the same as the Cloudflare Origin CA certificate and will not appear on your Dashboard. -To use a custom certificate, follow the API instructions to [upload a custom certificate to Cloudflare](/ssl/edge-certificates/custom-certificates/uploading/#upload-a-custom-certificate), but use the [`origin_tls_client_auth` endpoint](/api/operations/zone-level-authenticated-origin-pulls-upload-certificate). Then, upload the certificate to your origin. +To use a custom certificate, follow the API instructions to [upload a custom certificate to Cloudflare](/ssl/edge-certificates/custom-certificates/uploading/#upload-a-custom-certificate), but use the [`origin_tls_client_auth` endpoint](/api/resources/origin_tls_client_auth/methods/create/). Then, upload the certificate to your origin. :::caution @@ -52,7 +52,7 @@ Using a custom certificate is required if you need your domain to be [FIPS](http ## 4. Enable Authenticated Origin Pulls for all hostnames in a zone -Use the Cloudflare API to send a [`PUT`](/api/operations/zone-level-authenticated-origin-pulls-set-enablement-for-zone) request to enable zone-level authenticated origin pulls. +Use the Cloudflare API to send a [`PUT`](/api/resources/origin_tls_client_auth/subresources/settings/methods/update/) request to enable zone-level authenticated origin pulls. If you had set up logging on your origin during [step 2](#2-configure-origin-to-accept-client-certificates), test and confirm that Authenticated Origin Pulls is working. diff --git a/src/content/docs/ssl/origin-configuration/origin-ca.mdx b/src/content/docs/ssl/origin-configuration/origin-ca.mdx index 426060be46ed8cb..d64ce987c620d2f 100644 --- a/src/content/docs/ssl/origin-configuration/origin-ca.mdx +++ b/src/content/docs/ssl/origin-configuration/origin-ca.mdx @@ -124,10 +124,10 @@ To automate processes involving Origin CA certificates, use the following API ca | Operation | Method | Endpoint | | ------------------------------------------------------------------ | -------- | ---------------------------------- | -| [List certificates](/api/operations/origin-ca-list-certificates) | `GET` | `certificates?zone_id=<>` | -| [Create certificate](/api/operations/origin-ca-create-certificate) | `POST` | `certificates` | -| [Get certificate](/api/operations/origin-ca-get-certificate) | `GET` | `certificates/<>` | -| [Revoke certificate](/api/operations/origin-ca-revoke-certificate) | `DELETE` | `certificates/<>` | +| [List certificates](/api/resources/origin_ca_certificates/methods/list/) | `GET` | `certificates?zone_id=<>` | +| [Create certificate](/api/resources/origin_ca_certificates/methods/create/) | `POST` | `certificates` | +| [Get certificate](/api/resources/origin_ca_certificates/methods/get/) | `GET` | `certificates/<>` | +| [Revoke certificate](/api/resources/origin_ca_certificates/methods/delete/) | `DELETE` | `certificates/<>` | ## Troubleshooting diff --git a/src/content/docs/ssl/origin-configuration/ssl-modes/index.mdx b/src/content/docs/ssl/origin-configuration/ssl-modes/index.mdx index 42f61e98d0b5d5c..857f215fdd9eab2 100644 --- a/src/content/docs/ssl/origin-configuration/ssl-modes/index.mdx +++ b/src/content/docs/ssl/origin-configuration/ssl-modes/index.mdx @@ -65,7 +65,7 @@ If you wanted to opt out multiple zones: - `Zone - Zone - Read` - `Zone - Zone Settings - Read` - `Zone - Zone Settings - Edit` -2. Make a [`GET` request](/api/operations/zones-get) to get a list of zones (you can filter this list by `account.id`). +2. Make a [`GET` request](/api/resources/zones/methods/list/) to get a list of zones (you can filter this list by `account.id`). ```bash "account.id=" curl 'https://api.cloudflare.com/client/v4/zones?account.id=' \ diff --git a/src/content/docs/ssl/origin-configuration/ssl-tls-recommender.mdx b/src/content/docs/ssl/origin-configuration/ssl-tls-recommender.mdx index dd0af54af2968ee..a038360f2c67de4 100644 --- a/src/content/docs/ssl/origin-configuration/ssl-tls-recommender.mdx +++ b/src/content/docs/ssl/origin-configuration/ssl-tls-recommender.mdx @@ -39,7 +39,7 @@ To enable SSL/TLS recommendations in the dashboard: -To adjust your SSL/TLS Recommender enrollment with the API, send a [`PATCH`](/api/operations/ssl/-tls-mode-recommendation-ssl/-tls-recommendation) request with the `enabled` parameter set to your desired setting (`true` or `false`). +To adjust your SSL/TLS Recommender enrollment with the API, send a [`PATCH`](/api/resources/ssl/subresources/recommendations/methods/get/) request with the `enabled` parameter set to your desired setting (`true` or `false`). diff --git a/src/content/docs/ssl/post-quantum-cryptography/pqc-to-origin.mdx b/src/content/docs/ssl/post-quantum-cryptography/pqc-to-origin.mdx index 9898736e3e1ccae..96d8e788dce855b 100644 --- a/src/content/docs/ssl/post-quantum-cryptography/pqc-to-origin.mdx +++ b/src/content/docs/ssl/post-quantum-cryptography/pqc-to-origin.mdx @@ -26,7 +26,7 @@ If the origin supports post-quantum hybrid key agreement, it can use HelloRetryR ### Cloudflare zone settings -The method described above is the one Cloudflare uses to support post-quantum to all outbound connections. However, if your origin server supports PQC and prefers it, you can use the [API](/api/operations/zone-cache-settings-change-origin-post-quantum-encryption-setting) to adjust your Cloudflare zone settings and avoid the extra round trip. +The method described above is the one Cloudflare uses to support post-quantum to all outbound connections. However, if your origin server supports PQC and prefers it, you can use the [API](/api/resources/origin_post_quantum_encryption/methods/update/) to adjust your Cloudflare zone settings and avoid the extra round trip. It is also possible to opt out of PQC using the same API endpoint. diff --git a/src/content/docs/ssl/reference/certificate-statuses.mdx b/src/content/docs/ssl/reference/certificate-statuses.mdx index ffd5d76908bfc36..26ef93574333685 100644 --- a/src/content/docs/ssl/reference/certificate-statuses.mdx +++ b/src/content/docs/ssl/reference/certificate-statuses.mdx @@ -53,13 +53,13 @@ When you use [client certificates](/ssl/client-certificates/), those client cert ### SSL/TLS -Monitor a certificate's status in the dashboard at **SSL/TLS** > **Edge Certificates** or by using the [Get Certificate Pack endpoint](/api/operations/certificate-packs-get-certificate-pack). +Monitor a certificate's status in the dashboard at **SSL/TLS** > **Edge Certificates** or by using the [Get Certificate Pack endpoint](/api/resources/ssl/subresources/certificate_packs/methods/get/). For more details on certificate validation, refer to [Domain Control Validation](/ssl/edge-certificates/changing-dcv-method/). ### SSL for SaaS -Monitor a certificate's status in the dashboard at **SSL/TLS** > **Custom Hostnames** or by using the [Custom Hostname Details endpoint](/api/operations/custom-hostname-for-a-zone-custom-hostname-details). +Monitor a certificate's status in the dashboard at **SSL/TLS** > **Custom Hostnames** or by using the [Custom Hostname Details endpoint](/api/resources/custom_hostnames/methods/get/). For more details on certificate validation, refer to [Issue and validate certificates](/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/). diff --git a/src/content/docs/ssl/reference/certificate-validity-periods.mdx b/src/content/docs/ssl/reference/certificate-validity-periods.mdx index 3068ab271e2995d..411922315ce5c2d 100644 --- a/src/content/docs/ssl/reference/certificate-validity-periods.mdx +++ b/src/content/docs/ssl/reference/certificate-validity-periods.mdx @@ -31,7 +31,7 @@ When you order an [advanced certificate](/ssl/edge-certificates/advanced-certifi :::note -For more details on the `validity_days` parameter used in API calls, refer to [Order Advanced Certificate Pack](/api/operations/certificate-packs-order-advanced-certificate-manager-certificate-pack). +For more details on the `validity_days` parameter used in API calls, refer to [Order Advanced Certificate Pack](/api/resources/ssl/subresources/certificate_packs/methods/create/). ::: diff --git a/src/content/docs/ssl/reference/migration-guides/digicert-update/advanced-certificates.mdx b/src/content/docs/ssl/reference/migration-guides/digicert-update/advanced-certificates.mdx index 351e414b0f5d0f3..9fa7ab8d175dce8 100644 --- a/src/content/docs/ssl/reference/migration-guides/digicert-update/advanced-certificates.mdx +++ b/src/content/docs/ssl/reference/migration-guides/digicert-update/advanced-certificates.mdx @@ -32,7 +32,7 @@ This table provides a summary of the differences between DigiCert and Cloudflare | Area | DigiCert | Other CAs | Actions required | | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Domain Control
Validation (DCV) | If a certificate has multiple hostnames in the Subject Alternative Name (SAN), one DCV record is required to complete validation. | If a certificate has multiple hostnames in the SAN, one DCV token is required for every hostname on the certificate (five hostnames in the SAN would require five DCV tokens).

This will also require two DCV tokens to validate a certificate that covers an apex and wildcard (`example.com`, `*.example.com`). | **Full zones**: As long as Cloudflare remains the Authoritative DNS provider, no action is required since Cloudflare can complete [TXT based DCV](/ssl/edge-certificates/changing-dcv-method/methods/txt/) for certificate issuances and renewals.

**Partial zones**: Cloudflare will complete [HTTP DCV](/ssl/edge-certificates/changing-dcv-method/methods/http/) for non-wildcard hostnames, as long as they are proxying traffic through Cloudflare.

For advanced certificates with wildcard hostnames, you should consider [Delegated DCV](/ssl/edge-certificates/changing-dcv-method/methods/delegated-dcv/). If that does not work, you will be required to complete [TXT DCV](/ssl/edge-certificates/changing-dcv-method/methods/txt/) for Advanced certificates with wildcard hostnames by placing the TXT DCV token at your Authoritative DNS provider. | -| API | Customers can choose `"digicert"` as the issuing CA when using the [API](/api/operations/certificate-packs-order-advanced-certificate-manager-certificate-pack). | Customers can only choose `"lets_encrypt"` or `"google"` when using the [API](/api/operations/certificate-packs-order-advanced-certificate-manager-certificate-pack). | If you are currently using DigiCert as the issuing CA when creating advanced certificates, switch your integration to use Let's Encrypt or Google. | +| API | Customers can choose `"digicert"` as the issuing CA when using the [API](/api/resources/ssl/subresources/certificate_packs/methods/create/). | Customers can only choose `"lets_encrypt"` or `"google"` when using the [API](/api/resources/ssl/subresources/certificate_packs/methods/create/). | If you are currently using DigiCert as the issuing CA when creating advanced certificates, switch your integration to use Let's Encrypt or Google. | | DCV Methods | Email DCV is available. | Email DCV will be deprecated. Customers will be required to use [HTTP](/ssl/edge-certificates/changing-dcv-method/methods/http/) or [DNS](/ssl/edge-certificates/changing-dcv-method/methods/txt/) DCV. | If an existing certificate is relying on Email DCV then when the certificate comes up for renewal, Cloudflare will attempt to complete [HTTP validation](/ssl/edge-certificates/changing-dcv-method/methods/txt/). If HTTP validation is not possible, then Cloudflare will use [TXT DCV](/ssl/edge-certificates/changing-dcv-method/methods/txt/) and return the associated tokens. | | Validity period | Advanced certificates can be valid for 14, 30, 90, or 365 days. | Advanced certificates can be valid for 14, 30, or 90 days. | No action required. Certificates will be renewed more frequently. Certificates using 14 or 30 day validity periods will be required to use Google Trust Services on renewal. Let's Encrypt only supports certificates with 90 day validity periods. | | | | | | @@ -41,7 +41,7 @@ This table provides a summary of the differences between DigiCert and Cloudflare ### Before October 5, 2023 -If your system integrates with the Cloudflare API to [order advanced certificates](/api/operations/certificate-packs-order-advanced-certificate-manager-certificate-pack), you will need to update the following fields: +If your system integrates with the Cloudflare API to [order advanced certificates](/api/resources/ssl/subresources/certificate_packs/methods/create/), you will need to update the following fields: - The `"certificate_authority"` field should either use Google Trust Services (`"google"`) or Let's Encrypt (`"lets_encrypt"`). - The `"validation_method"` field should either use [`"http"`](/ssl/edge-certificates/changing-dcv-method/methods/http/) (only available for [non-wildcard hostnames](/ssl/reference/migration-guides/dcv-update/)) or [`"txt"`](/ssl/edge-certificates/changing-dcv-method/methods/txt/). diff --git a/src/content/docs/ssl/reference/migration-guides/digicert-update/custom-hostname-certificates.mdx b/src/content/docs/ssl/reference/migration-guides/digicert-update/custom-hostname-certificates.mdx index eb0817119258ff0..1cb5b7a2fbabfab 100644 --- a/src/content/docs/ssl/reference/migration-guides/digicert-update/custom-hostname-certificates.mdx +++ b/src/content/docs/ssl/reference/migration-guides/digicert-update/custom-hostname-certificates.mdx @@ -37,7 +37,7 @@ This table provides a summary of the differences between DigiCert and our other | Area | DigiCert | Other CAs | Actions required | | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Domain Control
Validation (DCV) | To get a certificate issued for a wildcard custom hostname, one TXT DCV record is required to complete Domain Control Validation. | To get a certificate issued for a wildcard custom hostname, two TXT DCV records will be required to complete validation. | [Wildcard custom hostnames](#wildcard-custom-hostnames) will require additional DCV tokens. [Non-wildcard custom hostnames](#non-wildcard-custom-hostnames) will automatically renew as long as the hostname is proxying through Cloudflare. | -| API | Customers can choose `"digicert"` as the issuing CA when using the [custom hostnames API](/api/operations/custom-hostname-for-a-zone-create-custom-hostname). | Customers can only choose `"lets_encrypt"` or `"google"` when using the [custom hostnames API](/api/operations/custom-hostname-for-a-zone-create-custom-hostname). | If you are currently using DigiCert as the issuing CA when creating custom hostnames, [switch your integration](#update-values) to use Let's Encrypt or Google. | +| API | Customers can choose `"digicert"` as the issuing CA when using the [custom hostnames API](/api/resources/custom_hostnames/methods/create/). | Customers can only choose `"lets_encrypt"` or `"google"` when using the [custom hostnames API](/api/resources/custom_hostnames/methods/create/). | If you are currently using DigiCert as the issuing CA when creating custom hostnames, [switch your integration](#update-values) to use Let's Encrypt or Google. | | DCV Methods | CNAME and Email DCV are available. | CNAME and Email DCV will be deprecated. Customers will be required to use [HTTP](/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/http/) or [TXT](/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/txt/) DCV. | When certificates come up for renewal that are using CNAME or Email DCV, Cloudflare will automatically choose HTTP DCV as the default method for non-wildcard custom hostnames and TXT DCV for wildcard custom hostnames. | | Validity period | Custom hostname certificates have a 1 year validity period. | Custom hostnames certificates will have a 90 day validity period. | If you are using [wildcard custom hostnames](#wildcard-custom-hostnames), your customers will need to place DCV tokens at their DNS provider more frequently. [Non-wildcard custom hostname certificates](#non-wildcard-custom-hostnames) will automatically renew, as long as the hostname is actively proxying through Cloudflare. Cloudflare will handle the renewals at a more frequent rate. | | | | | | @@ -52,7 +52,7 @@ Also, the maximum validity period for certificates will be decreased from 1 year ### Before October 18, 2023 -If your system integrates with the Cloudflare for SaaS API to [create custom hostnames](/api/operations/custom-hostname-for-a-zone-create-custom-hostname), you will need to update: +If your system integrates with the Cloudflare for SaaS API to [create custom hostnames](/api/resources/custom_hostnames/methods/create/), you will need to update: - The value sent in the `"certificate_authority"` field under the SSL object. Your integration should either use Google Trust Services (`"google"`) or Let's Encrypt (`"lets_encrypt"`). - The value sent in the `"method"` field under the SSL object. Your integration should either use [`"http"`](/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/http/) (only available for [non-wildcard hostnames](#non-wildcard-custom-hostnames)) or [`"txt"`](/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/txt/). @@ -65,9 +65,9 @@ We recommend that you migrate all your current custom hostnames away from DigiCe To identify certificates that are coming up for renewal, set up [notifications](/notifications/notification-available/#ssltls) for **SSL for SaaS Custom Hostnames Alert** events. -You can also send a [GET](/api/operations/custom-hostname-for-a-zone-list-custom-hostnames) request to the API and look for certificates with a `ssl_status` of `pending_validation` and a `certificate_authority` of `digicert` within the SSL object. +You can also send a [GET](/api/resources/custom_hostnames/methods/list/) request to the API and look for certificates with a `ssl_status` of `pending_validation` and a `certificate_authority` of `digicert` within the SSL object. -To find wildcard custom hostnames specifically that are using DigiCert certificates, send a [GET](/api/operations/custom-hostname-for-a-zone-list-custom-hostnames) request and include `?certificate_authority=digicert&wildcard=true` in the request parameter. +To find wildcard custom hostnames specifically that are using DigiCert certificates, send a [GET](/api/resources/custom_hostnames/methods/list/) request and include `?certificate_authority=digicert&wildcard=true` in the request parameter. #### Update values @@ -99,7 +99,7 @@ After your DigiCert certificate is renewed, the API will return a new certificat For non-wildcard hostnames, you can use HTTP DCV to automatically perform DCV as long as the custom hostname is proxying traffic through Cloudflare. Cloudflare will complete DCV on the hostname's behalf by serving the [HTTP token](/cloudflare-for-platforms/cloudflare-for-saas/security/certificate-management/issue-and-validate/validate-certificates/http/). -If your hostname is using another validation method, you will need to [update](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname) the `"method"` field in the SSL object to be `"http"`. +If your hostname is using another validation method, you will need to [update](/api/resources/custom_hostnames/methods/edit/) the `"method"` field in the SSL object to be `"http"`. If the custom hostname is not proxying traffic through Cloudflare, then the custom hostname domain owner will need to add the TXT or HTTP DCV token for the new certificate to validate and issue. As the SaaS provider, you will be responsible for sharing this token with the custom hostname domain owner. diff --git a/src/content/docs/ssl/reference/migration-guides/entrust-distrust.mdx b/src/content/docs/ssl/reference/migration-guides/entrust-distrust.mdx index 84160f659fd43a1..365ec5b3cf193e7 100644 --- a/src/content/docs/ssl/reference/migration-guides/entrust-distrust.mdx +++ b/src/content/docs/ssl/reference/migration-guides/entrust-distrust.mdx @@ -33,7 +33,7 @@ Since Cloudflare also [partners with SSL.com](/ssl/reference/certificate-authori * Use [Advanced certificates](/ssl/edge-certificates/advanced-certificate-manager/) to have more control and flexibility while also benefitting from automatic renewals. * Enable [Total TLS](/ssl/edge-certificates/additional-options/total-tls/) to automatically issue certificates for your [proxied hostnames](/dns/manage-dns-records/reference/proxied-dns-records/). * Use [Delegated DCV](/ssl/edge-certificates/changing-dcv-method/methods/delegated-dcv/) to reduce manual intervention when renewing certificates for [partial (CNAME) setup](/dns/zone-setups/partial-setup/) zones. -* If you are a SaaS provider, extend the benefits of automatic renewals to your customers by specifying SSL.com as the certificate authority when [creating](/api/operations/custom-hostname-for-a-zone-create-custom-hostname) or [editing](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname) your custom hostnames (API only). +* If you are a SaaS provider, extend the benefits of automatic renewals to your customers by specifying SSL.com as the certificate authority when [creating](/api/resources/custom_hostnames/methods/create/) or [editing](/api/resources/custom_hostnames/methods/edit/) your custom hostnames (API only). ## More resources diff --git a/src/content/docs/stream/edit-videos/video-clipping.mdx b/src/content/docs/stream/edit-videos/video-clipping.mdx index 8513f4698a9b8d9..cf10c37f4e7cd24 100644 --- a/src/content/docs/stream/edit-videos/video-clipping.mdx +++ b/src/content/docs/stream/edit-videos/video-clipping.mdx @@ -6,7 +6,7 @@ title: Clip videos With video clipping, also referred to as "trimming" or changing the length of the video, you can change the start and end points of a video so viewers only see a specific "clip" of the video. For example, if you have a 20 minute video but only want to share a five minute clip from the middle of the video, you can clip the video to remove the content before and after the five minute clip. -Refer to the [Video clipping API documentation](/api/operations/stream-video-clipping-clip-videos-given-a-start-and-end-time) for more information. +Refer to the [Video clipping API documentation](/api/resources/stream/subresources/clip/methods/create/) for more information. :::note[Note:] diff --git a/src/content/docs/stream/manage-video-library/searching.mdx b/src/content/docs/stream/manage-video-library/searching.mdx index c216b2687c747f7..1105cb3e5aafaa3 100644 --- a/src/content/docs/stream/manage-video-library/searching.mdx +++ b/src/content/docs/stream/manage-video-library/searching.mdx @@ -4,7 +4,7 @@ title: Search for videos --- -You can search for videos by name through the Stream API by adding a `search` query parameter to the [list media files](/api/operations/stream-videos-list-videos) endpoint. +You can search for videos by name through the Stream API by adding a `search` query parameter to the [list media files](/api/resources/stream/methods/list/) endpoint. ## What you will need diff --git a/src/content/docs/stream/stream-api.mdx b/src/content/docs/stream/stream-api.mdx index b44df0d52ad415c..af869cbe56153ff 100644 --- a/src/content/docs/stream/stream-api.mdx +++ b/src/content/docs/stream/stream-api.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: Stream API Reference -external_link: /api/operations/stream-videos-list-videos +external_link: /api/resources/stream/methods/list/ sidebar: order: 11 diff --git a/src/content/docs/stream/stream-live/replay-recordings.mdx b/src/content/docs/stream/stream-live/replay-recordings.mdx index 379b09c2987d9a7..2a2c335d5dd02cc 100644 --- a/src/content/docs/stream/stream-live/replay-recordings.mdx +++ b/src/content/docs/stream/stream-live/replay-recordings.mdx @@ -9,7 +9,7 @@ sidebar: --- -Live streams are automatically recorded, and available instantly once a live stream ends. To get a list of recordings for a given input ID, make a [`GET` request to `/live_inputs//videos`](/api/operations/stream-live-inputs-retrieve-a-live-input) and filter for videos where `state` is set to `ready`: +Live streams are automatically recorded, and available instantly once a live stream ends. To get a list of recordings for a given input ID, make a [`GET` request to `/live_inputs//videos`](/api/resources/stream/subresources/live_inputs/methods/get/) and filter for videos where `state` is set to `ready`: ```bash title="Request" curl -X GET \ diff --git a/src/content/docs/stream/stream-live/simulcasting.mdx b/src/content/docs/stream/stream-live/simulcasting.mdx index 7c96fc4994bd0f6..66b2ac28cc88f29 100644 --- a/src/content/docs/stream/stream-live/simulcasting.mdx +++ b/src/content/docs/stream/stream-live/simulcasting.mdx @@ -41,7 +41,7 @@ https://api.cloudflare.com/client/v4/accounts//stream/live_inputs/ diff --git a/src/content/docs/stream/stream-live/stream-live-api.mdx b/src/content/docs/stream/stream-live/stream-live-api.mdx index 94e54a0f12012a4..c36d56c53ed179e 100644 --- a/src/content/docs/stream/stream-live/stream-live-api.mdx +++ b/src/content/docs/stream/stream-live/stream-live-api.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: Stream Live API docs -external_link: /api/operations/stream-live-inputs-list-live-inputs +external_link: /api/resources/stream/subresources/live_inputs/methods/list/ sidebar: order: 7 diff --git a/src/content/docs/stream/uploading-videos/direct-creator-uploads.mdx b/src/content/docs/stream/uploading-videos/direct-creator-uploads.mdx index 6488392ed500843..3bb11434322a3af 100644 --- a/src/content/docs/stream/uploading-videos/direct-creator-uploads.mdx +++ b/src/content/docs/stream/uploading-videos/direct-creator-uploads.mdx @@ -17,7 +17,7 @@ In either case, you must specify a maximum duration to reserve for the user's up Use this option if your users upload videos under 200 MB, and you do not need to allow resumable uploads. -1. Generate a unique, one-time upload URL using the [Direct upload API](/api/operations/stream-videos-upload-videos-via-direct-upload-ur-ls). +1. Generate a unique, one-time upload URL using the [Direct upload API](/api/resources/stream/subresources/direct_upload/methods/create/). ```sh title="Generate upload" curl https://api.cloudflare.com/client/v4/accounts/{account_id}/stream/direct_upload \ @@ -152,7 +152,7 @@ For more details on using tus and example client code, refer to [Resumable and l ## Upload-Metadata header syntax -You can apply the [same constraints](/api/operations/stream-videos-upload-videos-via-direct-upload-ur-ls) as Direct Creator Upload via basic upload when using tus. To do so, you must pass the `expiry` and `maxDurationSeconds` as part of the `Upload-Metadata` request header as part of the first request (made by the Worker in the example above.) The `Upload-Metadata` values are ignored from subsequent requests that do the actual file upload. +You can apply the [same constraints](/api/resources/stream/subresources/direct_upload/methods/create/) as Direct Creator Upload via basic upload when using tus. To do so, you must pass the `expiry` and `maxDurationSeconds` as part of the `Upload-Metadata` request header as part of the first request (made by the Worker in the example above.) The `Upload-Metadata` values are ignored from subsequent requests that do the actual file upload. The `Upload-Metadata` header should contain key-value pairs. The keys are text and the values should be encoded in base64. Separate the key and values by a space, _not_ an equal sign. To join multiple key-value pairs, include a comma with no additional spaces. diff --git a/src/content/docs/stream/uploading-videos/resumable-uploads.mdx b/src/content/docs/stream/uploading-videos/resumable-uploads.mdx index 0ac10300ed7a6a8..f5551c3f7efc4e9 100644 --- a/src/content/docs/stream/uploading-videos/resumable-uploads.mdx +++ b/src/content/docs/stream/uploading-videos/resumable-uploads.mdx @@ -167,7 +167,7 @@ The tus protocol allows you to add optional parameters in the [`Upload-Metadata` ### Supported options in `Upload-Metadata` -Setting arbitrary metadata values in the `Upload-Metadata` header sets values in the [meta key in Stream API](/api/operations/stream-videos-list-videos). +Setting arbitrary metadata values in the `Upload-Metadata` header sets values in the [meta key in Stream API](/api/resources/stream/methods/list/). - `name` diff --git a/src/content/docs/stream/viewing-videos/using-own-player/index.mdx b/src/content/docs/stream/viewing-videos/using-own-player/index.mdx index e29ec389469f5b4..7f190fb0dc016b4 100644 --- a/src/content/docs/stream/viewing-videos/using-own-player/index.mdx +++ b/src/content/docs/stream/viewing-videos/using-own-player/index.mdx @@ -47,7 +47,7 @@ https://customer-.cloudflarestream.com//manifest/video.m3u8?protocol= ### API -Refer to the [Stream video details API documentation](/api/operations/stream-videos-retrieve-video-details) to learn how to fetch the manifest URLs using the Cloudflare API. +Refer to the [Stream video details API documentation](/api/resources/stream/methods/get/) to learn how to fetch the manifest URLs using the Cloudflare API. ## Customize manifests by specifying available client bandwidth diff --git a/src/content/docs/stream/webrtc-beta.mdx b/src/content/docs/stream/webrtc-beta.mdx index e8b52b69024688e..cb49d3e8bfbf24b 100644 --- a/src/content/docs/stream/webrtc-beta.mdx +++ b/src/content/docs/stream/webrtc-beta.mdx @@ -25,7 +25,7 @@ WebRTC streaming is currently in beta, and we'd love to hear what you think. Joi ## Step 1: Create a live input -[Use the Stream Dashboard](https://dash.cloudflare.com/?to=/:account/stream/inputs/create), or make a POST request to the [`/live_inputs` API endpoint](/api/operations/stream-live-inputs-create-a-live-input) +[Use the Stream Dashboard](https://dash.cloudflare.com/?to=/:account/stream/inputs/create), or make a POST request to the [`/live_inputs` API endpoint](/api/resources/stream/subresources/live_inputs/methods/create/) ```json title="API response from a POST request to /live_inputs" {5} { diff --git a/src/content/docs/support/troubleshooting/cloudflare-errors/troubleshooting-cloudflare-5xx-errors.mdx b/src/content/docs/support/troubleshooting/cloudflare-errors/troubleshooting-cloudflare-5xx-errors.mdx index 925a052a6f5a95d..5c325f2253bb9a5 100644 --- a/src/content/docs/support/troubleshooting/cloudflare-errors/troubleshooting-cloudflare-5xx-errors.mdx +++ b/src/content/docs/support/troubleshooting/cloudflare-errors/troubleshooting-cloudflare-5xx-errors.mdx @@ -274,7 +274,7 @@ or [Nginx](http://nginx.org/en/docs/http/ngx_http_log_module.html#log_format). ::: -- Enterprise customers can increase the 524 timeout up to 6,000 seconds using the [Edit zone setting](/api/operations/zone-settings-edit-single-setting) endpoint (`proxy_read_timeout` setting). If your content can be cached, you may also choose to use a [Cache Rule](/cache/how-to/cache-rules/settings/#proxy-read-timeout-enterprise-only) with the `Proxy Read Timeout` setting selected instead in the Cloudflare Dashboard. +- Enterprise customers can increase the 524 timeout up to 6,000 seconds using the [Edit zone setting](/api/resources/zones/subresources/settings/methods/edit/) endpoint (`proxy_read_timeout` setting). If your content can be cached, you may also choose to use a [Cache Rule](/cache/how-to/cache-rules/settings/#proxy-read-timeout-enterprise-only) with the `Proxy Read Timeout` setting selected instead in the Cloudflare Dashboard. :::note diff --git a/src/content/docs/tenant/get-started.mdx b/src/content/docs/tenant/get-started.mdx index abc4ab86bb90952..e710cd880293ff9 100644 --- a/src/content/docs/tenant/get-started.mdx +++ b/src/content/docs/tenant/get-started.mdx @@ -68,7 +68,7 @@ curl 'https://api.cloudflare.com/client/v4/accounts//member In most cases, you will want to create new users with a role of `Administrator` which always has the ID `05784afa30c1afe1440e79d9351c7430`. -If your customer is on an Enterprise plan, they have access to a broader set of user roles. To get a full list of available roles, send a [`GET`](/api/operations/account-roles-list-roles) request to the API. +If your customer is on an Enterprise plan, they have access to a broader set of user roles. To get a full list of available roles, send a [`GET`](/api/resources/accounts/subresources/roles/methods/list/) request to the API. ### Option 2 - Access via an interface @@ -122,7 +122,7 @@ curl "https://api.cloudflare.com/client/v4/users" \ Now that you have a customer account and customer users (or service users), you need to create a zone. -To do this, send a [`POST`](/api/operations/zones-post) request to the `/zones` endpoint (including the customer account ID you received in [Step 1](#step-1---create-an-account)). +To do this, send a [`POST`](/api/resources/zones/methods/create/) request to the `/zones` endpoint (including the customer account ID you received in [Step 1](#step-1---create-an-account)). ```bash title="Request" curl "https://api.cloudflare.com/client/v4/zones" \ diff --git a/src/content/docs/tenant/how-to/manage-accounts.mdx b/src/content/docs/tenant/how-to/manage-accounts.mdx index 020b58e589556fd..9f560c9678730da 100644 --- a/src/content/docs/tenant/how-to/manage-accounts.mdx +++ b/src/content/docs/tenant/how-to/manage-accounts.mdx @@ -36,7 +36,7 @@ To view any accounts owned by your tenant using the dashboard: -To fetch any accounts owned by your tenant using the API, send a [`GET`](/api/operations/accounts-list-accounts) request to the `/accounts` endpoint. +To fetch any accounts owned by your tenant using the API, send a [`GET`](/api/resources/accounts/methods/list/) request to the `/accounts` endpoint. You will get back a list of all the accounts you have created plus any accounts your user already had access to. @@ -81,7 +81,7 @@ curl https://api.cloudflare.com/client/v4/accounts \ ## Update account -To update an account, send a [`PUT`](/api/operations/accounts-update-account) request to the `/accounts/{account_id}` endpoint. +To update an account, send a [`PUT`](/api/resources/accounts/methods/update/) request to the `/accounts/{account_id}` endpoint. ## Delete account diff --git a/src/content/docs/tenant/how-to/manage-subscriptions.mdx b/src/content/docs/tenant/how-to/manage-subscriptions.mdx index 021cab2d2aa79d4..7b54df8813d8df0 100644 --- a/src/content/docs/tenant/how-to/manage-subscriptions.mdx +++ b/src/content/docs/tenant/how-to/manage-subscriptions.mdx @@ -18,11 +18,11 @@ Once your customer has a zone provisioned, you can add zone and account-level su ### Get zone subscription details -To get the details of a zone subscription, send a [`GET`](/api/operations/zone-subscription-zone-subscription-details) request to the `/zones//subscription` endpoint. +To get the details of a zone subscription, send a [`GET`](/api/resources/zones/subresources/subscriptions/methods/get/) request to the `/zones//subscription` endpoint. ### Update zone subscription -To update a subscription on a zone, typically used to update an existing subscription's 'component\_values' or to downgrade a zone's subscription, send a [`PUT`](/api/operations/zone-subscription-update-zone-subscription) request to the `/zones//subscription` endpoint. +To update a subscription on a zone, typically used to update an existing subscription's 'component\_values' or to downgrade a zone's subscription, send a [`PUT`](/api/resources/zones/subresources/subscriptions/methods/update/) request to the `/zones//subscription` endpoint. *** @@ -36,12 +36,12 @@ Depending on your agreement, you may be allowed to resell other add-on services. ### Get account subscription details -To get all subscriptions for an account, send a [`GET`](/api/operations/account-subscriptions-list-subscriptions) request to the `/accounts//subscriptions` endpoint. +To get all subscriptions for an account, send a [`GET`](/api/resources/accounts/subresources/subscriptions/methods/get/) request to the `/accounts//subscriptions` endpoint. ### Update account subscription -To update a subscription on an account, send a [`PUT`](/api/operations/account-subscriptions-update-subscription) request to the `/accounts//subscriptions/` endpoint. +To update a subscription on an account, send a [`PUT`](/api/resources/accounts/subresources/subscriptions/methods/update/) request to the `/accounts//subscriptions/` endpoint. ### Delete account subscription -To delete a subscription on an account, send a [`DELETE`](/api/operations/account-subscriptions-delete-subscription) request to the `/accounts//subscriptions/` endpoint. +To delete a subscription on an account, send a [`DELETE`](/api/resources/accounts/subresources/subscriptions/methods/delete/) request to the `/accounts//subscriptions/` endpoint. diff --git a/src/content/docs/tenant/reference/subscriptions.mdx b/src/content/docs/tenant/reference/subscriptions.mdx index b24e74d6fba65a7..c4bb964a1dbc240 100644 --- a/src/content/docs/tenant/reference/subscriptions.mdx +++ b/src/content/docs/tenant/reference/subscriptions.mdx @@ -10,11 +10,11 @@ When [provisioning services for an account](/tenant/how-to/manage-subscriptions/ The subscriptions available to you will vary depending on your current partner program ([Self-Service Partner Program](https://www.cloudflare.com/cloudflare-partners-self-serve-program-closed-beta/) or [Enterprise Resellers and MSP Program](https://portal.cloudflarepartners.com)). -The following values are samples and not exhaustive. For the complete list of subscription values available to you, make an API call to the [zone subscriptions](/api/operations/zone-rate-plan-list-available-rate-plans) or [account subscriptions](/api/operations/account-subscriptions-list-subscriptions) endpoints. +The following values are samples and not exhaustive. For the complete list of subscription values available to you, make an API call to the [zone subscriptions](/api/resources/zones/subresources/rate_plans/methods/get/) or [account subscriptions](/api/resources/accounts/subresources/subscriptions/methods/get/) endpoints. ## Zone plans -When creating or updating a [zone plan](/api/operations/zone-subscription-zone-subscription-details), Partners can use one of the following values for the `id` of the `rate_plan` field (which controls the zone-level plan subscription). +When creating or updating a [zone plan](/api/resources/zones/subresources/subscriptions/methods/get/), Partners can use one of the following values for the `id` of the `rate_plan` field (which controls the zone-level plan subscription). | Partner program | Available subscriptions | | ----------------------------------- | --------------------------------------------------------------- | diff --git a/src/content/docs/terraform/advanced-topics/remote-backend.mdx b/src/content/docs/terraform/advanced-topics/remote-backend.mdx index d6f74275c879f8f..cd5060cbf81376c 100644 --- a/src/content/docs/terraform/advanced-topics/remote-backend.mdx +++ b/src/content/docs/terraform/advanced-topics/remote-backend.mdx @@ -13,7 +13,7 @@ Cloudflare R2 is an object storage service that provides a highly available, sca ### Create R2 bucket -Using [Wrangler](/workers/wrangler/install-and-update/), [API](/api/operations/r2-create-bucket), or [Account View Dashboard](https://dash.cloudflare.com/?to=/:account/r2/new) create an [R2 Bucket](/r2/buckets/create-buckets/). +Using [Wrangler](/workers/wrangler/install-and-update/), [API](/api/resources/r2/subresources/buckets/methods/create/), or [Account View Dashboard](https://dash.cloudflare.com/?to=/:account/r2/new) create an [R2 Bucket](/r2/buckets/create-buckets/). diff --git a/src/content/docs/turnstile/api-reference.mdx b/src/content/docs/turnstile/api-reference.mdx index f974ecce95802a3..f5835f4e6aed0fd 100644 --- a/src/content/docs/turnstile/api-reference.mdx +++ b/src/content/docs/turnstile/api-reference.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: API reference -external_link: /api/operations/accounts-turnstile-widgets-list +external_link: /api/resources/turnstile/subresources/widgets/methods/list/ sidebar: order: 12 diff --git a/src/content/docs/turnstile/tutorials/implicit-vs-explicit-rendering.mdx b/src/content/docs/turnstile/tutorials/implicit-vs-explicit-rendering.mdx index 273a65639729e72..719128c330d07d2 100644 --- a/src/content/docs/turnstile/tutorials/implicit-vs-explicit-rendering.mdx +++ b/src/content/docs/turnstile/tutorials/implicit-vs-explicit-rendering.mdx @@ -266,4 +266,4 @@ Remember to perform server-side validation of the response token to complete the - [Server-side validation](/turnstile/get-started/server-side-validation/): A guide on how to implement server-side validation to ensure that only valid, human-generated responses are accepted by your application. - [Turnstile Analytics](/turnstile/turnstile-analytics/): A guide on how to access and interpret Turnstile analytics data, allowing you to monitor key metrics, access the number of challenges issued, and evaluate the challenge solve rate (CSR). -- [Turnstile API Reference](/api/operations/accounts-turnstile-widgets-list): Comprehensive documentation for the Turnstile API, providing detailed information on API operations for managing Turnstile widgets, including how to list, create, and update widgets via API calls. +- [Turnstile API Reference](/api/resources/turnstile/subresources/widgets/methods/list/): Comprehensive documentation for the Turnstile API, providing detailed information on API operations for managing Turnstile widgets, including how to list, create, and update widgets via API calls. diff --git a/src/content/docs/turnstile/tutorials/integrating-turnstile-waf-and-bot-management.mdx b/src/content/docs/turnstile/tutorials/integrating-turnstile-waf-and-bot-management.mdx index a472ec84f40b639..87bff40cff208df 100644 --- a/src/content/docs/turnstile/tutorials/integrating-turnstile-waf-and-bot-management.mdx +++ b/src/content/docs/turnstile/tutorials/integrating-turnstile-waf-and-bot-management.mdx @@ -34,7 +34,7 @@ By combining server-side (WAF and Bot Management) and client-side (Turnstile) se - You must have a Cloudflare account with access to WAF and Bot Management (if using). - An existing JavaScript/TypeScript-based route handling authentication. -This tutorial uses a simple login form written in plain HTML to demonstrate how to integrate Turnstile into your application. In the backend, a stubbed out authentication route, written in TypeScript, will handle the login request. You may replace this with the language of your choice. As long as your language or framework is able to make an external HTTP request to [Turnstile's API](/api/operations/accounts-turnstile-widget-create), you can integrate Turnstile into your application. +This tutorial uses a simple login form written in plain HTML to demonstrate how to integrate Turnstile into your application. In the backend, a stubbed out authentication route, written in TypeScript, will handle the login request. You may replace this with the language of your choice. As long as your language or framework is able to make an external HTTP request to [Turnstile's API](/api/resources/turnstile/subresources/widgets/methods/create/), you can integrate Turnstile into your application. ## Configure WAF and Bot Management diff --git a/src/content/docs/vectorize/best-practices/create-indexes.mdx b/src/content/docs/vectorize/best-practices/create-indexes.mdx index c7366aa0acb6e20..d54d74719d3d804 100644 --- a/src/content/docs/vectorize/best-practices/create-indexes.mdx +++ b/src/content/docs/vectorize/best-practices/create-indexes.mdx @@ -41,7 +41,7 @@ npx wrangler vectorize create your-index-name --dimensions=768 --metric=cosine ### HTTP API -Vectorize also supports creating indexes via [REST API](/api/operations/vectorize-create-vectorize-index). +Vectorize also supports creating indexes via [REST API](/api/resources/vectorize/subresources/indexes/methods/create/). For example, to create an index directly from a Python script: diff --git a/src/content/docs/vectorize/best-practices/insert-vectors.mdx b/src/content/docs/vectorize/best-practices/insert-vectors.mdx index a33b7b4acbb274b..101266bc8f0f58c 100644 --- a/src/content/docs/vectorize/best-practices/insert-vectors.mdx +++ b/src/content/docs/vectorize/best-practices/insert-vectors.mdx @@ -157,7 +157,7 @@ wrangler vectorize insert --file=embeddings.ndjson ### HTTP API -Vectorize also supports inserting vectors via the [REST API](/api/operations/vectorize-insert-vector), which allows you to operate on a Vectorize index from existing machine-learning tooling and languages (including Python). +Vectorize also supports inserting vectors via the [REST API](/api/resources/vectorize/subresources/indexes/methods/insert/), which allows you to operate on a Vectorize index from existing machine-learning tooling and languages (including Python). For example, to insert embeddings in [NDJSON format](#workers-api) directly from a Python script: diff --git a/src/content/docs/vectorize/reference/client-api.mdx b/src/content/docs/vectorize/reference/client-api.mdx index 1494a79c03e844e..81a8e8916fdde86 100644 --- a/src/content/docs/vectorize/reference/client-api.mdx +++ b/src/content/docs/vectorize/reference/client-api.mdx @@ -222,4 +222,4 @@ Refer to the [bindings documentation](/workers/wrangler/configuration/#vectorize New Workers projects created via `npm create cloudflare@latest` automatically include the relevant TypeScript types for Vectorize. -Older projects, or non-Workers projects looking to use Vectorize's [REST API](https://developers.cloudflare.com/api/operations/vectorize-list-vectorize-indexes) in a TypeScript project, should ensure `@cloudflare/workers-types` version `4.20230922.0` or later is installed. +Older projects, or non-Workers projects looking to use Vectorize's [REST API](https://developers.cloudflare.com/api/resources/vectorize/subresources/indexes/methods/list/) in a TypeScript project, should ensure `@cloudflare/workers-types` version `4.20230922.0` or later is installed. diff --git a/src/content/docs/vectorize/reference/transition-vectorize-legacy.mdx b/src/content/docs/vectorize/reference/transition-vectorize-legacy.mdx index 8de37a919708c44..7c2577d021c5296 100644 --- a/src/content/docs/vectorize/reference/transition-vectorize-legacy.mdx +++ b/src/content/docs/vectorize/reference/transition-vectorize-legacy.mdx @@ -9,7 +9,7 @@ Legacy Vectorize (V1) indexes are on a deprecation path as of Aug 15, 2024. Your 1. Was created with a Wrangler version lower than `v3.71.0`. 2. Was created using the "--deprecated-v1" flag enabled. -3. Was created using the legacy [REST API](/api/operations/vectorize-(-deprecated)-create-vectorize-index). +3. Was created using the legacy REST API. This document provides details around any transition steps that may be needed to move away from legacy Vectorize indexes. @@ -45,7 +45,7 @@ Watch this space for the upcoming capability to migrate legacy (V1) indexes to t 1. Wrangler now supports operations on the new version of Vectorize (V2) indexes by default. To use Wrangler commands for legacy (V1) indexes, the `--deprecated-v1` flag must be enabled. Please note that this flag is only supported to create, get, list and delete indexes and to insert vectors. -2. Refer to the [REST API](/api/operations/vectorize-create-vectorize-index) page for details on the routes and payload types for the new Vectorize (V2) indexes. For legacy (V1) index operations, refer to [Deprecated REST API](). +2. Refer to the [REST API](/api/resources/vectorize/subresources/indexes/methods/create/) page for details on the routes and payload types for the new Vectorize (V2) indexes. 3. To use the new version of Vectorize indexes in Workers, the environment binding must be defined as a `Vectorize` interface. diff --git a/src/content/docs/vectorize/vectorize-api.mdx b/src/content/docs/vectorize/vectorize-api.mdx index b474c74e34ebd36..6cd3d0dcbcb6304 100644 --- a/src/content/docs/vectorize/vectorize-api.mdx +++ b/src/content/docs/vectorize/vectorize-api.mdx @@ -1,6 +1,6 @@ --- pcx_content_type: navigation title: Vectorize REST API -external_link: /api/operations/vectorize-list-vectorize-indexes +external_link: /api/resources/vectorize/subresources/indexes/methods/list/ --- diff --git a/src/content/docs/waf/account/custom-rulesets/create-api.mdx b/src/content/docs/waf/account/custom-rulesets/create-api.mdx index 9e70fccb9626ed4..ebe9243954b6d10 100644 --- a/src/content/docs/waf/account/custom-rulesets/create-api.mdx +++ b/src/content/docs/waf/account/custom-rulesets/create-api.mdx @@ -153,13 +153,13 @@ Use the different operations in the [Rulesets API](/ruleset-engine/rulesets-api/ | Update a custom rule |

Use the [Update an account ruleset rule][5] operation. You will need to provide the custom ruleset ID and the rule ID.

For more information, refer to [Update a rule in a ruleset][6].

| | Delete a custom rule |

Use the [Delete an account ruleset rule][7] operation. You will need to provide the custom ruleset ID and the rule ID.

For more information, refer to [Delete a rule in a ruleset][8].

| -[1]: /api/operations/listAccountRulesets +[1]: /api/resources/rulesets/methods/list/ [2]: /ruleset-engine/rulesets-api/view/#list-existing-rulesets -[3]: /api/operations/getAccountRuleset +[3]: /api/resources/rulesets/methods/get/ [4]: /ruleset-engine/rulesets-api/view/#view-a-specific-ruleset -[5]: /api/operations/updateAccountRulesetRule +[5]: /api/resources/rulesets/subresources/rules/methods/edit/ [6]: /ruleset-engine/rulesets-api/update-rule/ -[7]: /api/operations/deleteAccountRulesetRule +[7]: /api/resources/rulesets/subresources/rules/methods/delete/ [8]: /ruleset-engine/rulesets-api/delete-rule/ ## More resources diff --git a/src/content/docs/waf/account/managed-rulesets/index.mdx b/src/content/docs/waf/account/managed-rulesets/index.mdx index bd65d7305429b6b..5692f88af5853b3 100644 --- a/src/content/docs/waf/account/managed-rulesets/index.mdx +++ b/src/content/docs/waf/account/managed-rulesets/index.mdx @@ -50,7 +50,7 @@ Once you finish your configuration, the **Deployed managed rulesets** list will -The following `POST` request for the [Create an account ruleset](/api/operations/createAccountRuleset) operation creates an [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) for the `http_request_firewall_managed` phase at the account level. The ruleset includes two rules deploying the Cloudflare OWASP Core Ruleset twice with different configurations. +The following `POST` request for the [Create an account ruleset](/api/resources/rulesets/methods/create/) operation creates an [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) for the `http_request_firewall_managed` phase at the account level. The ruleset includes two rules deploying the Cloudflare OWASP Core Ruleset twice with different configurations. ```bash curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/rulesets" \ diff --git a/src/content/docs/waf/account/rate-limiting-rulesets/create-api.mdx b/src/content/docs/waf/account/rate-limiting-rulesets/create-api.mdx index f824be29f608e25..f7eecf3b8d601cf 100644 --- a/src/content/docs/waf/account/rate-limiting-rulesets/create-api.mdx +++ b/src/content/docs/waf/account/rate-limiting-rulesets/create-api.mdx @@ -173,13 +173,13 @@ Use the different operations in the [Rulesets API](/ruleset-engine/rulesets-api/ | Update a rate limiting rule |

Use the [Update an account ruleset rule][5] operation. You will need to provide the rate limiting ruleset ID and the rule ID.

For more information, refer to [Update a rule in a ruleset][6].

| | Delete a rate limiting rule |

Use the [Delete an account ruleset rule][7] operation. You will need to provide the rate limiting ruleset ID and the rule ID.

For more information, refer to [Delete a rule in a ruleset][8].

| -[1]: /api/operations/listAccountRulesets +[1]: /api/resources/rulesets/methods/list/ [2]: /ruleset-engine/rulesets-api/view/#list-existing-rulesets -[3]: /api/operations/getAccountRuleset +[3]: /api/resources/rulesets/methods/get/ [4]: /ruleset-engine/rulesets-api/view/#view-a-specific-ruleset -[5]: /api/operations/updateAccountRulesetRule +[5]: /api/resources/rulesets/subresources/rules/methods/edit/ [6]: /ruleset-engine/rulesets-api/update-rule/ -[7]: /api/operations/deleteAccountRulesetRule +[7]: /api/resources/rulesets/subresources/rules/methods/delete/ [8]: /ruleset-engine/rulesets-api/delete-rule/ ## More resources diff --git a/src/content/docs/waf/custom-rules/skip/api-examples.mdx b/src/content/docs/waf/custom-rules/skip/api-examples.mdx index 566599fcff27528..3a729065df73375 100644 --- a/src/content/docs/waf/custom-rules/skip/api-examples.mdx +++ b/src/content/docs/waf/custom-rules/skip/api-examples.mdx @@ -19,15 +19,15 @@ This page contains examples of different skip rule scenarios for custom rules. T * The `{zone_id}` value is the [ID of the zone](/fundamentals/setup/find-account-and-zone-ids/) where you want to add the rule. -* The `{ruleset_id}` value is the ID of the [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) of the `http_request_firewall_custom` phase. For details on obtaining this ruleset ID, refer to [List and view rulesets](/ruleset-engine/rulesets-api/view/). The API examples in this page add a skip rule to an existing ruleset using the [Create a zone ruleset rule](/api/operations/createZoneRulesetRule) operation. +* The `{ruleset_id}` value is the ID of the [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) of the `http_request_firewall_custom` phase. For details on obtaining this ruleset ID, refer to [List and view rulesets](/ruleset-engine/rulesets-api/view/). The API examples in this page add a skip rule to an existing ruleset using the [Create a zone ruleset rule](/api/resources/rulesets/methods/create/) operation. - However, the entry point ruleset may not exist yet. In this case, invoke the [Create a zone ruleset](/api/operations/createZoneRuleset) operation to create the entry point ruleset with a skip rule. Refer to [Create ruleset](/ruleset-engine/rulesets-api/create/#example---create-a-zone-level-phase-entry-point-ruleset) for an example. + However, the entry point ruleset may not exist yet. In this case, invoke the [Create a zone ruleset](/api/resources/rulesets/methods/create/) operation to create the entry point ruleset with a skip rule. Refer to [Create ruleset](/ruleset-engine/rulesets-api/create/#example---create-a-zone-level-phase-entry-point-ruleset) for an example. * Although each example only includes one action parameter, you can use several skip options in the same rule by specifying the `ruleset`, `phases`, and `products` action parameters simultaneously. ## Skip the remaining rules in the current ruleset -This example invokes the [Create a zone ruleset rule](/api/operations/createZoneRulesetRule) operation to add a skip rule to the existing `http_request_firewall_custom` phase entry point ruleset with ID `{ruleset_id}`. The rule will skip all remaining rules in the current ruleset for requests matching the rule expression: +This example invokes the [Create a zone ruleset rule](/api/resources/rulesets/methods/create/) operation to add a skip rule to the existing `http_request_firewall_custom` phase entry point ruleset with ID `{ruleset_id}`. The rule will skip all remaining rules in the current ruleset for requests matching the rule expression: ```bash curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id}/rules \ @@ -45,7 +45,7 @@ curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id}/ ## Skip a phase -This example invokes the [Create a zone ruleset rule](/api/operations/createZoneRulesetRule) operation to add a rule to the existing `http_request_firewall_custom` phase entry point ruleset with ID `{ruleset_id}`. The rule will skip the `http_ratelimit` phase for requests matching the rule expression: +This example invokes the [Create a zone ruleset rule](/api/resources/rulesets/methods/create/) operation to add a rule to the existing `http_request_firewall_custom` phase entry point ruleset with ID `{ruleset_id}`. The rule will skip the `http_ratelimit` phase for requests matching the rule expression: ```bash curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id}/rules \ @@ -67,7 +67,7 @@ Refer to [Available skip options](/waf/custom-rules/skip/options/) for the list ## Skip a phase and do not log matching requests -This example invokes the [Create a zone ruleset rule](/api/operations/createZoneRulesetRule) operation to add a rule that: +This example invokes the [Create a zone ruleset rule](/api/resources/rulesets/methods/create/) operation to add a rule that: * Skips the `http_ratelimit` phase * Disables event logging for the current rule @@ -95,7 +95,7 @@ Refer to [Available skip options: Logging](/waf/custom-rules/skip/options/#loggi ## Skip security products -This example uses the [Create a zone ruleset rule](/api/operations/createZoneRulesetRule) operation to add a rule that skips the [Zone Lockdown](/waf/tools/zone-lockdown/) and [User Agent Blocking](/waf/tools/user-agent-blocking/) products for requests matching the rule expression: +This example uses the [Create a zone ruleset rule](/api/resources/rulesets/methods/create/) operation to add a rule that skips the [Zone Lockdown](/waf/tools/zone-lockdown/) and [User Agent Blocking](/waf/tools/user-agent-blocking/) products for requests matching the rule expression: ```bash curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id}/rules \ diff --git a/src/content/docs/waf/managed-rules/payload-logging/configure-api.mdx b/src/content/docs/waf/managed-rules/payload-logging/configure-api.mdx index 501f5b963dd6306..a73b6b8e72e08b4 100644 --- a/src/content/docs/waf/managed-rules/payload-logging/configure-api.mdx +++ b/src/content/docs/waf/managed-rules/payload-logging/configure-api.mdx @@ -15,12 +15,12 @@ Use the [Rulesets API](/ruleset-engine/rulesets-api/) to configure payload loggi ## Configure and enable payload logging -1. Use the [Get a zone entry point ruleset](/api/operations/getZoneEntrypointRuleset) operation to obtain the following IDs: +1. Use the [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/) operation to obtain the following IDs: - The ID of the [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) of the `http_request_firewall_managed` [phase](/ruleset-engine/about/phases/). - The ID of the rule deploying the WAF managed ruleset (an `execute` rule) for which you want to configure payload logging. -2. Use the [Update a zone ruleset rule](/api/operations/updateZoneRulesetRule) operation to update the rule you identified in the previous step. +2. Use the [Update a zone ruleset rule](/api/resources/rulesets/methods/update/) operation to update the rule you identified in the previous step. Include a `matched_data` object in the rule's `action_parameters` object to configure payload logging. The `matched_data` object has the following structure: @@ -39,8 +39,8 @@ Use the [Rulesets API](/ruleset-engine/rulesets-api/) to configure payload loggi To configure payload logging for a managed ruleset deployed at the account level (only available in Enterprise plans with a paid add-on), use the following API operations instead: -- In step 1: [Get an account entry point ruleset](/api/operations/getAccountEntrypointRuleset) -- In step 2: [Update an account ruleset rule](/api/operations/updateAccountRulesetRule) +- In step 1: [Get an account entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/) +- In step 2: [Update an account ruleset rule](/api/resources/rulesets/subresources/rules/methods/edit/) ::: @@ -48,7 +48,7 @@ To configure payload logging for a managed ruleset deployed at the account level This example configures payload logging for the [Cloudflare Managed Ruleset](/waf/managed-rules/reference/cloudflare-managed-ruleset/), which is already deployed for a zone with ID `{zone_id}`. -1. Invoke the [Get a zone entry point ruleset](/api/operations/getZoneEntrypointRuleset) operation (a `GET` request) to obtain the rules currently configured in the entry point ruleset of the `http_request_firewall_managed` phase. +1. Invoke the [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/) operation (a `GET` request) to obtain the rules currently configured in the entry point ruleset of the `http_request_firewall_managed` phase. ```bash title="Request" curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/phases/http_request_firewall_managed/entrypoint \ @@ -99,10 +99,10 @@ This example configures payload logging for the [Cloudflare Managed Ruleset](/wa :::note - To get the IDs of existing WAF managed rulesets, refer to [WAF Managed Rules](/waf/managed-rules/#managed-rulesets) or use the [List account rulesets](/api/operations/listAccountRulesets) operation. + To get the IDs of existing WAF managed rulesets, refer to [WAF Managed Rules](/waf/managed-rules/#managed-rulesets) or use the [List account rulesets](/api/resources/rulesets/methods/list/) operation. ::: -3. Invoke the [Update a zone ruleset rule](/api/operations/updateZoneRulesetRule) operation (a `PATCH` request) to update the configuration of the rule you identified. The rule will now include the payload logging configuration (`matched_data` object). +3. Invoke the [Update a zone ruleset rule](/api/resources/rulesets/methods/update/) operation (a `PATCH` request) to update the configuration of the rule you identified. The rule will now include the payload logging configuration (`matched_data` object). ```bash title="Request" {9-11} curl --request PATCH \ @@ -131,7 +131,7 @@ For more information on deploying managed rulesets via API, refer to [Deploy a m To disable payload logging for a managed ruleset: -1. Use the [Update a zone ruleset rule](/api/operations/updateZoneRulesetRule) operation (a `PATCH` request) to update the rule deploying the managed ruleset (an `execute` rule). +1. Use the [Update a zone ruleset rule](/api/resources/rulesets/methods/update/) operation (a `PATCH` request) to update the rule deploying the managed ruleset (an `execute` rule). 2. Modify the rule definition so that there is no `matched_data` object in `action_parameters`. diff --git a/src/content/docs/waf/managed-rules/reference/owasp-core-ruleset/configure-api.mdx b/src/content/docs/waf/managed-rules/reference/owasp-core-ruleset/configure-api.mdx index aa8c34a3d0f8f9a..e0bcc9883006d5d 100644 --- a/src/content/docs/waf/managed-rules/reference/owasp-core-ruleset/configure-api.mdx +++ b/src/content/docs/waf/managed-rules/reference/owasp-core-ruleset/configure-api.mdx @@ -34,7 +34,7 @@ For example, to enable all the rules associated with Paranoia Level 2 (PL2), dis This example sets the Cloudflare OWASP Core Ruleset's paranoia level for a zone to PL2. To perform this configuration, you must disable the tags associated with levels PL3 and PL4 (`paranoia-level-3` and `paranoia-level-4`) using tag overrides. -1. Get the ID of the Cloudflare OWASP Core Ruleset using the [List account rulesets](/api/operations/listAccountRulesets) method, since WAF's managed rulesets exist at the account level. Alternatively, use the following ruleset ID directly: . +1. Get the ID of the Cloudflare OWASP Core Ruleset using the [List account rulesets](/api/resources/rulesets/methods/list/) method, since WAF's managed rulesets exist at the account level. Alternatively, use the following ruleset ID directly: . ```bash curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/rulesets" \ @@ -62,7 +62,7 @@ This example sets the Cloudflare OWASP Core Ruleset's paranoia level for a zone } ``` -2. Get the ID of the rule that deploys the OWASP ruleset to your zone using the [Get a zone entry point ruleset](/api/operations/getZoneEntrypointRuleset). Search for a rule with `"action": "execute"` configured with the OWASP ruleset's ID in the `action_parameters` object. This rule will only exist if you have already deployed the OWASP ruleset. +2. Get the ID of the rule that deploys the OWASP ruleset to your zone using the [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/). Search for a rule with `"action": "execute"` configured with the OWASP ruleset's ID in the `action_parameters` object. This rule will only exist if you have already deployed the OWASP ruleset. ```bash curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/phases/http_request_firewall_managed/entrypoint" \ @@ -104,7 +104,7 @@ This example sets the Cloudflare OWASP Core Ruleset's paranoia level for a zone } ``` -3. Update the rule you identified using the [Update a zone ruleset rule](/api/operations/updateZoneRulesetRule) operation, adding tag overrides that disable the rules with tags `paranoia-level-3` and `paranoia-level-4`. +3. Update the rule you identified using the [Update a zone ruleset rule](/api/resources/rulesets/methods/update/) operation, adding tag overrides that disable the rules with tags `paranoia-level-3` and `paranoia-level-4`. ```bash null {9-20} curl --request PATCH \ @@ -146,7 +146,7 @@ To define the [score threshold](/waf/managed-rules/reference/owasp-core-ruleset/ This example configures the managed ruleset score threshold and the performed action by creating a rule override for the last rule of the managed ruleset. -1. Get the ID of the Cloudflare OWASP Core Ruleset using the [List account rulesets](/api/operations/listAccountRulesets) method, since WAF's managed rulesets exist at the account level. Alternatively, use the following ruleset ID directly: . +1. Get the ID of the Cloudflare OWASP Core Ruleset using the [List account rulesets](/api/resources/rulesets/methods/list/) method, since WAF's managed rulesets exist at the account level. Alternatively, use the following ruleset ID directly: . ```bash curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/rulesets" \ @@ -174,7 +174,7 @@ This example configures the managed ruleset score threshold and the performed ac } ``` -2. Get the ID of the **last rule** in the Cloudflare OWASP Core Ruleset. Use the [Get an account ruleset](/api/operations/getAccountRuleset) method to obtain the list of rules in the ruleset. Alternatively, use the following rule ID directly: . +2. Get the ID of the **last rule** in the Cloudflare OWASP Core Ruleset. Use the [Get an account ruleset](/api/resources/rulesets/methods/get/) method to obtain the list of rules in the ruleset. Alternatively, use the following rule ID directly: . ```bash curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/rulesets/{owasp_ruleset_id}" \ @@ -212,7 +212,7 @@ This example configures the managed ruleset score threshold and the performed ac } ``` -3. Get the ID of the rule that deploys the OWASP ruleset to your zone using the [Get a zone entry point ruleset](/api/operations/getZoneEntrypointRuleset) (in this example, ``). Search for a rule with `"action": "execute"` configured with the OWASP ruleset's ID in the `action_parameters` object. This rule will only exist if you have already deployed the OWASP ruleset. +3. Get the ID of the rule that deploys the OWASP ruleset to your zone using the [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/) (in this example, ``). Search for a rule with `"action": "execute"` configured with the OWASP ruleset's ID in the `action_parameters` object. This rule will only exist if you have already deployed the OWASP ruleset. ```bash curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/phases/http_request_firewall_managed/entrypoint" \ @@ -254,7 +254,7 @@ This example configures the managed ruleset score threshold and the performed ac } ``` -4. Update the rule you identified in the entry point ruleset using the [Update a zone ruleset rule](/api/operations/updateZoneRulesetRule) operation, adding a rule override for the last rule in the OWASP ruleset (identified in step 2) with the following properties and values: +4. Update the rule you identified in the entry point ruleset using the [Update a zone ruleset rule](/api/resources/rulesets/methods/update/) operation, adding a rule override for the last rule in the OWASP ruleset (identified in step 2) with the following properties and values: - `"score_threshold": 60` - `"action": "managed_challenge"` diff --git a/src/content/docs/waf/managed-rules/waf-exceptions/define-api.mdx b/src/content/docs/waf/managed-rules/waf-exceptions/define-api.mdx index dd6e8fca51c8161..583f80b1a95f1ae 100644 --- a/src/content/docs/waf/managed-rules/waf-exceptions/define-api.mdx +++ b/src/content/docs/waf/managed-rules/waf-exceptions/define-api.mdx @@ -30,7 +30,7 @@ Rules with `skip` action only apply to rules with `execute` action listed **afte The following example adds a rule that skips all remaining rules in the entry point ruleset for requests matching the `dev.example.com` hostname. -1. Invoke the [Get a zone entry point ruleset](/api/operations/getZoneEntrypointRuleset) operation to obtain the current configuration of the entry point ruleset of the `http_request_firewall_managed` phase. +1. Invoke the [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/) operation to obtain the current configuration of the entry point ruleset of the `http_request_firewall_managed` phase. ```bash curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/phases/http_request_firewall_managed/entrypoint \ @@ -60,7 +60,7 @@ The following example adds a rule that skips all remaining rules in the entry po Save the entry point ruleset ID (`060013b1eeb14c93b0dcd896537e0d2c`) for the next step. -2. Invoke the [Create a zone ruleset rule](/api/operations/createZoneRulesetRule) operation (a `POST` request) to add an exception (or skip rule) at the beginning of the rules list, since a skip rule applies only to rules listed after it. The exact rule location is defined in the [`position` object](/ruleset-engine/rulesets-api/add-rule/#define-the-rule-position-in-the-ruleset). +2. Invoke the [Create a zone ruleset rule](/api/resources/rulesets/methods/create/) operation (a `POST` request) to add an exception (or skip rule) at the beginning of the rules list, since a skip rule applies only to rules listed after it. The exact rule location is defined in the [`position` object](/ruleset-engine/rulesets-api/add-rule/#define-the-rule-position-in-the-ruleset). ```bash curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{entry_point_ruleset_id}/rules" \ @@ -85,7 +85,7 @@ For more information on skipping all remaining rules via API, refer to [Create a The following example adds a rule that skips the [Cloudflare Managed Ruleset](/waf/managed-rules/reference/cloudflare-managed-ruleset/) for requests matching the `dev.example.com` hostname. -1. Invoke the [Get a zone entry point ruleset](/api/operations/getZoneEntrypointRuleset) operation to obtain the current configuration of the entry point ruleset of the `http_request_firewall_managed` phase. +1. Invoke the [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/) operation to obtain the current configuration of the entry point ruleset of the `http_request_firewall_managed` phase. ```bash curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/phases/http_request_firewall_managed/entrypoint \ @@ -130,7 +130,7 @@ The following example adds a rule that skips the [Cloudflare Managed Ruleset](/w Identify the rule deploying the Cloudflare Managed Ruleset by searching for an `execute` rule with `action_parameters` > `id` equal to (the managed ruleset ID). :::note - To get the IDs of existing WAF managed rulesets, refer to [WAF Managed Rules](/waf/managed-rules/#managed-rulesets) or use the [List account rulesets](/api/operations/listAccountRulesets) operation. + To get the IDs of existing WAF managed rulesets, refer to [WAF Managed Rules](/waf/managed-rules/#managed-rulesets) or use the [List account rulesets](/api/resources/rulesets/methods/list/) operation. ::: Save the following IDs for the next step: @@ -138,7 +138,7 @@ The following example adds a rule that skips the [Cloudflare Managed Ruleset](/w - The ID of the entry point ruleset (`060013b1eeb14c93b0dcd896537e0d2c` in this example) - The ID of the `execute` rule deployment the managed ruleset (`1bdb49371c1f46958fc8b985efcb79e7` in this example) -2. Invoke the [Create a zone ruleset rule](/api/operations/createZoneRulesetRule) operation (a `POST` request) to add an exception (or skip rule) immediately before the `execute` rule deploying the Cloudflare Managed Ruleset, since a skip rule applies only to rules listed after it. The exact rule location is defined in the [`position` object](/ruleset-engine/rulesets-api/add-rule/#define-the-rule-position-in-the-ruleset). +2. Invoke the [Create a zone ruleset rule](/api/resources/rulesets/methods/create/) operation (a `POST` request) to add an exception (or skip rule) immediately before the `execute` rule deploying the Cloudflare Managed Ruleset, since a skip rule applies only to rules listed after it. The exact rule location is defined in the [`position` object](/ruleset-engine/rulesets-api/add-rule/#define-the-rule-position-in-the-ruleset). ```bash curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{entry_point_ruleset_id}/rules" \ @@ -165,12 +165,12 @@ For more information on skipping one or more managed rulesets via API, refer to The following example adds a rule that skips a particular rule of the [Cloudflare Managed Ruleset](/waf/managed-rules/reference/cloudflare-managed-ruleset/) for requests matching the `dev.example.com` hostname. -1. Invoke the [Get a zone ruleset](/api/operations/getZoneRuleset) operation to obtain a list of rules in the Cloudflare Managed Ruleset (ruleset ID ).
- You can get the managed ruleset details using the account-level endpoint ([Get an account ruleset](/api/operations/getAccountRuleset)) or the zone-level endpoint ([Get a zone ruleset](/api/operations/getZoneRuleset)). +1. Invoke the [Get a zone ruleset](/api/resources/rulesets/methods/get/) operation to obtain a list of rules in the Cloudflare Managed Ruleset (ruleset ID ).
+ You can get the managed ruleset details using the account-level endpoint ([Get an account ruleset](/api/resources/rulesets/methods/get/)) or the zone-level endpoint ([Get a zone ruleset](/api/resources/rulesets/methods/get/)). :::note - To get the IDs of existing WAF managed rulesets, refer to [WAF Managed Rules](/waf/managed-rules/#managed-rulesets) or use the [List account rulesets](/api/operations/listAccountRulesets) operation. + To get the IDs of existing WAF managed rulesets, refer to [WAF Managed Rules](/waf/managed-rules/#managed-rulesets) or use the [List account rulesets](/api/resources/rulesets/methods/list/) operation. ::: ```bash @@ -212,7 +212,7 @@ The following example adds a rule that skips a particular rule of the [Cloudflar Take note of the ID of the rule you want to skip ( in this example). -2. Invoke the [Get a zone entry point ruleset](/api/operations/getZoneEntrypointRuleset) operation to obtain the current configuration of the [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) of the `http_request_firewall_managed` phase. +2. Invoke the [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/) operation to obtain the current configuration of the [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) of the `http_request_firewall_managed` phase. ```bash curl https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/phases/http_request_firewall_managed/entrypoint \ @@ -257,7 +257,7 @@ The following example adds a rule that skips a particular rule of the [Cloudflar Identify the rule deploying the Cloudflare Managed Ruleset by searching for an `execute` rule with `action_parameters` > `id` equal to (the managed ruleset ID). :::note - To get the IDs of existing WAF managed rulesets, refer to [WAF Managed Rules](/waf/managed-rules/#managed-rulesets) or use the [List account rulesets](/api/operations/listAccountRulesets) operation. + To get the IDs of existing WAF managed rulesets, refer to [WAF Managed Rules](/waf/managed-rules/#managed-rulesets) or use the [List account rulesets](/api/resources/rulesets/methods/list/) operation. ::: Save the following IDs for the next step: @@ -270,7 +270,7 @@ The following example adds a rule that skips a particular rule of the [Cloudflar - The ID of the Cloudflare Managed Ruleset () - The ID of the rule to skip ( in this example) -3. Invoke the [Create a zone ruleset rule](/api/operations/createZoneRulesetRule) operation (a `POST` request) to add an exception (or skip rule) immediately before the `execute` rule deploying the Cloudflare Managed Ruleset, since a skip rule applies only to rules listed after it. +3. Invoke the [Create a zone ruleset rule](/api/resources/rulesets/methods/create/) operation (a `POST` request) to add an exception (or skip rule) immediately before the `execute` rule deploying the Cloudflare Managed Ruleset, since a skip rule applies only to rules listed after it. ```bash curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{entry_point_ruleset_id}/rules" \ diff --git a/src/content/docs/waf/reference/legacy/old-rate-limiting/index.mdx b/src/content/docs/waf/reference/legacy/old-rate-limiting/index.mdx index 58cdd9fc9109d79..765ce599213fd1e 100644 --- a/src/content/docs/waf/reference/legacy/old-rate-limiting/index.mdx +++ b/src/content/docs/waf/reference/legacy/old-rate-limiting/index.mdx @@ -338,4 +338,4 @@ Rate Limiting is designed to limit surges in traffic that exceed a user-defined ## Related resources - [Troubleshooting Rate Limiting (previous version)](/waf/reference/legacy/old-rate-limiting/troubleshooting/) -- [Configure Rate Limiting via the Cloudflare API](/api/operations/rate-limits-for-a-zone-create-a-rate-limit) +- [Configure Rate Limiting via the Cloudflare API](/api/resources/rate_limits/methods/create/) diff --git a/src/content/docs/waf/reference/legacy/old-rate-limiting/troubleshooting.mdx b/src/content/docs/waf/reference/legacy/old-rate-limiting/troubleshooting.mdx index 2a178e6e4eb1932..28db311cfb1f867 100644 --- a/src/content/docs/waf/reference/legacy/old-rate-limiting/troubleshooting.mdx +++ b/src/content/docs/waf/reference/legacy/old-rate-limiting/troubleshooting.mdx @@ -20,7 +20,7 @@ A few common rate limiting configuration issues prevent proper request matches: ## Common API errors -The following common errors may prevent configuring rate limiting rules via the [Cloudflare API](/api/operations/rate-limits-for-a-zone-create-a-rate-limit):   +The following common errors may prevent configuring rate limiting rules via the [Cloudflare API](/api/resources/rate_limits/methods/create/):   * `Decoding is not yet implemented` – Indicates that your request is missing the `Content-Type: application/json` header. Add the header to your API request to fix the issue. * `Ratelimit.api.not_entitled` – Enterprise customers must contact their account team before adding rules. diff --git a/src/content/docs/waf/reference/migration-guides/old-rate-limiting-deprecation.mdx b/src/content/docs/waf/reference/migration-guides/old-rate-limiting-deprecation.mdx index 84f8752a7380580..1cfed918db1bee4 100644 --- a/src/content/docs/waf/reference/migration-guides/old-rate-limiting-deprecation.mdx +++ b/src/content/docs/waf/reference/migration-guides/old-rate-limiting-deprecation.mdx @@ -55,7 +55,7 @@ If you had access to the previous version of Cloudflare Rate Limiting, you will The new rate limiting rules are based on the [Ruleset Engine](/ruleset-engine/). To configure rate limiting rules via the API, you must use the [Rulesets API](/ruleset-engine/rulesets-api/). The Rulesets API is used on all recent Cloudflare security products to provide a uniform user experience when interacting with the Cloudflare API. -**The [previous Rate Limiting API](/api/operations/rate-limits-for-a-zone-list-rate-limits) is now deprecated.** You will not be able to perform any API calls after 2025-06-15. +**The [previous Rate Limiting API](/api/resources/rate_limits/methods/list/) is now deprecated.** You will not be able to perform any API calls after 2025-06-15. ### Relevant changes for Terraform users diff --git a/src/content/docs/waf/reference/migration-guides/waf-managed-rules-migration.mdx b/src/content/docs/waf/reference/migration-guides/waf-managed-rules-migration.mdx index d45de616ba3d36c..c8ae9eb4ca22ebf 100644 --- a/src/content/docs/waf/reference/migration-guides/waf-managed-rules-migration.mdx +++ b/src/content/docs/waf/reference/migration-guides/waf-managed-rules-migration.mdx @@ -83,9 +83,9 @@ To replace these settings you will need to configure the Cloudflare OWASP Core R ### Configurations that will prevent you from updating -If a zone has [URI-based WAF overrides](/api/operations/waf-overrides-list-waf-overrides) (only available via API), you will not have the option to migrate to WAF Managed Rules. To update to WAF Managed Rules you must: +If a zone has [URI-based WAF overrides](/api/resources/firewall/subresources/waf/subresources/overrides/methods/list/) (only available via API), you will not have the option to migrate to WAF Managed Rules. To update to WAF Managed Rules you must: -1. Delete any existing URI-based WAF overrides using the [Delete a WAF override](/api/operations/waf-overrides-delete-a-waf-override) operation. +1. Delete any existing URI-based WAF overrides using the [Delete a WAF override](/api/resources/firewall/subresources/waf/subresources/overrides/methods/delete/) operation. 2. Follow the update process described below. ### Cloudflare dashboard changes @@ -102,9 +102,9 @@ For more information about configuring WAF Managed Rules in the dashboard, refer Once the migration is complete, the APIs for interacting with WAF managed rules **will stop working**. These APIs are the following: -- [WAF packages](/api/operations/waf-packages-list-waf-packages) -- [WAF rule groups](/api/operations/waf-rule-groups-list-waf-rule-groups) -- [WAF rules](/api/operations/waf-rules-list-waf-rules) +- [WAF packages](/api/resources/firewall/subresources/waf/subresources/packages/methods/list/) +- [WAF rule groups](/api/resources/firewall/subresources/waf/subresources/packages/subresources/groups/methods/list/) +- [WAF rules](/api/resources/firewall/subresources/waf/subresources/packages/subresources/rules/methods/list/) :::caution If you have any integrations using the WAF managed rules APIs stated above, you must update them before migrating to the new WAF Managed Rules. @@ -140,7 +140,7 @@ In phase 2 all zones are eligible for migration. The exact migration procedure v - **Enterprise** customers can enable the new WAF Managed Rules configuration while keeping the previous version of WAF managed rules enabled, allowing them to check the impact of the new WAF configuration. After reviewing the behavior of the new configuration and making any required adjustments to specific managed rules, Enterprise users can then finish the migration, which will disable the previous version of WAF managed rules. -**Note:** Zones that have [URI-based WAF overrides](/api/operations/waf-overrides-list-waf-overrides), which you could only manage via API, will not be able to migrate immediately to the new WAF Managed Rules. You must delete these overrides before migrating. +**Note:** Zones that have [URI-based WAF overrides](/api/resources/firewall/subresources/waf/subresources/overrides/methods/list/), which you could only manage via API, will not be able to migrate immediately to the new WAF Managed Rules. You must delete these overrides before migrating. ### Phase 1 (since 2022-05-04) @@ -157,7 +157,7 @@ In phase 1 the migration became available to a subset of eligible zones, which h - Page Rules configured with _Disable Security_. - Page Rules configured with _Web Application Firewall: Off_ or _Web Application Firewall: On._ -- The zone has no [URI-based WAF overrides](/api/operations/waf-overrides-list-waf-overrides) (only available via API). +- The zone has no [URI-based WAF overrides](/api/resources/firewall/subresources/waf/subresources/overrides/methods/list/) (only available via API). --- @@ -276,7 +276,7 @@ The returned configuration in the example above, which would match the existing - A rule that executes the Cloudflare Managed Ruleset (ruleset ID efb7b8c949ac4650a09736fc376e9aee). - A single override for the rule `Apache Struts - Open Redirect - CVE:CVE-2013-2248` (rule ID 23ee7cebe6e8443e99ecf932ab579455) in the same ruleset, setting the action to `log` and disabling the rule. -3. (Optional, for Enterprise customers only) If you are migrating an Enterprise zone to WAF Managed Rules, you can enter validation mode before finishing the migration. In this mode, both WAF implementations will be enabled. Use the [Update a zone entry point ruleset](/api/operations/updateZoneEntrypointRuleset) operation, making sure you include the `waf_migration=validation&phase_two=1` query string parameters: +3. (Optional, for Enterprise customers only) If you are migrating an Enterprise zone to WAF Managed Rules, you can enter validation mode before finishing the migration. In this mode, both WAF implementations will be enabled. Use the [Update a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/update/) operation, making sure you include the `waf_migration=validation&phase_two=1` query string parameters: ```bash curl --request PUT \ diff --git a/src/content/docs/waf/tools/ip-access-rules/create.mdx b/src/content/docs/waf/tools/ip-access-rules/create.mdx index 15db21699bc1bfa..5b38b9e672ba0e3 100644 --- a/src/content/docs/waf/tools/ip-access-rules/create.mdx +++ b/src/content/docs/waf/tools/ip-access-rules/create.mdx @@ -27,6 +27,6 @@ import { TabItem, Tabs } from "~/components"; -Use the Cloudflare API to programmatically create IP Access rules. For more information, refer to [Get IP Access rules](/api/operations/ip-access-rules-for-a-user-list-ip-access-rules). +Use the Cloudflare API to programmatically create IP Access rules. For more information, refer to [Get IP Access rules](/api/resources/firewall/subresources/access_rules/methods/create/). diff --git a/src/content/docs/waf/tools/lists/index.mdx b/src/content/docs/waf/tools/lists/index.mdx index 0c678f8d43366b1..369b80e039e3ba6 100644 --- a/src/content/docs/waf/tools/lists/index.mdx +++ b/src/content/docs/waf/tools/lists/index.mdx @@ -54,7 +54,7 @@ Currently, not all Cloudflare products support lists in their expressions. Refer ### Search list items -You can search for list items in the dashboard or [via API](/api/operations/lists-get-list-items). +You can search for list items in the dashboard or [via API](/api/resources/rules/subresources/lists/subresources/items/methods/list/). For IP Lists, Cloudflare will return IP addresses/ranges that start with your search query (search by prefix). Currently, you cannot search for an IP address contained in a CIDR range of an IP List. @@ -86,6 +86,6 @@ You can only delete a list when there are no rules (enabled or disabled) that re -To replace the entire contents of a list, format the data as an array and use the [Update all list items](/api/operations/lists-update-all-list-items) operation in the [Lists API](/waf/tools/lists/lists-api/endpoints/). +To replace the entire contents of a list, format the data as an array and use the [Update all list items](/api/resources/rules/subresources/lists/subresources/items/methods/update/) operation in the [Lists API](/waf/tools/lists/lists-api/endpoints/). -You cannot download a list in CSV format from the Cloudflare dashboard. If you need to download the contents of a list, use the [Get list items](/api/operations/lists-get-list-items) operation to fetch the list items. +You cannot download a list in CSV format from the Cloudflare dashboard. If you need to download the contents of a list, use the [Get list items](/api/resources/rules/subresources/lists/subresources/items/methods/list/) operation to fetch the list items. diff --git a/src/content/docs/waf/tools/lists/lists-api/endpoints.mdx b/src/content/docs/waf/tools/lists/lists-api/endpoints.mdx index 71e4ca4e6246ac6..d150904df4bc647 100644 --- a/src/content/docs/waf/tools/lists/lists-api/endpoints.mdx +++ b/src/content/docs/waf/tools/lists/lists-api/endpoints.mdx @@ -6,7 +6,7 @@ sidebar: --- -To invoke a [Lists API](/api/operations/lists-get-lists) operation, append the endpoint to the Cloudflare API base URL: +To invoke a [Lists API](/api/resources/rules/subresources/lists/methods/list/) operation, append the endpoint to the Cloudflare API base URL: `https://api.cloudflare.com/client/v4/` @@ -19,7 +19,7 @@ For help with making API calls and paginating results, refer to [Make API calls] The Lists API endpoints require a value for `{account_id}`. -To retrieve a list of accounts to which you have access, use the [List Accounts](/api/operations/accounts-list-accounts) operation and note the IDs of the accounts you want to manage. +To retrieve a list of accounts to which you have access, use the [List Accounts](/api/resources/accounts/methods/list/) operation and note the IDs of the accounts you want to manage. ::: @@ -32,11 +32,11 @@ The Lists API supports the operations outlined below. Visit the associated links | Operation | Endpoint | Notes | | --- | --- | --- | -| [Create a list](/api/operations/lists-create-a-list) | `POST accounts/{account_id}/rules/lists` | Creates an empty list | -| [Get lists](/api/operations/lists-get-lists) | `GET accounts/{account_id}/rules/lists` | Fetch all lists for the account. (This request does not fetch the items in the lists.) | -| [Get a list](/api/operations/lists-get-a-list) | `GET accounts/{account_id}/rules/lists/{list_id}` | Fetches a list by its ID. (This request does not display the items in the list.) | -| [Update a list](/api/operations/lists-update-a-list) | `PUT accounts/{account_id}/rules/lists/{list_id}` | Updates the `description` of a list. You cannot edit the `name` or `kind`, and you cannot update items in a list. To update an item in a list, use the [Update all list items](/api/operations/lists-update-all-list-items) operation. | -| [Delete a list](/api/operations/lists-delete-a-list) | `DELETE accounts/{account_id}/rules/lists/{list_id}` | Deletes the list, but only when no filters reference it. | +| [Create a list](/api/resources/rules/subresources/lists/methods/create/) | `POST accounts/{account_id}/rules/lists` | Creates an empty list | +| [Get lists](/api/resources/rules/subresources/lists/methods/list/) | `GET accounts/{account_id}/rules/lists` | Fetch all lists for the account. (This request does not fetch the items in the lists.) | +| [Get a list](/api/resources/rules/subresources/lists/methods/get/) | `GET accounts/{account_id}/rules/lists/{list_id}` | Fetches a list by its ID. (This request does not display the items in the list.) | +| [Update a list](/api/resources/rules/subresources/lists/methods/update/) | `PUT accounts/{account_id}/rules/lists/{list_id}` | Updates the `description` of a list. You cannot edit the `name` or `kind`, and you cannot update items in a list. To update an item in a list, use the [Update all list items](/api/resources/rules/subresources/lists/subresources/items/methods/update/) operation. | +| [Delete a list](/api/resources/rules/subresources/lists/methods/delete/) | `DELETE accounts/{account_id}/rules/lists/{list_id}` | Deletes the list, but only when no filters reference it. | ## Manage items in a list @@ -44,29 +44,29 @@ The Lists API supports the operations outlined below. Visit the associated links Nearly all the operations for managing items in a list are asynchronous. When you add or delete a large amount of items to or from a list, there may be a delay before the bulk operation is complete. -Asynchronous list operations return an `operation_id`, which you can use to monitor the status of an API operation. To monitor the status of an asynchronous operation, use the [Get bulk operation status](/api/operations/lists-get-bulk-operation-status) endpoint and specify the ID of the operation you want to monitor. +Asynchronous list operations return an `operation_id`, which you can use to monitor the status of an API operation. To monitor the status of an asynchronous operation, use the [Get bulk operation status](/api/resources/rules/subresources/lists/subresources/bulk_operations/methods/get/) endpoint and specify the ID of the operation you want to monitor. When you make requests to a list while a bulk operation on that list is in progress, the requests are queued and processed in sequence (first in, first out). Requests for successful asynchronous operations return an `HTTP 201` status code. ### Get list items -- **Operation**: [Get list items](/api/operations/lists-get-list-items) +- **Operation**: [Get list items](/api/resources/rules/subresources/lists/subresources/items/methods/list/) - **Method and endpoints**: `GET accounts/{account_id}/rules/lists/{list_id}/items[?search={query}]` - **Notes**: - Fetches items in a list (all items, by default). - Items are sorted in ascending order. - In the case of IP lists, CIDRs are sorted by IP address, then by the subnet mask. - - To filter returned items, use the optional `search` query string parameter. For more information, refer to the [Get list items](/api/operations/lists-get-list-items) API operation. + - To filter returned items, use the optional `search` query string parameter. For more information, refer to the [Get list items](/api/resources/rules/subresources/lists/subresources/items/methods/list/) API operation. ### Get a list item -- **Operation**: [Get a list item](/api/operations/lists-get-a-list-item) +- **Operation**: [Get a list item](/api/resources/rules/subresources/lists/subresources/items/methods/get/) - **Method and endpoints**: `GET accounts/{account_id}/rules/lists/{list_id}/items/{item_id}` - **Notes**: Fetches an item from a list by ID ### Create list items -- **Operation**: [Create list items](/api/operations/lists-create-list-items) +- **Operation**: [Create list items](/api/resources/rules/subresources/lists/subresources/items/methods/create/) - **Method and endpoints**: `POST accounts/{account_id}/rules/lists/{list_id}/items` - **Notes**: - Appends a new item or items to a list. @@ -76,7 +76,7 @@ When you make requests to a list while a bulk operation on that list is in progr ### Update all list items -- **Operation**: [Update all list items](/api/operations/lists-update-all-list-items) +- **Operation**: [Update all list items](/api/resources/rules/subresources/lists/subresources/items/methods/update/) - **Method and endpoints**: `PUT accounts/{account_id}/rules/lists/{list_id}/items` - **Notes**: - Deletes all current items in the list and replaces them with `items`. @@ -85,7 +85,7 @@ When you make requests to a list while a bulk operation on that list is in progr ### Delete list items -- **Operation**: [Delete list items](/api/operations/lists-delete-list-items) +- **Operation**: [Delete list items](/api/resources/rules/subresources/lists/subresources/items/methods/delete/) - **Method and endpoints**: `DELETE accounts/{account_id}/rules/lists/{list_id}/items` - **Notes**: - Deletes specified list items. diff --git a/src/content/docs/waf/tools/lists/lists-api/index.mdx b/src/content/docs/waf/tools/lists/lists-api/index.mdx index c9b3ae4436ac12c..9477b2d590a8376 100644 --- a/src/content/docs/waf/tools/lists/lists-api/index.mdx +++ b/src/content/docs/waf/tools/lists/lists-api/index.mdx @@ -5,7 +5,7 @@ sidebar: order: 7 --- -The [Lists API](/api/operations/lists-get-lists) provides an interface for programmatically managing the following types of lists: +The [Lists API](/api/resources/rules/subresources/lists/methods/list/) provides an interface for programmatically managing the following types of lists: - [Custom lists](/waf/tools/lists/custom-lists/): Contain one or more strings of the same type (such as IP addresses or hostnames) that you can reference collectively, by name, in rule expressions. diff --git a/src/content/docs/waf/tools/lists/lists-api/json-object.mdx b/src/content/docs/waf/tools/lists/lists-api/json-object.mdx index 29010f68015ed0b..daa0ba51907bd9e 100644 --- a/src/content/docs/waf/tools/lists/lists-api/json-object.mdx +++ b/src/content/docs/waf/tools/lists/lists-api/json-object.mdx @@ -12,7 +12,7 @@ description: Reference information on the JSON object used in Lists API calls. ## List object structure and properties -A JSON response for the [Lists API](/api/operations/lists-get-lists) has this structure: +A JSON response for the [Lists API](/api/resources/rules/subresources/lists/methods/list/) has this structure: ```json { @@ -105,4 +105,4 @@ The JSON object properties for a list item are defined as follows: -For a detailed specification, refer to the [Lists API](/api/operations/lists-get-lists) documentation. +For a detailed specification, refer to the [Lists API](/api/resources/rules/subresources/lists/methods/list/) documentation. diff --git a/src/content/docs/waf/tools/scrape-shield/email-address-obfuscation.mdx b/src/content/docs/waf/tools/scrape-shield/email-address-obfuscation.mdx index 0bc25f5518653f6..5048c136cf9b5da 100644 --- a/src/content/docs/waf/tools/scrape-shield/email-address-obfuscation.mdx +++ b/src/content/docs/waf/tools/scrape-shield/email-address-obfuscation.mdx @@ -31,7 +31,7 @@ To disable **Email Address Obfuscation** in the dashboard: -To disable **Email Address Obfuscation** with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `email_obfuscation` as the setting name in the URI path, and the `value` parameter set to `"off"`. +To disable **Email Address Obfuscation** with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `email_obfuscation` as the setting name in the URI path, and the `value` parameter set to `"off"`. diff --git a/src/content/docs/waf/tools/scrape-shield/hotlink-protection.mdx b/src/content/docs/waf/tools/scrape-shield/hotlink-protection.mdx index 4c698dcc991374f..a9d72369bbf9df0 100644 --- a/src/content/docs/waf/tools/scrape-shield/hotlink-protection.mdx +++ b/src/content/docs/waf/tools/scrape-shield/hotlink-protection.mdx @@ -38,7 +38,7 @@ To enable **Hotlink Protection** in the dashboard: -To enable **Hotlink Protection** with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `hotlink_protection` as the setting name in the URI path, and the `value` parameter set to `"on"`. +To enable **Hotlink Protection** with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `hotlink_protection` as the setting name in the URI path, and the `value` parameter set to `"on"`. diff --git a/src/content/docs/waf/tools/user-agent-blocking.mdx b/src/content/docs/waf/tools/user-agent-blocking.mdx index 0e85e7eba351e48..aefc0d3be1163f0 100644 --- a/src/content/docs/waf/tools/user-agent-blocking.mdx +++ b/src/content/docs/waf/tools/user-agent-blocking.mdx @@ -49,7 +49,7 @@ Cloudflare User Agent Blocking is available on all plans. The number of availabl -Issue a `POST` request for the [Create a User Agent Blocking rule](/api/operations/user-agent-blocking-rules-create-a-user-agent-blocking-rule) operation. +Issue a `POST` request for the [Create a User Agent Blocking rule](/api/resources/firewall/subresources/ua_rules/methods/create/) operation. For example: diff --git a/src/content/docs/waf/tools/zone-lockdown.mdx b/src/content/docs/waf/tools/zone-lockdown.mdx index 1f3c653c7f55ebe..4b316ea83c5e5f3 100644 --- a/src/content/docs/waf/tools/zone-lockdown.mdx +++ b/src/content/docs/waf/tools/zone-lockdown.mdx @@ -52,7 +52,7 @@ Cloudflare Zone Lockdown is available on paid plans. The number of available Zon -Issue a `POST` request for the [Create a Zone Lockdown rule](/api/operations/zone-lockdown-create-a-zone-lockdown-rule) operation. +Issue a `POST` request for the [Create a Zone Lockdown rule](/api/resources/firewall/subresources/lockdowns/methods/create/) operation. For example: diff --git a/src/content/docs/waf/troubleshooting/blocked-bing-site-scans.mdx b/src/content/docs/waf/troubleshooting/blocked-bing-site-scans.mdx index c19c0a0b8d951e9..14570cb15a4cd2e 100644 --- a/src/content/docs/waf/troubleshooting/blocked-bing-site-scans.mdx +++ b/src/content/docs/waf/troubleshooting/blocked-bing-site-scans.mdx @@ -27,6 +27,6 @@ The exception, shown as a rule with a **Skip** action, must appear in the rules To check the rule order, use one of the following methods: - When using the Cloudflare dashboard, the rules listed in **Security** > **WAF** > **Managed rules** run in order. -- When using the Cloudflare API, the rules in the `rules` object obtained using the [Get a zone entry point ruleset](/api/operations/getZoneEntrypointRuleset) operation (for your zone and for the `http_request_firewall_managed` phase) run in order. +- When using the Cloudflare API, the rules in the `rules` object obtained using the [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/) operation (for your zone and for the `http_request_firewall_managed` phase) run in order. For more information on creating exceptions, refer to [Create exceptions](/waf/managed-rules/waf-exceptions/). diff --git a/src/content/docs/waf/troubleshooting/samesite-cookie-interaction.mdx b/src/content/docs/waf/troubleshooting/samesite-cookie-interaction.mdx index 1597ebc22ebb879..79ea07e38148092 100644 --- a/src/content/docs/waf/troubleshooting/samesite-cookie-interaction.mdx +++ b/src/content/docs/waf/troubleshooting/samesite-cookie-interaction.mdx @@ -27,7 +27,7 @@ The `SameSite` cookie attribute has three different modes: ## SameSite attribute in session affinity cookies -Currently, to configure the `SameSite` attribute on [session affinity cookies](/load-balancing/understand-basics/session-affinity/) you must use the Cloudflare API (for example, the [Create Load Balancer](/api/operations/load-balancers-create-load-balancer) operation). +Currently, to configure the `SameSite` attribute on [session affinity cookies](/load-balancing/understand-basics/session-affinity/) you must use the Cloudflare API (for example, the [Create Load Balancer](/api/resources/load_balancers/methods/create/) operation). To configure the value of the `SameSite` cookie attribute, include the `samesite` and `secure` JSON attributes in your HTTP request, inside the `session_affinity_attributes` object. diff --git a/src/content/docs/waiting-room/additional-options/create-events.mdx b/src/content/docs/waiting-room/additional-options/create-events.mdx index 94ab6c36fc070e6..8fccf4130bd7475 100644 --- a/src/content/docs/waiting-room/additional-options/create-events.mdx +++ b/src/content/docs/waiting-room/additional-options/create-events.mdx @@ -56,9 +56,9 @@ You have a limit of five events per waiting room. To create a new event after yo ## Create an event via API -To create an event, make a [POST request](/api/operations/waiting-room-create-event) including [required and optional parameters](#parameters). Any properties set on the event will override the default property on the waiting room for the duration of the event. +To create an event, make a [POST request](/api/resources/waiting_rooms/subresources/events/methods/create/) including [required and optional parameters](#parameters). Any properties set on the event will override the default property on the waiting room for the duration of the event. -If you are using a [custom template](/waiting-room/how-to/customize-waiting-room/#custom-waiting-room), you may want to add [relevant variables](/api/operations/waiting-room-update-waiting-room) to your template (listed under the `json_response_enabled` parameter). +If you are using a [custom template](/waiting-room/how-to/customize-waiting-room/#custom-waiting-room), you may want to add [relevant variables](/api/resources/waiting_rooms/methods/update/) to your template (listed under the `json_response_enabled` parameter). :::note @@ -70,7 +70,7 @@ If you need to create overlapping events, use different waiting rooms. ### Parameters -Though most parameters are identical to those in a regular waiting room, there are a few unique to creating an event. For a complete list of event settings, please refer to [Create an Event](/api/operations/waiting-room-create-event). +Though most parameters are identical to those in a regular waiting room, there are a few unique to creating an event. For a complete list of event settings, please refer to [Create an Event](/api/resources/waiting_rooms/subresources/events/methods/create/). * `name` (required): Unique name with alphanumeric characters, hyphens, and underscores. * `event_start_time` (required): ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. Must occur at least 1 minute before `event_end_time`. @@ -101,13 +101,13 @@ To set up a "lottery", include the [following parameters](#parameters) in your A ## Preview an event configuration -Since some properties set on an event will override the default property of a waiting room for the duration of an event, you should use the API to [preview an event configuration](/api/operations/waiting-room-preview-active-event-details) before it begins. +Since some properties set on an event will override the default property of a waiting room for the duration of an event, you should use the API to [preview an event configuration](/api/resources/waiting_rooms/subresources/events/subresources/details/methods/get/) before it begins. This command shows you the event's configuration as if it were active, meaning that inherited fields from the waiting room will display their current values. ## Edit an event -To edit an event, use a [PATCH request](/api/operations/waiting-room-patch-event). +To edit an event, use a [PATCH request](/api/resources/waiting_rooms/subresources/events/methods/edit/). ## Disable events @@ -128,6 +128,6 @@ After the scheduled event has ended, users will have access to your site. You c | Function | Command | | ----------------------------------------------------------------- | -------- | -| [Get event details](/api/operations/waiting-room-event-details) | `GET` | -| [List scheduled events](/api/operations/waiting-room-list-events) | `GET` | -| [Delete event](/api/operations/waiting-room-delete-event) | `DELETE` | +| [Get event details](/api/resources/waiting_rooms/subresources/events/methods/get/) | `GET` | +| [List scheduled events](/api/resources/waiting_rooms/subresources/events/methods/list/) | `GET` | +| [Delete event](/api/resources/waiting_rooms/subresources/events/methods/delete/) | `DELETE` | diff --git a/src/content/docs/waiting-room/additional-options/embed-waiting-room-in-iframe.mdx b/src/content/docs/waiting-room/additional-options/embed-waiting-room-in-iframe.mdx index 6cf1d12de23929a..54522c07408c217 100644 --- a/src/content/docs/waiting-room/additional-options/embed-waiting-room-in-iframe.mdx +++ b/src/content/docs/waiting-room/additional-options/embed-waiting-room-in-iframe.mdx @@ -18,7 +18,7 @@ However, this behavior can prevent a waiting room from queueing a user properly ## Available options -To customize how your waiting room responds to cookies, include the `cookie_attributes` object when you [create a waiting room](/api/operations/waiting-room-create-waiting-room) (only available via the API). +To customize how your waiting room responds to cookies, include the `cookie_attributes` object when you [create a waiting room](/api/resources/waiting_rooms/methods/create/) (only available via the API). Available options include: @@ -37,7 +37,7 @@ Available options include: ## Allow cookies to pass through iFrames -If you are embedding a waiting room in an iFrame, specify the following values on `cookie_attributes` object when [creating a waiting room](/api/operations/waiting-room-create-waiting-room) (only available via the API): +If you are embedding a waiting room in an iFrame, specify the following values on `cookie_attributes` object when [creating a waiting room](/api/resources/waiting_rooms/methods/create/) (only available via the API): * `samesite`: `none` * `secure`: If you have [**Always Use HTTPS**](/ssl/edge-certificates/additional-options/always-use-https/) enabled, set to `auto`. If you have it disabled, set to `always`. diff --git a/src/content/docs/waiting-room/additional-options/waiting-room-rules/bypass-rules.mdx b/src/content/docs/waiting-room/additional-options/waiting-room-rules/bypass-rules.mdx index c0762f9ca2f57e3..3f95706ed203d25 100644 --- a/src/content/docs/waiting-room/additional-options/waiting-room-rules/bypass-rules.mdx +++ b/src/content/docs/waiting-room/additional-options/waiting-room-rules/bypass-rules.mdx @@ -63,7 +63,7 @@ For examples and usage, refer to [Operators and grouping symbols](/ruleset-engin ## Manage Rules via the Waiting Room API -You can manage, delete, and create bypass rules for your waiting room via the [Waiting Room API’s](/api/operations/waiting-room-list-waiting-room-rules). A bypass rule is a Waiting Room Rule that utilizes the `bypass_waiting_room` action. +You can manage, delete, and create bypass rules for your waiting room via the [Waiting Room API’s](/api/resources/waiting_rooms/subresources/rules/methods/get/). A bypass rule is a Waiting Room Rule that utilizes the `bypass_waiting_room` action. When creating a Bypass Waiting Room Rule via API, make sure you: diff --git a/src/content/docs/waiting-room/api-reference.mdx b/src/content/docs/waiting-room/api-reference.mdx index c4432bc9dbf41b9..aeaa530639cebee 100644 --- a/src/content/docs/waiting-room/api-reference.mdx +++ b/src/content/docs/waiting-room/api-reference.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: API reference -external_link: /api/operations/waiting-room-list-waiting-rooms +external_link: /api/resources/waiting_rooms/methods/list/ sidebar: order: 10 diff --git a/src/content/docs/waiting-room/how-to/control-user-session.mdx b/src/content/docs/waiting-room/how-to/control-user-session.mdx index cabd0dad68cbf70..7bf8df072ed4328 100644 --- a/src/content/docs/waiting-room/how-to/control-user-session.mdx +++ b/src/content/docs/waiting-room/how-to/control-user-session.mdx @@ -22,7 +22,7 @@ You can limit each user’s time on your site to only one session duration by ch To terminate a user's session when they perform a specific action, you can send a command to the waiting room using an HTTP header on the response from your origin. This command tells the waiting room to revoke the session of the user associated with the current response. This allows spots to open up more dynamically and may increase throughput from your queue. To enable this feature in the Cloudflare Dashboard, check the box next to Allow session termination via origin commands from the dashboard. -To enable this feature through the [Cloudflare API](/api/operations/waiting-room-update-waiting-room), update the `enabled_origin_commands` property to include the value `”revoke”` in the list of enabled origin commands. +To enable this feature through the [Cloudflare API](/api/resources/waiting_rooms/methods/update/), update the `enabled_origin_commands` property to include the value `”revoke”` in the list of enabled origin commands. Then, to return a revocation origin command and revoke the user's session associated with the current request, add the `Cf-Waiting-Room-Command: revoke` HTTP header to the response from your origin. diff --git a/src/content/docs/waiting-room/how-to/create-waiting-room.mdx b/src/content/docs/waiting-room/how-to/create-waiting-room.mdx index 32365e282d14791..baaacd7007baaf5 100644 --- a/src/content/docs/waiting-room/how-to/create-waiting-room.mdx +++ b/src/content/docs/waiting-room/how-to/create-waiting-room.mdx @@ -30,7 +30,7 @@ For additional context on creating a waiting room, refer to [Get started](/waiti -To create a Waiting Room using the API, send a [`POST` request](/api/operations/waiting-room-create-waiting-room) to the `/zones/{zone_identifier}/waiting_rooms` endpoint: +To create a Waiting Room using the API, send a [`POST` request](/api/resources/waiting_rooms/methods/create/) to the `/zones/{zone_identifier}/waiting_rooms` endpoint: - For parameter references, refer to [Configuration settings](/waiting-room/reference/configuration-settings/) - For authentication instructions, refer to [Create an API token](/fundamentals/api/get-started/create-token/). diff --git a/src/content/docs/waiting-room/how-to/customize-waiting-room.mdx b/src/content/docs/waiting-room/how-to/customize-waiting-room.mdx index 23a6ebf8c2bc418..7aa46aab1324f3b 100644 --- a/src/content/docs/waiting-room/how-to/customize-waiting-room.mdx +++ b/src/content/docs/waiting-room/how-to/customize-waiting-room.mdx @@ -98,7 +98,7 @@ The following script within the `` section after `
` fetches the wait #### Available variables -When you create a waiting room with custom HTML, you can have access to several variables to customize your response. For a full list of variables, refer to the `json_response_enabled` parameter in the [Cloudflare API docs](/api/operations/waiting-room-create-waiting-room). +When you create a waiting room with custom HTML, you can have access to several variables to customize your response. For a full list of variables, refer to the `json_response_enabled` parameter in the [Cloudflare API docs](/api/resources/waiting_rooms/methods/create/). #### Multiple-language support @@ -222,7 +222,7 @@ You do not have to have a Cloudflare account to access the preview link, so you ### Preview the default or current waiting room web page -After [generating a preview URL](/api/operations/waiting-room-create-a-custom-waiting-room-page-preview), use the following endpoint to generate a link to preview the currently configured web page for a waiting room, or the default page if no custom page is configured. +After [generating a preview URL](/api/resources/waiting_rooms/subresources/page/methods/preview/), use the following endpoint to generate a link to preview the currently configured web page for a waiting room, or the default page if no custom page is configured. ```txt GET https://waitingrooms.dev/preview/{preview_id} diff --git a/src/content/docs/waiting-room/how-to/json-response.mdx b/src/content/docs/waiting-room/how-to/json-response.mdx index 679969912ecd1cc..1514eaf0dd65c5c 100644 --- a/src/content/docs/waiting-room/how-to/json-response.mdx +++ b/src/content/docs/waiting-room/how-to/json-response.mdx @@ -17,7 +17,7 @@ In order to consume the waiting room response in the JSON format, the following To receive a JSON response, you first need to enable that option in your waiting room. - **Via the dashboard**: When [customizing a waiting room](/waiting-room/how-to/customize-waiting-room/), enable **JSON Response**. -- **Via the API**: When [creating a waiting room](/api/operations/waiting-room-create-waiting-room), set `json_response_enabled` to true. +- **Via the API**: When [creating a waiting room](/api/resources/waiting_rooms/methods/create/), set `json_response_enabled` to true. ## Step 2 – Get JSON data @@ -57,13 +57,13 @@ These are some of the places where the JSON-friendly response can be consumed (t 1. In a mobile app traffic - - **Integrate Waiting Room variables** – Create a new template in your mobile app to receive the JSON response. For a full list of these variables, refer to the `json_response_enabled` parameter in the [Cloudflare API docs](/api/operations/waiting-room-create-waiting-room). + - **Integrate Waiting Room variables** – Create a new template in your mobile app to receive the JSON response. For a full list of these variables, refer to the `json_response_enabled` parameter in the [Cloudflare API docs](/api/resources/waiting_rooms/methods/create/). - **Allow cookies** – As mentioned above, a waiting room [requires cookies](/waiting-room/reference/waiting-room-cookie/), and your mobile app will need to support cookies. For ease of use, consider using a cookie manager like [CookieJar](https://pkg.go.dev/net/http#CookieJar). - **Consume JSON data** - Make a request to the Waiting Room endpoint with the `Accept: application/json` header. 2. Inside Cloudflare Workers (or in your own backend service) - - **Integrate Waiting Room variables** – Expect a JSON response in your backend API. For a full list of these variables, refer to the `json_response_enabled` parameter in the [Cloudflare API docs](/api/operations/waiting-room-create-waiting-room). + - **Integrate Waiting Room variables** – Expect a JSON response in your backend API. For a full list of these variables, refer to the `json_response_enabled` parameter in the [Cloudflare API docs](/api/resources/waiting_rooms/methods/create/). - **Include cookies in the request header** – As mentioned above, a waiting room [requires cookies](/waiting-room/reference/waiting-room-cookie/), and your backend API will need to support cookies. For ease of use, consider using a cookie manager like [CookieJar](https://pkg.go.dev/net/http#CookieJar). - **Enable JSON response** - Via the dashboard or via the API. - **Consume JSON data** - Make a request to the Waiting Room endpoint with the `Accept: application/json` header. diff --git a/src/content/docs/waiting-room/how-to/monitor-waiting-room.mdx b/src/content/docs/waiting-room/how-to/monitor-waiting-room.mdx index 946528dda635ace..d737f92b96f1976 100644 --- a/src/content/docs/waiting-room/how-to/monitor-waiting-room.mdx +++ b/src/content/docs/waiting-room/how-to/monitor-waiting-room.mdx @@ -32,7 +32,7 @@ The **Status** column displays the current state of the waiting room: ## Status in the API -[Check whether traffic is queueing in a configured waiting room](/api/operations/waiting-room-get-waiting-room-status) by appending the following endpoint to the Cloudflare API base URL: +[Check whether traffic is queueing in a configured waiting room](/api/resources/waiting_rooms/subresources/statuses/methods/get/) by appending the following endpoint to the Cloudflare API base URL: ```bash GET zones/{zone_identifier}/waiting_rooms/{identifier}/status @@ -49,7 +49,7 @@ To check whether a configured waiting room is suspended or whether the traffic i GET zones/{zone_identifier}/waiting_rooms/{identifier} ``` -The endpoint above [fetches all settings](/api/operations/waiting-room-waiting-room-details) for a configured waiting room: +The endpoint above [fetches all settings](/api/resources/waiting_rooms/methods/get/) for a configured waiting room: ```bash "success": true, diff --git a/src/content/docs/waiting-room/reference/waiting-room-api.mdx b/src/content/docs/waiting-room/reference/waiting-room-api.mdx index 7af3c4bfbde354e..2bfd960f3456108 100644 --- a/src/content/docs/waiting-room/reference/waiting-room-api.mdx +++ b/src/content/docs/waiting-room/reference/waiting-room-api.mdx @@ -6,11 +6,11 @@ title: API commands Cloudflare Waiting Room redirect visitors to virtual waiting rooms when they are trying to access web pages that have high volumes of traffic. -The [Cloudflare Waiting Room API](/api/operations/waiting-room-list-waiting-rooms) provides an interface for programmatically managing waiting rooms. +The [Cloudflare Waiting Room API](/api/resources/waiting_rooms/methods/list/) provides an interface for programmatically managing waiting rooms. ## Request URL format -To invoke a [Cloudflare Waiting Room API](/api/operations/waiting-room-list-waiting-rooms) operation, append the endpoint to the Cloudflare API base URL: +To invoke a [Cloudflare Waiting Room API](/api/resources/waiting_rooms/methods/list/) operation, append the endpoint to the Cloudflare API base URL: ```shell https://api.cloudflare.com/client/v4 @@ -24,15 +24,15 @@ For help with endpoints and pagination, refer to [Getting Started: Endpoints](/f | Operation | Method + URL stub | Notes | | ------------------------------------------------------------------------- | ------------------------------------------------------------- | ---------------------------------- | -| [List waiting rooms](/api/operations/waiting-room-list-waiting-rooms) | `GET zones/{:zone_identifier}/waiting_rooms` | List all waiting rooms for a zone. | -| [Create waiting room](/api/operations/waiting-room-create-waiting-room) | `POST zones/{:zone_identifier}/waiting_rooms` | Create a waiting room. | -| [Waiting room details](/api/operations/waiting-room-waiting-room-details) | `GET zones/{:zone_identifier}/waiting_rooms/{:identifier}` | Fetch a waiting room. | -| [Update waiting room](/api/operations/waiting-room-update-waiting-room) | `PUT zones/{:zone_identifier}/waiting_rooms/{:identifier}` | Update a waiting room. | -| [Delete waiting room](/api/operations/waiting-room-delete-waiting-room) | `DELETE zones/{:zone_identifier}/waiting_rooms/{:identifier}` | Delete a waiting room. | -| [Patch waiting room](/api/operations/waiting-room-patch-waiting-room) | `PATCH zones/{:zone_identifier}/waiting_rooms/{:identifier}` | Patch a configured waiting room. | +| [List waiting rooms](/api/resources/waiting_rooms/methods/list/) | `GET zones/{:zone_identifier}/waiting_rooms` | List all waiting rooms for a zone. | +| [Create waiting room](/api/resources/waiting_rooms/methods/create/) | `POST zones/{:zone_identifier}/waiting_rooms` | Create a waiting room. | +| [Waiting room details](/api/resources/waiting_rooms/methods/get/) | `GET zones/{:zone_identifier}/waiting_rooms/{:identifier}` | Fetch a waiting room. | +| [Update waiting room](/api/resources/waiting_rooms/methods/update/) | `PUT zones/{:zone_identifier}/waiting_rooms/{:identifier}` | Update a waiting room. | +| [Delete waiting room](/api/resources/waiting_rooms/methods/delete/) | `DELETE zones/{:zone_identifier}/waiting_rooms/{:identifier}` | Delete a waiting room. | +| [Patch waiting room](/api/resources/waiting_rooms/methods/edit/) | `PATCH zones/{:zone_identifier}/waiting_rooms/{:identifier}` | Patch a configured waiting room. | ## Fetch the current status of a waiting room | Operation | Method + URL stub | Notes | | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [Get the current status of a waiting room](/api/operations/waiting-room-get-waiting-room-status) | `GET zones/{:zone_identifier}/waiting_rooms/{:identifier}/status` |
  • Returns queueing if the queue is activated (clients are put in the waiting room).
  • Returns not\_queueing if the queue is not activated or if the waiting room is suspended.
| +| [Get the current status of a waiting room](/api/resources/waiting_rooms/subresources/statuses/methods/get/) | `GET zones/{:zone_identifier}/waiting_rooms/{:identifier}/status` |
  • Returns queueing if the queue is activated (clients are put in the waiting room).
  • Returns not\_queueing if the queue is not activated or if the waiting room is suspended.
| diff --git a/src/content/docs/web3/api-reference.mdx b/src/content/docs/web3/api-reference.mdx index 9b4a3797096f2e9..d9540c74123fbde 100644 --- a/src/content/docs/web3/api-reference.mdx +++ b/src/content/docs/web3/api-reference.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: API reference -external_link: /api/operations/web3-hostname-list-web3-hostnames +external_link: /api/resources/web3/subresources/hostnames/methods/list/ sidebar: order: 6 diff --git a/src/content/docs/web3/how-to/manage-gateways.mdx b/src/content/docs/web3/how-to/manage-gateways.mdx index 5be379ee9257f0f..a67b70e0f4331a4 100644 --- a/src/content/docs/web3/how-to/manage-gateways.mdx +++ b/src/content/docs/web3/how-to/manage-gateways.mdx @@ -44,7 +44,7 @@ To edit a gateway using the dashboard: -To edit specific settings for a gateway, use a [`PATCH`](/api/operations/web3-hostname-edit-web3-hostname) request. +To edit specific settings for a gateway, use a [`PATCH`](/api/resources/web3/subresources/hostnames/methods/edit/) request. @@ -65,7 +65,7 @@ To refresh a gateway using the dashboard: -To refresh a gateway using the API, send a [`PATCH`](/api/operations/web3-hostname-edit-web3-hostname) request with an empty request body. +To refresh a gateway using the API, send a [`PATCH`](/api/resources/web3/subresources/hostnames/methods/edit/) request with an empty request body. @@ -105,7 +105,7 @@ To add an item to the blocklist using the dashboard: -To add a blocklist item using the API, send a [`POST`](/api/operations/web3-hostname-create-ipfs-universal-path-gateway-content-list-entry) request. +To add a blocklist item using the API, send a [`POST`](/api/resources/web3/subresources/hostnames/subresources/ipfs_universal_paths/subresources/content_lists/subresources/entries/methods/create/) request. @@ -127,6 +127,6 @@ To delete a gateway using the dashboard: -To delete a gateway using the API, send a [`DELETE`](/api/operations/web3-hostname-delete-web3-hostname) request. +To delete a gateway using the API, send a [`DELETE`](/api/resources/web3/subresources/hostnames/methods/delete/) request. diff --git a/src/content/docs/workers-ai/api-reference.mdx b/src/content/docs/workers-ai/api-reference.mdx index dda4940e77ada11..46ad6a45d505d20 100644 --- a/src/content/docs/workers-ai/api-reference.mdx +++ b/src/content/docs/workers-ai/api-reference.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: REST API reference -external_link: /api/operations/workers-ai-post-run-model +external_link: /api/resources/ai/methods/run/ sidebar: order: 9 diff --git a/src/content/docs/workers-ai/get-started/rest-api.mdx b/src/content/docs/workers-ai/get-started/rest-api.mdx index 2268fd11d306c08..b1fba16cc6131a0 100644 --- a/src/content/docs/workers-ai/get-started/rest-api.mdx +++ b/src/content/docs/workers-ai/get-started/rest-api.mdx @@ -42,7 +42,7 @@ If you choose to [create an API token](/fundamentals/api/get-started/create-toke After creating your API token, authenticate and make requests to the API using your API token in the request. -You will use the [Execute AI model](/api/operations/workers-ai-post-run-model) endpoint to run the [`@cf/meta/llama-3.1-8b-instruct`](/workers-ai/models/llama-3.1-8b-instruct/) model: +You will use the [Execute AI model](/api/resources/ai/methods/run/) endpoint to run the [`@cf/meta/llama-3.1-8b-instruct`](/workers-ai/models/llama-3.1-8b-instruct/) model: ```bash curl https://api.cloudflare.com/client/v4/accounts/{ACCOUNT_ID}/ai/run/@cf/meta/llama-3.1-8b-instruct \ diff --git a/src/content/docs/workers-ai/index.mdx b/src/content/docs/workers-ai/index.mdx index 2b4647abe35c0fb..fe961c81434031f 100644 --- a/src/content/docs/workers-ai/index.mdx +++ b/src/content/docs/workers-ai/index.mdx @@ -20,7 +20,7 @@ Run machine learning models, powered by serverless GPUs, on Cloudflare's global -Workers AI allows you to run machine learning models, on the Cloudflare network, from your own code -- whether that be from [Workers](/workers/), [Pages](/pages/), or anywhere via [the Cloudflare API](/api/operations/workers-ai-post-run-model). +Workers AI allows you to run machine learning models, on the Cloudflare network, from your own code -- whether that be from [Workers](/workers/), [Pages](/pages/), or anywhere via [the Cloudflare API](/api/resources/ai/methods/run/). With the launch of Workers AI, Cloudflare is rolling out GPUs to its global network. This enables you to build and deploy ambitious AI applications that run near your users, wherever they are. diff --git a/src/content/docs/workers/configuration/compatibility-dates.mdx b/src/content/docs/workers/configuration/compatibility-dates.mdx index 85928ed9c42382a..a546a44d6028738 100644 --- a/src/content/docs/workers/configuration/compatibility-dates.mdx +++ b/src/content/docs/workers/configuration/compatibility-dates.mdx @@ -44,6 +44,6 @@ The compatibility date can be updated in the Workers settings on the [Cloudflare #### Via the Cloudflare API -The compatibility date can be set when uploading a Worker using the [Workers Script API](/api/operations/worker-script-upload-worker-module) or [Workers Versions API](/api/operations/worker-versions-upload-version#request-body) in the request body's `metadata` field. +The compatibility date can be set when uploading a Worker using the [Workers Script API](/api/resources/workers/subresources/scripts/methods/update/) or [Workers Versions API](/api/resources/workers/subresources/scripts/subresources/versions/methods/create/#request-body) in the request body's `metadata` field. If a compatibility date is not specified on upload via the API, it defaults to the oldest compatibility date, before any flags took effect (2021-11-02). When creating new Workers, it is highly recommended to set the compatibility date to the current date when uploading via the API. diff --git a/src/content/docs/workers/configuration/compatibility-flags.mdx b/src/content/docs/workers/configuration/compatibility-flags.mdx index 4fe2381c8ed0ba9..e6893487ef39289 100644 --- a/src/content/docs/workers/configuration/compatibility-flags.mdx +++ b/src/content/docs/workers/configuration/compatibility-flags.mdx @@ -41,7 +41,7 @@ Compatibility flags can be updated in the Workers settings on the [Cloudflare da #### Via the Cloudflare API -Compatibility flags can be set when uploading a Worker using the [Workers Script API](/api/operations/worker-script-upload-worker-module) or [Workers Versions API](/api/operations/worker-versions-upload-version#request-body) in the request body's `metadata` field. +Compatibility flags can be set when uploading a Worker using the [Workers Script API](/api/resources/workers/subresources/scripts/methods/update/) or [Workers Versions API](/api/resources/workers/subresources/scripts/subresources/versions/methods/create/#request-body) in the request body's `metadata` field. ## Node.js compatibility flag diff --git a/src/content/docs/workers/configuration/multipart-upload-metadata.mdx b/src/content/docs/workers/configuration/multipart-upload-metadata.mdx index 2905f2758dfad69..db3b044f54fcfc8 100644 --- a/src/content/docs/workers/configuration/multipart-upload-metadata.mdx +++ b/src/content/docs/workers/configuration/multipart-upload-metadata.mdx @@ -6,7 +6,7 @@ title: Multipart upload metadata import { Type, MetaInfo } from "~/components"; -If you're using the [Workers Script Upload API](/api/operations/worker-script-upload-worker-module) or [Version Upload API](/api/operations/worker-versions-upload-version) directly, `multipart/form-data` uploads require you to specify a `metadata` part. This metadata defines the Worker's configuration in JSON format, analogue to the [wrangler.toml file](/workers/wrangler/configuration/). +If you're using the [Workers Script Upload API](/api/resources/workers/subresources/scripts/methods/update/) or [Version Upload API](/api/resources/workers/subresources/scripts/subresources/versions/methods/create/) directly, `multipart/form-data` uploads require you to specify a `metadata` part. This metadata defines the Worker's configuration in JSON format, analogue to the [wrangler.toml file](/workers/wrangler/configuration/). ## Sample `metadata` @@ -74,7 +74,7 @@ At a minimum, the `main_module` key is required to upload a Worker. -## Additional attributes: [Workers Script Upload API](/api/operations/worker-script-upload-worker-module) +## Additional attributes: [Workers Script Upload API](/api/resources/workers/subresources/scripts/methods/update/) For [immediately deployed uploads](/workers/configuration/versions-and-deployments/#upload-a-new-version-and-deploy-it-immediately), the following **additional** attributes are configurable at the top-level. @@ -103,7 +103,7 @@ These attributes are **not available** for version uploads. -## Additional attributes: [Version Upload API](/api/operations/worker-versions-upload-version) +## Additional attributes: [Version Upload API](/api/resources/workers/subresources/scripts/subresources/versions/methods/create/) For [version uploads](/workers/configuration/versions-and-deployments/#upload-a-new-version-to-be-gradually-deployed-or-deployed-at-a-later-time), the following **additional** attributes are configurable at the top-level. diff --git a/src/content/docs/workers/configuration/routing/custom-domains.mdx b/src/content/docs/workers/configuration/routing/custom-domains.mdx index 3dc535f98dfe721..b84a05ded426afb 100644 --- a/src/content/docs/workers/configuration/routing/custom-domains.mdx +++ b/src/content/docs/workers/configuration/routing/custom-domains.mdx @@ -25,7 +25,7 @@ To add a Custom Domain, you must have: 1. An [active Cloudflare zone](/dns/zone-setups/). 2. A Worker to invoke. -Custom Domains can be attached to your Worker via the [Cloudflare dashboard](/workers/configuration/routing/custom-domains/#set-up-a-custom-domain-in-the-dashboard), [Wrangler](/workers/configuration/routing/custom-domains/#set-up-a-custom-domain-in-your-wranglertoml) or the [API](/api/operations/worker-domain-list-domains). +Custom Domains can be attached to your Worker via the [Cloudflare dashboard](/workers/configuration/routing/custom-domains/#set-up-a-custom-domain-in-the-dashboard), [Wrangler](/workers/configuration/routing/custom-domains/#set-up-a-custom-domain-in-your-wranglertoml) or the [API](/api/resources/workers/subresources/domains/methods/list/). :::caution diff --git a/src/content/docs/workers/configuration/routing/routes.mdx b/src/content/docs/workers/configuration/routing/routes.mdx index 412a92a0ec11f0a..7921cec192a66a9 100644 --- a/src/content/docs/workers/configuration/routing/routes.mdx +++ b/src/content/docs/workers/configuration/routing/routes.mdx @@ -32,7 +32,7 @@ If your Worker is not your application's origin, follow the instructions below t :::note -Routes can also be created via the API. Refer to the [Workers Routes API documentation](/api/operations/worker-routes-create-route) for more information. +Routes can also be created via the API. Refer to the [Workers Routes API documentation](/api/resources/workers/subresources/routes/methods/create/) for more information. ::: ### Set up a route in the dashboard diff --git a/src/content/docs/workers/configuration/versions-and-deployments/gradual-deployments.mdx b/src/content/docs/workers/configuration/versions-and-deployments/gradual-deployments.mdx index 492d8ed1ada5d14..2d597e94efa313d 100644 --- a/src/content/docs/workers/configuration/versions-and-deployments/gradual-deployments.mdx +++ b/src/content/docs/workers/configuration/versions-and-deployments/gradual-deployments.mdx @@ -238,7 +238,7 @@ When using gradual deployments, you may want to attribute Workers invocations to ### Logpush -A new `ScriptVersion` object is available in [Workers Logpush](/workers/observability/logs/logpush/). `ScriptVersion` can only be added through the [Logpush API](/api/operations/post-accounts-account_identifier-logpush-jobs) right now. Sample API call: +A new `ScriptVersion` object is available in [Workers Logpush](/workers/observability/logs/logpush/). `ScriptVersion` can only be added through the Logpush API right now. Sample API call: ```bash curl -X POST 'https://api.cloudflare.com/client/v4/accounts//logpush/jobs' \ diff --git a/src/content/docs/workers/configuration/versions-and-deployments/index.mdx b/src/content/docs/workers/configuration/versions-and-deployments/index.mdx index cf835f30578db90..f2043eee4692c5d 100644 --- a/src/content/docs/workers/configuration/versions-and-deployments/index.mdx +++ b/src/content/docs/workers/configuration/versions-and-deployments/index.mdx @@ -55,7 +55,7 @@ A new version that is automatically deployed to 100% of traffic when: - Changes are uploaded with [`wrangler deploy`](/workers/wrangler/commands/#deploy) via the Cloudflare Dashboard - Changes are deployed with the command [`npx wrangler deploy`](/workers/wrangler/commands/#deploy) via [Workers Builds](/workers/ci-cd/builds) -- Changes are uploaded with the [Workers Script Upload API](/api/operations/worker-script-upload-worker-module) +- Changes are uploaded with the [Workers Script Upload API](/api/resources/workers/subresources/scripts/methods/update/) #### Upload a new version to be gradually deployed or deployed at a later time diff --git a/src/content/docs/workers/platform/limits.mdx b/src/content/docs/workers/platform/limits.mdx index d45cadbdaa22c9d..05475e11b9ed25e 100644 --- a/src/content/docs/workers/platform/limits.mdx +++ b/src/content/docs/workers/platform/limits.mdx @@ -266,7 +266,7 @@ Note that larger Worker bundles can impact the start-up time of the Worker, as t A Worker must be able to be parsed and execute its global scope (top-level code outside of any handlers) within 400 ms. Worker size can impact startup because there is more code to parse and evaluate. Avoiding expensive code in the global scope can keep startup efficient as well. -You can measure your Worker's startup time by deploying it to Cloudflare using [Wrangler](/workers/wrangler/). When you run `npx wrangler@latest deploy` or `npx wrangler@latest versions upload`, Wrangler will output the startup time of your Worker in the command-line output, using the `startup_time_ms` field in the [Workers Script API](/api/operations/worker-script-upload-worker-module) or [Workers Versions API](/api/operations/worker-versions-upload-version#request-body). +You can measure your Worker's startup time by deploying it to Cloudflare using [Wrangler](/workers/wrangler/). When you run `npx wrangler@latest deploy` or `npx wrangler@latest versions upload`, Wrangler will output the startup time of your Worker in the command-line output, using the `startup_time_ms` field in the [Workers Script API](/api/resources/workers/subresources/scripts/methods/update/) or [Workers Versions API](/api/resources/workers/subresources/scripts/subresources/versions/methods/create/#request-body). If you are having trouble staying under this limit, consider [profiling using DevTools](/workers/observability/dev-tools/) locally to learn how to optimize your code. diff --git a/src/content/docs/workers/static-assets/direct-upload.mdx b/src/content/docs/workers/static-assets/direct-upload.mdx index ffb248d2d60f8db..be37acf487b6f6b 100644 --- a/src/content/docs/workers/static-assets/direct-upload.mdx +++ b/src/content/docs/workers/static-assets/direct-upload.mdx @@ -44,7 +44,7 @@ The asset upload flow can be distilled into three distinct phases: The asset manifest is a ledger which keeps track of files we want to use in our Worker. This manifest is used to track assets associated with each Worker version, and eliminate the need to upload unchanged files prior to a new upload. -The [manifest upload request](/api/operations/worker-script-update-create-assets-upload-session) describes each file which we intend to upload. Each file is its own key representing the file path and name, and is an object which contains metadata about the file. +The [manifest upload request](/api/resources/workers/subresources/scripts/subresources/assets/subresources/upload/methods/create/) describes each file which we intend to upload. Each file is its own key representing the file path and name, and is an object which contains metadata about the file. `hash` represents a 32 hexadecimal character hash of the file, while `size` is the size (in bytes) of the file. @@ -102,7 +102,7 @@ If all assets have been previously uploaded, `buckets` will be empty, and `jwt` ## Upload Static Assets -The [file upload API](/api/operations/worker-assets-upload) requires files be uploaded using `multipart/form-data`. The contents of each file must be base64 encoded, and the `base64` query parameter in the URL must be set to `true`. +The [file upload API](/api/resources/workers/subresources/assets/subresources/upload/methods/create/) requires files be uploaded using `multipart/form-data`. The contents of each file must be base64 encoded, and the `base64` query parameter in the URL must be set to `true`. The `Authorization` header must be provided as a bearer token, using the JWT (upload token) from the aforementioned manifest upload call. @@ -110,7 +110,7 @@ Once every file in the manifest has been uploaded, a status code of 201 will be ## Create/Deploy New Version -[Script](/api/operations/worker-script-upload-worker-module) and [version](/api/operations/worker-versions-upload-version) upload endpoints require specifying a metadata part in the form data. Here, we can provide the completion token from the previous (upload assets) step. +[Script](/api/resources/workers/subresources/scripts/methods/update/) and [version](/api/resources/workers/subresources/scripts/subresources/versions/methods/create/) upload endpoints require specifying a metadata part in the form data. Here, we can provide the completion token from the previous (upload assets) step. ```bash title="Example Worker Metadata Specifying Completion Token" { diff --git a/src/content/docs/workers/wrangler/commands.mdx b/src/content/docs/workers/wrangler/commands.mdx index 0b94099f87abec8..2d1fa95fed7411b 100644 --- a/src/content/docs/workers/wrangler/commands.mdx +++ b/src/content/docs/workers/wrangler/commands.mdx @@ -951,7 +951,7 @@ wrangler r2 bucket lifecycle set [OPTIONS] - `NAME` - The name of the R2 bucket to set lifecycle configuration for. - `--file` - - Path to the JSON file containing lifecycle configuration (file must be in format of request body of [put object lifecycle configuration API](/api/operations/r2-put-bucket-lifecycle-configuration)). + - Path to the JSON file containing lifecycle configuration (file must be in format of request body of [put object lifecycle configuration API](/api/resources/r2/subresources/buckets/subresources/lifecycle/methods/update/)). - `--jurisdiction` - The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to [jurisdictional restrictions](/r2/reference/data-location/#jurisdictional-restrictions). diff --git a/src/content/docs/workers/wrangler/migration/v1-to-v2/wrangler-legacy/commands.mdx b/src/content/docs/workers/wrangler/migration/v1-to-v2/wrangler-legacy/commands.mdx index bb44e288340cdd9..1bde5691dd8962f 100644 --- a/src/content/docs/workers/wrangler/migration/v1-to-v2/wrangler-legacy/commands.mdx +++ b/src/content/docs/workers/wrangler/migration/v1-to-v2/wrangler-legacy/commands.mdx @@ -352,7 +352,7 @@ Default values indicated by =value. - `--env $ENVIRONMENT_NAME` optional - If defined, the changes will only apply to the specified environment. Refer to [Environments](/workers/wrangler/environments/) for more information. -This command will forward the JSON response from the [List Routes API](/api/operations/worker-routes-list-routes). Each object within the JSON list will include the route id, route pattern, and the assigned Worker name for the route. Piping this through a tool such as `jq` will render the output nicely. +This command will forward the JSON response from the [List Routes API](/api/resources/workers/subresources/routes/methods/list/). Each object within the JSON list will include the route id, route pattern, and the assigned Worker name for the route. Piping this through a tool such as `jq` will render the output nicely. ```sh wrangler route delete $ID [--env $ENVIRONMENT_NAME] diff --git a/src/content/docs/workflows/build/trigger-workflows.mdx b/src/content/docs/workflows/build/trigger-workflows.mdx index 5109bc870d313ec..1284ac5865efdf4 100644 --- a/src/content/docs/workflows/build/trigger-workflows.mdx +++ b/src/content/docs/workflows/build/trigger-workflows.mdx @@ -9,7 +9,7 @@ sidebar: You can trigger Workflows both programmatically and via the Workflows APIs, including: 1. With [Workers](/workers) via HTTP requests in a `fetch` handler, or bindings from a `queue` or `scheduled` handler -2. Using the [Workflows REST API](/api/operations/wor-list-workflows) +2. Using the [Workflows REST API](/api/resources/workflows/methods/list/) 2. Via the [wrangler CLI](/workers/wrangler/commands/#workflows) in your terminal ## Workers API (Bindings) @@ -170,7 +170,7 @@ Restarting an instance will immediately cancel any in-progress steps, erase any ## REST API (HTTP) -Refer to the [Workflows REST API documentation](/api/operations/wor-create-new-workflow-instance). +Refer to the [Workflows REST API documentation](/api/resources/workflows/subresources/instances/methods/create/). ## Command line (CLI) diff --git a/src/content/docs/workflows/get-started/cli-quick-start.mdx b/src/content/docs/workflows/get-started/cli-quick-start.mdx index f6eac46158a063c..1b85f9a464261e6 100644 --- a/src/content/docs/workflows/get-started/cli-quick-start.mdx +++ b/src/content/docs/workflows/get-started/cli-quick-start.mdx @@ -155,7 +155,7 @@ npx wrangler@latest deploy ## 3. Run a Workflow -You can run a Workflow via the `wrangler` CLI, via a Worker binding, or via the Workflows [REST API](/api/operations/wor-list-workflows). +You can run a Workflow via the `wrangler` CLI, via a Worker binding, or via the Workflows [REST API](/api/resources/workflows/methods/list/). ### `wrangler` CLI diff --git a/src/content/docs/workflows/get-started/guide.mdx b/src/content/docs/workflows/get-started/guide.mdx index 47a0d729fa21f92..9852d70ca591394 100644 --- a/src/content/docs/workflows/get-started/guide.mdx +++ b/src/content/docs/workflows/get-started/guide.mdx @@ -221,7 +221,7 @@ We have a very basic Workflow definition, but now need to provide a way to call 1. External HTTP requests via a `fetch()` handler 2. Messages from a [Queue](/queues/) 3. A schedule via [Cron Trigger](/workers/configuration/cron-triggers/) -4. Via the [Workflows REST API](/api/operations/wor-list-workflows) or [wrangler CLI](/workers/wrangler/commands/#workflows) +4. Via the [Workflows REST API](/api/resources/workflows/methods/list/) or [wrangler CLI](/workers/wrangler/commands/#workflows) Return to the `src/index.ts` file we created in the previous step and add a `fetch` handler that _binds_ to our Workflow. This binding allows us to create new Workflow instances, fetch the status of an existing Workflow, pause and/or terminate a Workflow. diff --git a/src/content/docs/workflows/workflows-api.mdx b/src/content/docs/workflows/workflows-api.mdx index 5befbd93331dff1..7855d0795310d95 100644 --- a/src/content/docs/workflows/workflows-api.mdx +++ b/src/content/docs/workflows/workflows-api.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: navigation title: Workflows REST API -external_link: /api/operations/wor-list-workflows +external_link: /api/resources/workflows/methods/list/ sidebar: order: 10 diff --git a/src/content/notifications/index.yaml b/src/content/notifications/index.yaml index a658c642a5bf015..ba5385bfc3cb597 100644 --- a/src/content/notifications/index.yaml +++ b/src/content/notifications/index.yaml @@ -544,7 +544,7 @@ entries: associatedProducts: Web Application Firewall (WAF) nextSteps: Review the information in [Security Events](/waf/analytics/security-events/paid-plans/) to identify any possible attack or misconfiguration. otherFilters: |- - A mandatory [`filters`](/api/operations/notification-policies-create-a-notification-policy) selection is needed when you create a notification policy which includes the list of services and zones that you want to be alerted on. + A mandatory [`filters`](/api/resources/alerting/subresources/policies/methods/create/) selection is needed when you create a notification policy which includes the list of services and zones that you want to be alerted on. * You can search for and add domains from your list of Enterprise zones. * You can choose which services the alert should monitor (Managed Firewall, Rate Limiting, etc.). @@ -564,7 +564,7 @@ entries: associatedProducts: Web Application Firewall (WAF) nextSteps: Review the information in [Security Events](/waf/analytics/security-events/paid-plans/) to identify any possible attack or misconfiguration. otherFilters: |- - A mandatory [`filters`](/api/operations/notification-policies-create-a-notification-policy) selection is needed when you create a notification policy which includes the list of zones that you want to be alerted on. + A mandatory [`filters`](/api/resources/alerting/subresources/policies/methods/create/) selection is needed when you create a notification policy which includes the list of zones that you want to be alerted on. * You can also search for and add domains from your list of business or enterprise zones. The notification will be sent for the domains chosen. * You can filter events by a targeted action. diff --git a/src/content/partials/ai-gateway/create-gateway.mdx b/src/content/partials/ai-gateway/create-gateway.mdx index df350ee44e91c5c..f7d2484fc5002ca 100644 --- a/src/content/partials/ai-gateway/create-gateway.mdx +++ b/src/content/partials/ai-gateway/create-gateway.mdx @@ -25,6 +25,6 @@ To set up an AI Gateway using the API: 2. Get your [Account ID](/fundamentals/setup/find-account-and-zone-ids/). -3. Using that API token and Account ID, send a [`POST` request](/api/operations/aig-config-create-gateway) to the Cloudflare API. +3. Using that API token and Account ID, send a [`POST` request](/api/resources/ai_gateway/methods/create/) to the Cloudflare API. diff --git a/src/content/partials/ai-gateway/delete-gateway.mdx b/src/content/partials/ai-gateway/delete-gateway.mdx index 4bdeb2acd120e1b..1b62159dc76c2ac 100644 --- a/src/content/partials/ai-gateway/delete-gateway.mdx +++ b/src/content/partials/ai-gateway/delete-gateway.mdx @@ -16,6 +16,6 @@ To delete an AI Gateway in the dashboard: -To delete an AI Gateway, send a [`DELETE` request](/api/operations/aig-config-delete-gateway) to the Cloudflare API. +To delete an AI Gateway, send a [`DELETE` request](/api/resources/ai_gateway/methods/delete/) to the Cloudflare API. diff --git a/src/content/partials/ai-gateway/edit-gateway.mdx b/src/content/partials/ai-gateway/edit-gateway.mdx index 8ce59bc7d8a0030..36339804d4504d6 100644 --- a/src/content/partials/ai-gateway/edit-gateway.mdx +++ b/src/content/partials/ai-gateway/edit-gateway.mdx @@ -15,6 +15,6 @@ To edit an AI Gateway in the dashboard: -To edit an AI Gateway, send a [`PUT` request](/api/operations/aig-config-update-gateway) to the Cloudflare API. +To edit an AI Gateway, send a [`PUT` request](/api/resources/ai_gateway/methods/update/) to the Cloudflare API. diff --git a/src/content/partials/bots/disable-cf-bm-cookie.mdx b/src/content/partials/bots/disable-cf-bm-cookie.mdx index 1e172151993cd4d..8a81bb83eb52118 100644 --- a/src/content/partials/bots/disable-cf-bm-cookie.mdx +++ b/src/content/partials/bots/disable-cf-bm-cookie.mdx @@ -3,7 +3,7 @@ --- -You can begin the process of disabling the `__cf_bm` cookie [via the API](/api/operations/bot-management-for-a-zone-update-config). To fully disable the cookie, contact customer support. +You can begin the process of disabling the `__cf_bm` cookie [via the API](/api/resources/bot_management/methods/update/). To fully disable the cookie, contact customer support. :::note diff --git a/src/content/partials/cloudflare-for-platforms/create-custom-hostname-api.mdx b/src/content/partials/cloudflare-for-platforms/create-custom-hostname-api.mdx index 64300f8204afbbc..c72ac1bf7f7c156 100644 --- a/src/content/partials/cloudflare-for-platforms/create-custom-hostname-api.mdx +++ b/src/content/partials/cloudflare-for-platforms/create-custom-hostname-api.mdx @@ -3,10 +3,10 @@ --- -1. To create a custom hostname using the API, use the [Create Custom Hostname](/api/operations/custom-hostname-for-a-zone-create-custom-hostname) endpoint. +1. To create a custom hostname using the API, use the [Create Custom Hostname](/api/resources/custom_hostnames/methods/create/) endpoint. * You can leave the `certificate_authority` parameter empty to set it to "default CA". With this option, Cloudflare checks the CAA records before requesting the certificates, which helps ensure the certificates can be issued from the CA. -2. For the newly created custom hostname, the `POST` response may not return the DCV validation token `validation_records`. It is recommended to make a second [`GET` command](/api/operations/custom-hostname-for-a-zone-list-custom-hostnames) (with a delay) to retrieve these details. +2. For the newly created custom hostname, the `POST` response may not return the DCV validation token `validation_records`. It is recommended to make a second [`GET` command](/api/resources/custom_hostnames/methods/list/) (with a delay) to retrieve these details. The response contains the complete definition of the new custom hostname. diff --git a/src/content/partials/cloudflare-for-platforms/get-started-fallback-origin.mdx b/src/content/partials/cloudflare-for-platforms/get-started-fallback-origin.mdx index 56ecc43d9d3b272..c29011ac34c651f 100644 --- a/src/content/partials/cloudflare-for-platforms/get-started-fallback-origin.mdx +++ b/src/content/partials/cloudflare-for-platforms/get-started-fallback-origin.mdx @@ -36,7 +36,7 @@ To create your fallback origin: -Using the hostname of the record you just created, [update the fallback origin value](/api/operations/custom-hostname-fallback-origin-for-a-zone-update-fallback-origin-for-custom-hostnames). +Using the hostname of the record you just created, [update the fallback origin value](/api/resources/custom_hostnames/subresources/fallback_origin/methods/update/). diff --git a/src/content/partials/cloudflare-for-platforms/ssl-for-saas-validate-patch.mdx b/src/content/partials/cloudflare-for-platforms/ssl-for-saas-validate-patch.mdx index 116959e1c635981..86394cc77e6b615 100644 --- a/src/content/partials/cloudflare-for-platforms/ssl-for-saas-validate-patch.mdx +++ b/src/content/partials/cloudflare-for-platforms/ssl-for-saas-validate-patch.mdx @@ -3,4 +3,4 @@ --- -If you would like to request an immediate recheck, [rather than wait for the next retry](/ssl/edge-certificates/changing-dcv-method/validation-backoff-schedule/), send a [PATCH request](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname) with the same values as your initial `POST` request. +If you would like to request an immediate recheck, [rather than wait for the next retry](/ssl/edge-certificates/changing-dcv-method/validation-backoff-schedule/), send a [PATCH request](/api/resources/custom_hostnames/methods/edit/) with the same values as your initial `POST` request. diff --git a/src/content/partials/cloudflare-for-platforms/txt-validation_api.mdx b/src/content/partials/cloudflare-for-platforms/txt-validation_api.mdx index e1fbeee37a3fa1c..37093f6529689dd 100644 --- a/src/content/partials/cloudflare-for-platforms/txt-validation_api.mdx +++ b/src/content/partials/cloudflare-for-platforms/txt-validation_api.mdx @@ -3,7 +3,7 @@ --- -You can access these tokens using the API with the [`GET` custom hostnames endpoint](/api/operations/custom-hostname-for-a-zone-list-custom-hostnames). +You can access these tokens using the API with the [`GET` custom hostnames endpoint](/api/resources/custom_hostnames/methods/list/). For example, here are two tokens highlighted in the API response for a **wildcard** custom hostname. diff --git a/src/content/partials/cloudflare-for-platforms/update-dcv-method.mdx b/src/content/partials/cloudflare-for-platforms/update-dcv-method.mdx index 86cf5b815c26bec..62c3d6a6525d69f 100644 --- a/src/content/partials/cloudflare-for-platforms/update-dcv-method.mdx +++ b/src/content/partials/cloudflare-for-platforms/update-dcv-method.mdx @@ -3,4 +3,4 @@ --- -If your hostname is using another validation method, you will need to [update](/api/operations/custom-hostname-for-a-zone-edit-custom-hostname) the `"method"` field in the SSL object to be `"txt"`. +If your hostname is using another validation method, you will need to [update](/api/resources/custom_hostnames/methods/edit/) the `"method"` field in the SSL object to be `"txt"`. diff --git a/src/content/partials/cloudflare-one/access/access-group.mdx b/src/content/partials/cloudflare-one/access/access-group.mdx index d14bbf87432dd5b..1e47c15d267b848 100644 --- a/src/content/partials/cloudflare-one/access/access-group.mdx +++ b/src/content/partials/cloudflare-one/access/access-group.mdx @@ -24,7 +24,7 @@ To create an Access group: -Send a `POST` request to the [`/access/groups`](/api/operations/access-groups-create-an-access-group) endpoint: +Send a `POST` request to the [`/access/groups`](/api/resources/zero_trust/subresources/access/subresources/groups/methods/create/) endpoint: ```bash curl https://api.cloudflare.com/client/v4/accounts/{account_id}/access/groups \ diff --git a/src/content/partials/cloudflare-one/access/add-infrastructure-app.mdx b/src/content/partials/cloudflare-one/access/add-infrastructure-app.mdx index 6fca6b29e89ba9f..b92bf8e2e22d3d6 100644 --- a/src/content/partials/cloudflare-one/access/add-infrastructure-app.mdx +++ b/src/content/partials/cloudflare-one/access/add-infrastructure-app.mdx @@ -38,7 +38,7 @@ import { Tabs, TabItem, Render } from "~/components" | ------- | ---------------- | ---------- | | Account | Access: Apps & Policies | Edit | -2. Make a `POST` request to the [Access applications](/api/operations/access-applications-add-an-application) endpoint: +2. Make a `POST` request to the [Access applications](/api/resources/zero_trust/subresources/access/subresources/applications/methods/create/) endpoint: ```sh curl https://api.cloudflare.com/client/v4/accounts/{account_id}/access/apps \ diff --git a/src/content/partials/cloudflare-one/access/add-target.mdx b/src/content/partials/cloudflare-one/access/add-target.mdx index a3d1697c88b18a1..3bb27b93a9ebb31 100644 --- a/src/content/partials/cloudflare-one/access/add-target.mdx +++ b/src/content/partials/cloudflare-one/access/add-target.mdx @@ -34,7 +34,7 @@ To create a new target: | ------- | ---------------- | ---------- | | Account | Zero Trust | Edit | -2. Make a `POST` request to the [Infrastructure Access Targets](/api/operations/infra-targets-post) endpoint: +2. Make a `POST` request to the [Infrastructure Access Targets](/api/resources/zero_trust/subresources/access/subresources/infrastructure/subresources/targets/methods/create/) endpoint: ```sh curl https://api.cloudflare.com/client/v4/accounts/{account_id}/infrastructure/targets \ diff --git a/src/content/partials/cloudflare-one/gateway/order-of-enforcement.mdx b/src/content/partials/cloudflare-one/gateway/order-of-enforcement.mdx index c1de7d9dacbd7d2..62935f9244606f5 100644 --- a/src/content/partials/cloudflare-one/gateway/order-of-enforcement.mdx +++ b/src/content/partials/cloudflare-one/gateway/order-of-enforcement.mdx @@ -139,7 +139,7 @@ Lastly, Gateway evaluates all Allow, Block, and Do Not Scan policies. These poli :::caution[Terraform precedence limitation] -To avoid conflicts, Terraform applies a hash calculation to precedences. For example, a precedence of `1000` may become `1000901`. This can cause errors when reordering policies. To avoid this issue, manually set the precedence of your policies via the [Cloudflare API](/api/operations/zero-trust-gateway-rules-update-zero-trust-gateway-rule). +To avoid conflicts, Terraform applies a hash calculation to precedences. For example, a precedence of `1000` may become `1000901`. This can cause errors when reordering policies. To avoid this issue, manually set the precedence of your policies via the [Cloudflare API](/api/resources/zero_trust/subresources/gateway/subresources/rules/methods/update/). ::: ## Example diff --git a/src/content/partials/cloudflare-one/upload-mtls-cert.mdx b/src/content/partials/cloudflare-one/upload-mtls-cert.mdx index 0517c47bbda6d82..53f372bf29a906b 100644 --- a/src/content/partials/cloudflare-one/upload-mtls-cert.mdx +++ b/src/content/partials/cloudflare-one/upload-mtls-cert.mdx @@ -5,7 +5,7 @@ inputParameters: param1 import { Markdown } from "~/components" -Use the [Upload mTLS certificate endpoint](/api/operations/m-tls-certificate-management-upload-m-tls-certificate) to upload the certificate and private key to Cloudflare. The certificate must be a root CA, formatted as a single string with `\n` replacing the line breaks. {props.one} +Use the [Upload mTLS certificate endpoint](/api/resources/mtls_certificates/methods/create/) to upload the certificate and private key to Cloudflare. The certificate must be a root CA, formatted as a single string with `\n` replacing the line breaks. {props.one} ```bash curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/mtls_certificates" \ diff --git a/src/content/partials/dns/api-field-definitions.mdx b/src/content/partials/dns/api-field-definitions.mdx index 7c4667be780c735..af7ea90d28101b2 100644 --- a/src/content/partials/dns/api-field-definitions.mdx +++ b/src/content/partials/dns/api-field-definitions.mdx @@ -3,4 +3,4 @@ --- -For field definitions, refer to the [API documentation](/api/operations/dns-records-for-a-zone-create-dns-record) (visible once you select the record type under the request body specification). +For field definitions, refer to the [API documentation](/api/resources/dns/subresources/records/methods/create/) (visible once you select the record type under the request body specification). diff --git a/src/content/partials/dns/create-peer-server.mdx b/src/content/partials/dns/create-peer-server.mdx index 5848e3d65a91c47..ef97c5760195ac6 100644 --- a/src/content/partials/dns/create-peer-server.mdx +++ b/src/content/partials/dns/create-peer-server.mdx @@ -21,6 +21,6 @@ To create a peer server using the dashboard: -To create a peer DNS server using the API, send a [POST request](). +To create a peer DNS server using the API, send a [POST request](/api/resources/dns/subresources/zone_transfers/subresources/peers/). diff --git a/src/content/partials/dns/dns-record-steps.mdx b/src/content/partials/dns/dns-record-steps.mdx index 5b7cf2f4a1cda4e..fa045229f3f8b7d 100644 --- a/src/content/partials/dns/dns-record-steps.mdx +++ b/src/content/partials/dns/dns-record-steps.mdx @@ -18,7 +18,7 @@ import { Tabs, TabItem, Render, GlossaryTooltip } from "~/components"; 5. Select **Save** to confirm. -Use the [Create DNS Record API endpoint](/api/operations/dns-records-for-a-zone-create-dns-record). +Use the [Create DNS Record API endpoint](/api/resources/dns/subresources/records/methods/create/). - To point to an IPv4 address, select **A Record**, use {props.name} ({props.example}) for the field `name`, and use the IPv4 address for the field `content`. - To point to an IPv6 address, select **AAAA Record**, use {props.name} ({props.example}) for the field `name`, and use the IPv6 address for the field `content`. diff --git a/src/content/partials/dns/dns-scan-note.mdx b/src/content/partials/dns/dns-scan-note.mdx index ce4cb3255380170..8964e54ed6e0426 100644 --- a/src/content/partials/dns/dns-scan-note.mdx +++ b/src/content/partials/dns/dns-scan-note.mdx @@ -6,8 +6,8 @@ The [DNS records quick scan](/dns/zone-setups/reference/dns-quick-scan/) is not automatically invoked in the following cases: * If you choose Enterprise plan and, instead of the **Quick Scan**, choose to upload a DNS zone file or add records manually. -* If you add a zone via the [API](/api/operations/zones-post). +* If you add a zone via the [API](/api/resources/zones/methods/create/). -You can manually invoke the quick scan via API with the [Scan DNS Records endpoint](/api/operations/dns-records-for-a-zone-scan-dns-records). +You can manually invoke the quick scan via API with the [Scan DNS Records endpoint](/api/resources/dns/subresources/records/methods/scan/). Note that the quick scan is a best effort attempt based on a predefined list of commonly used record names and types. You can read more about this in the [reference page](/dns/zone-setups/reference/dns-quick-scan/). \ No newline at end of file diff --git a/src/content/partials/dns/tsig-create-api.mdx b/src/content/partials/dns/tsig-create-api.mdx index c1c5aa94260e935..0ca5c0a9ba3903e 100644 --- a/src/content/partials/dns/tsig-create-api.mdx +++ b/src/content/partials/dns/tsig-create-api.mdx @@ -3,4 +3,4 @@ --- -To create a TSIG using the API, send a [POST](/api/operations/secondary-dns-\(-tsig\)-create-tsig) request. +To create a TSIG using the API, send a [POST](/api/resources/dns/subresources/zone_transfers/subresources/tsigs/methods/create/) request. diff --git a/src/content/partials/durable-objects/durable-objects-vs-d1.mdx b/src/content/partials/durable-objects/durable-objects-vs-d1.mdx index b0913b72f52f6c5..dd23ebb36a3bfd6 100644 --- a/src/content/partials/durable-objects/durable-objects-vs-d1.mdx +++ b/src/content/partials/durable-objects/durable-objects-vs-d1.mdx @@ -8,7 +8,7 @@ Cloudflare Workers offers a SQLite-backed serverless database product - [D1](/d1 **D1 is a managed database product.** -D1 fits into a familiar architecture for developers, where application servers communicate with a database over the network. Application servers are typically Workers; however, D1 also supports external, non-Worker access via an [HTTP API](https://developers.cloudflare.com/api/operations/cloudflare-d1-query-database), which helps unlock [third-party tooling](/d1/reference/community-projects/#_top) support for D1. +D1 fits into a familiar architecture for developers, where application servers communicate with a database over the network. Application servers are typically Workers; however, D1 also supports external, non-Worker access via an [HTTP API](https://developers.cloudflare.com/api/resources/d1/subresources/database/methods/query/), which helps unlock [third-party tooling](/d1/reference/community-projects/#_top) support for D1. D1 aims for a "batteries included" feature set, including the above HTTP API, [database schema management](/d1/reference/migrations/#_top), [data import/export](/d1/best-practices/import-export-data/), and [database query insights](/d1/observability/metrics-analytics/#query-insights). diff --git a/src/content/partials/fundamentals/add-account-members.mdx b/src/content/partials/fundamentals/add-account-members.mdx index b3a24b3f9acc852..9d7e6d2d1c6275d 100644 --- a/src/content/partials/fundamentals/add-account-members.mdx +++ b/src/content/partials/fundamentals/add-account-members.mdx @@ -31,6 +31,6 @@ If a user already has an account with Cloudflare and you have an Enterprise acco -To add a member using the API, send a [`POST` request](/api/operations/account-members-add-member). +To add a member using the API, send a [`POST` request](/api/resources/accounts/subresources/members/methods/create/). diff --git a/src/content/partials/fundamentals/api-rate-limits.mdx b/src/content/partials/fundamentals/api-rate-limits.mdx index 532ecd2e81b6702..98687529fbd30cf 100644 --- a/src/content/partials/fundamentals/api-rate-limits.mdx +++ b/src/content/partials/fundamentals/api-rate-limits.mdx @@ -9,7 +9,7 @@ If you exceed this limit, all API calls for the next five minutes will be blocke Some specific API calls have their own limits and are documented separately, such as the following: -* [Cache Purge APIs](/api/operations/zone-purge) +* [Cache Purge APIs](/api/resources/cache/methods/purge/) * [GraphQL APIs](/analytics/graphql-api/limits/) * [Rulesets APIs](/ruleset-engine/rulesets-api/#limits) diff --git a/src/content/partials/fundamentals/audit-log-api.mdx b/src/content/partials/fundamentals/audit-log-api.mdx index 70f1f62bf1639a6..ce209127d72ff3f 100644 --- a/src/content/partials/fundamentals/audit-log-api.mdx +++ b/src/content/partials/fundamentals/audit-log-api.mdx @@ -3,7 +3,7 @@ --- -To get audit logs from the Cloudflare API, send a [GET request](/api/operations/audit-logs-get-account-audit-logs). +To get audit logs from the Cloudflare API, send a [GET request](/api/resources/audit_logs/methods/list/). We recommending using the API for downloading historical audit log data. diff --git a/src/content/partials/fundamentals/edit-member-permissions.mdx b/src/content/partials/fundamentals/edit-member-permissions.mdx index f169b71ab6d59cf..c1bdfb5c7516e2e 100644 --- a/src/content/partials/fundamentals/edit-member-permissions.mdx +++ b/src/content/partials/fundamentals/edit-member-permissions.mdx @@ -17,9 +17,9 @@ To edit member permissions using the dashboard: -To edit member permissions using the API, get a [list of roles](/api/operations/account-roles-list-roles) available for an account. +To edit member permissions using the API, get a [list of roles](/api/resources/accounts/subresources/roles/methods/list/) available for an account. -Then, send a [`PUT` request](/api/operations/account-members-update-member) to edit their permissions. +Then, send a [`PUT` request](/api/resources/accounts/subresources/members/methods/update/) to edit their permissions. ```bash title="Request" diff --git a/src/content/partials/fundamentals/remove-account-members.mdx b/src/content/partials/fundamentals/remove-account-members.mdx index 235105c6b64d702..fdcc244e2f0f5be 100644 --- a/src/content/partials/fundamentals/remove-account-members.mdx +++ b/src/content/partials/fundamentals/remove-account-members.mdx @@ -16,6 +16,6 @@ To revoke a member's access to your account: -To revoke a member's access to your account using the API, send a [`DELETE` request](/api/operations/account-members-remove-member). +To revoke a member's access to your account using the API, send a [`DELETE` request](/api/resources/accounts/subresources/members/methods/delete/). diff --git a/src/content/partials/fundamentals/view-account-members.mdx b/src/content/partials/fundamentals/view-account-members.mdx index 38cc61621ad5f89..2512580bcd18ba2 100644 --- a/src/content/partials/fundamentals/view-account-members.mdx +++ b/src/content/partials/fundamentals/view-account-members.mdx @@ -13,6 +13,6 @@ To view members using the dashboard: -To view members using the API, send a [`GET` request](/api/operations/account-members-list-members). +To view members using the API, send a [`GET` request](/api/resources/accounts/subresources/members/methods/list/). diff --git a/src/content/partials/load-balancing/confirm-pool-health.mdx b/src/content/partials/load-balancing/confirm-pool-health.mdx index a299b86e54ecf0d..7605dff4a6e781c 100644 --- a/src/content/partials/load-balancing/confirm-pool-health.mdx +++ b/src/content/partials/load-balancing/confirm-pool-health.mdx @@ -18,8 +18,8 @@ For more information on pool and endpoint health statuses, refer to [How a pool -To fetch the latest health status of all pools, use the [List Pools](/api/operations/account-load-balancer-pools-list-pools) command, paying attention to the `healthy` value for pools and origins (endpoints). +To fetch the latest health status of all pools, use the [List Pools](/api/resources/load_balancers/subresources/pools/methods/list/) command, paying attention to the `healthy` value for pools and origins (endpoints). -For troubleshooting a specific pool's health, use the [Pool Health Details](/api/operations/account-load-balancer-pools-pool-health-details) command. +For troubleshooting a specific pool's health, use the [Pool Health Details](/api/resources/load_balancers/subresources/pools/subresources/health/methods/get/) command. diff --git a/src/content/partials/load-balancing/endpoints-introduction-callout.mdx b/src/content/partials/load-balancing/endpoints-introduction-callout.mdx index f9847327bbd57f2..5a380e226cc7c4b 100644 --- a/src/content/partials/load-balancing/endpoints-introduction-callout.mdx +++ b/src/content/partials/load-balancing/endpoints-introduction-callout.mdx @@ -5,4 +5,4 @@ Since load balancing targets are not limited to origin web servers, the term `endpoints` has been introduced. Refer to [Service-Specific Terms](https://www.cloudflare.com/service-specific-terms-other-terms/) for its use in the context of Cloudflare offerings, and to [load balancing concepts](/load-balancing/understand-basics/load-balancing-components/) or [Reference Architecture](/reference-architecture/architectures/load-balancing/) for use case examples. -On the [Load Balancing API](/api/operations/load-balancers-load-balancer-details), `origin` has been maintained. +On the [Load Balancing API](/api/resources/load_balancers/methods/get/), `origin` has been maintained. diff --git a/src/content/partials/load-balancing/load-balancer-create-api.mdx b/src/content/partials/load-balancing/load-balancer-create-api.mdx index 31d67a683ef5ccb..96e562a70774bcc 100644 --- a/src/content/partials/load-balancing/load-balancer-create-api.mdx +++ b/src/content/partials/load-balancing/load-balancer-create-api.mdx @@ -3,12 +3,12 @@ --- -For a full list of properties, refer to [Create Load Balancer](/api/operations/load-balancers-create-load-balancer). If you need help with API authentication, refer to [Cloudflare API documentation](/fundamentals/api/). +For a full list of properties, refer to [Create Load Balancer](/api/resources/load_balancers/methods/create/). If you need help with API authentication, refer to [Cloudflare API documentation](/fundamentals/api/). :::note -Since load balancers only exist on a zone — and not an account — you may need to get the zone `id` with the [List Zones](/api/operations/zones-get) command. +Since load balancers only exist on a zone — and not an account — you may need to get the zone `id` with the [List Zones](/api/resources/zones/methods/list/) command. ::: diff --git a/src/content/partials/load-balancing/monitor-create-api.mdx b/src/content/partials/load-balancing/monitor-create-api.mdx index 70a52a86891bc87..1c3bc7ca0e2ef48 100644 --- a/src/content/partials/load-balancing/monitor-create-api.mdx +++ b/src/content/partials/load-balancing/monitor-create-api.mdx @@ -3,7 +3,7 @@ --- -For a full list of monitor properties, refer to [Create Monitor](/api/operations/account-load-balancer-monitors-create-monitor). If you need help with API authentication, refer to [Cloudflare API documentation](/fundamentals/api/). +For a full list of monitor properties, refer to [Create Monitor](/api/resources/load_balancers/subresources/monitors/methods/create/). If you need help with API authentication, refer to [Cloudflare API documentation](/fundamentals/api/). ```bash title="Request" curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/load_balancers/monitors" \ diff --git a/src/content/partials/load-balancing/monitor-settings-consecutive.mdx b/src/content/partials/load-balancing/monitor-settings-consecutive.mdx index d6c85a7e19470f4..5ea1696866dbf6b 100644 --- a/src/content/partials/load-balancing/monitor-settings-consecutive.mdx +++ b/src/content/partials/load-balancing/monitor-settings-consecutive.mdx @@ -6,7 +6,7 @@ :::note[Note] -To increase confidence in pool status, you can also increase the `consecutive_up` and `consecutive_down` fields when [creating a monitor with the API](/api/operations/account-load-balancer-monitors-create-monitor). +To increase confidence in pool status, you can also increase the `consecutive_up` and `consecutive_down` fields when [creating a monitor with the API](/api/resources/load_balancers/subresources/monitors/methods/create/). To become healthy or unhealthy, monitored endpoints must pass this health monitor request the consecutive number of times specified in these parameters. diff --git a/src/content/partials/load-balancing/pool-create-api.mdx b/src/content/partials/load-balancing/pool-create-api.mdx index f788fa3aec6f7a6..98bc5291ffbe1fc 100644 --- a/src/content/partials/load-balancing/pool-create-api.mdx +++ b/src/content/partials/load-balancing/pool-create-api.mdx @@ -3,7 +3,7 @@ --- -For a full list of properties, refer to [Create Pool](/api/operations/account-load-balancer-pools-create-pool). If you need help with API authentication, refer to [Cloudflare API documentation](/fundamentals/api/). +For a full list of properties, refer to [Create Pool](/api/resources/load_balancers/subresources/pools/methods/create/). If you need help with API authentication, refer to [Cloudflare API documentation](/fundamentals/api/). ```bash title="Request" curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/load_balancers/pools" \ @@ -110,7 +110,7 @@ The response contains the complete definition of the new pool. } ``` -After creating the pool, you would also want to [create a new notification](/api/operations/notification-policies-create-a-notification-policy) with the following parameters specified: +After creating the pool, you would also want to [create a new notification](/api/resources/alerting/subresources/policies/methods/create/) with the following parameters specified: ```json "alert_type": "load_balancing_health_alert", diff --git a/src/content/partials/magic-network-monitoring/magic-transit-integration.mdx b/src/content/partials/magic-network-monitoring/magic-transit-integration.mdx index 0767be2667ed6e8..c1561a11a7a021f 100644 --- a/src/content/partials/magic-network-monitoring/magic-transit-integration.mdx +++ b/src/content/partials/magic-network-monitoring/magic-transit-integration.mdx @@ -41,7 +41,7 @@ To activate IP advertisement via the Cloudflare dashboard, refer to [Configure d ### API -To activate IP advertisement via the API, refer to the [IP Address Management Dynamic Advertisement API](/api/operations/ip-address-management-dynamic-advertisement-get-advertisement-status). +To activate IP advertisement via the API, refer to the [IP Address Management Dynamic Advertisement API](/api/resources/addressing/subresources/prefixes/subresources/bgp/subresources/statuses/methods/get/). ## Magic Network Monitoring rules diff --git a/src/content/partials/magic-transit/static-routes/static-routes1.mdx b/src/content/partials/magic-transit/static-routes/static-routes1.mdx index c9d98bb673b6691..1b55501c275c6fc 100644 --- a/src/content/partials/magic-transit/static-routes/static-routes1.mdx +++ b/src/content/partials/magic-transit/static-routes/static-routes1.mdx @@ -15,7 +15,7 @@ You must assign a route priority to each tunnel-subnet pair in your configuratio - Lower values have greater priority. - When the priority values for prefix entries match, Cloudflare uses equal-cost multi-path (ECMP) packet forwarding to route traffic. {props.magicWANecmp} For more on how Cloudflare uses ECMP packet forwarding, refer to Traffic steering. -You can also create and edit static routes using the [Magic Static Routes API](/api/operations/magic-static-routes-list-routes). +You can also create and edit static routes using the [Magic Static Routes API](/api/resources/magic_transit/subresources/routes/methods/list/). ## Edge routing configuration example diff --git a/src/content/partials/magic-transit/static-routes/static-routes3.mdx b/src/content/partials/magic-transit/static-routes/static-routes3.mdx index 47d9cfccbbdb7eb..1edd550f098a886 100644 --- a/src/content/partials/magic-transit/static-routes/static-routes3.mdx +++ b/src/content/partials/magic-transit/static-routes/static-routes3.mdx @@ -78,7 +78,7 @@ customer service manager. -Create a `POST` request [using the API](/api/operations/magic-static-routes-create-routes) to create one or more static routes. +Create a `POST` request [using the API](/api/resources/magic_transit/subresources/routes/methods/create/) to create one or more static routes. Example: @@ -123,7 +123,7 @@ curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/routes \ -Create a `PUT` request [using the API](/api/operations/magic-static-routes-update-many-routes) to update one or more static routes. +Create a `PUT` request [using the API](/api/resources/magic_transit/subresources/routes/methods/bulk_update/) to update one or more static routes. Example: @@ -167,7 +167,7 @@ https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/routes \ -Create a `DELETE` request [using the API](/api/operations/magic-static-routes-delete-route) to delete a static route. +Create a `DELETE` request [using the API](/api/resources/magic_transit/subresources/routes/methods/delete/) to delete a static route. Example: diff --git a/src/content/partials/magic-transit/tunnel-endpoints/add-tunnels.mdx b/src/content/partials/magic-transit/tunnel-endpoints/add-tunnels.mdx index c6cd496662867a6..163ca2efc85fb48 100644 --- a/src/content/partials/magic-transit/tunnel-endpoints/add-tunnels.mdx +++ b/src/content/partials/magic-transit/tunnel-endpoints/add-tunnels.mdx @@ -81,7 +81,7 @@ import { Details, Markdown, Render, TabItem, Tabs } from "~/components";
-Create a `POST` request [using the API](/api/operations/magic-gre-tunnels-create-gre-tunnels) to create a GRE tunnel. You will need your [API Key](/fundamentals/api/get-started/keys/#view-your-global-api-key). +Create a `POST` request [using the API](/api/resources/magic_transit/subresources/gre_tunnels/methods/create/) to create a GRE tunnel. You will need your [API Key](/fundamentals/api/get-started/keys/#view-your-global-api-key). Example: @@ -107,9 +107,9 @@ curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/gre_tunnel
-1. Create a `POST` request [using the API](/api/operations/magic-ipsec-tunnels-create-ipsec-tunnels) to create an IPsec tunnel. You will need your [API Key](/fundamentals/api/get-started/keys/#view-your-global-api-key). +1. Create a `POST` request [using the API](/api/resources/magic_transit/subresources/ipsec_tunnels/methods/create/) to create an IPsec tunnel. You will need your [API Key](/fundamentals/api/get-started/keys/#view-your-global-api-key). -Note that in example below, replay protection is disabled by default. You can enable it with the flag `"replay_protection": true` for each IPsec tunnel, if the devices you use do not support disabling this feature. If you have already created IPsec tunnels, update them with a [`PUT` request](https://developers.cloudflare.com/api/operations/magic-ipsec-tunnels-update-ipsec-tunnel).
Refer to Anti-replay protection for more information on this topic. +Note that in example below, replay protection is disabled by default. You can enable it with the flag `"replay_protection": true` for each IPsec tunnel, if the devices you use do not support disabling this feature. If you have already created IPsec tunnels, update them with a [`PUT` request](https://developers.cloudflare.com/api/resources/magic_transit/subresources/ipsec_tunnels/methods/update/).
Refer to Anti-replay protection for more information on this topic. Example: diff --git a/src/content/partials/magic-transit/tunnel-health/update-tunnel-health-checks-frequency.mdx b/src/content/partials/magic-transit/tunnel-health/update-tunnel-health-checks-frequency.mdx index 4f5da3a234c803b..6643ec1406d87b6 100644 --- a/src/content/partials/magic-transit/tunnel-health/update-tunnel-health-checks-frequency.mdx +++ b/src/content/partials/magic-transit/tunnel-health/update-tunnel-health-checks-frequency.mdx @@ -6,7 +6,7 @@ params: import { GlossaryTooltip, Markdown, TabItem, Tabs } from "~/components"; -By default, Cloudflare servers send health checks to each GRE, CNI, or IPsec tunnel endpoint you configure to receive traffic from Magic Transit and Magic WAN. You can configure this frequency via the dashboard or [the API](/api/operations/magic-gre-tunnels-update-gre-tunnel) to suit your use case. For example, if you are connecting a lower-traffic site for which you do not need immediate failover and would rather receive a lower volume of health check traffic, you should set the frequency to `low`. On the other hand, if you are connecting a site that is extremely sensitive to any issues, and you want a more proactive failover at the earliest sign of a potential problem, you should set this to `high`. +By default, Cloudflare servers send health checks to each GRE, CNI, or IPsec tunnel endpoint you configure to receive traffic from Magic Transit and Magic WAN. You can configure this frequency via the dashboard or [the API](/api/resources/magic_transit/subresources/gre_tunnels/methods/update/) to suit your use case. For example, if you are connecting a lower-traffic site for which you do not need immediate failover and would rather receive a lower volume of health check traffic, you should set the frequency to `low`. On the other hand, if you are connecting a site that is extremely sensitive to any issues, and you want a more proactive failover at the earliest sign of a potential problem, you should set this to `high`. Available options are `low`, `mid`, and `high`. @@ -18,7 +18,7 @@ Available options are `low`, `mid`, and `high`. -You can adjust the health check frequency by updating your [GRE](/api/operations/magic-gre-tunnels-update-gre-tunnel), [IPsec](/api/operations/magic-ipsec-tunnels-update-ipsec-tunnel), or [CNI](/api/operations/magic-interconnects-update-interconnect) tunnels. +You can adjust the health check frequency by updating your [GRE](/api/resources/magic_transit/subresources/gre_tunnels/methods/update/), [IPsec](/api/resources/magic_transit/subresources/ipsec_tunnels/methods/update/), or [CNI](/api/resources/magic_transit/subresources/cf_interconnects/methods/update/) tunnels. Below is an example of how to adjust tunnel health check frequency to `low`. Note that this command applies to GRE, IPsec and CNI tunnels: diff --git a/src/content/partials/magic-wan/connector/create-site.mdx b/src/content/partials/magic-wan/connector/create-site.mdx index 73f4ba163241a8d..4aa68ec13426025 100644 --- a/src/content/partials/magic-wan/connector/create-site.mdx +++ b/src/content/partials/magic-wan/connector/create-site.mdx @@ -31,7 +31,7 @@ To add a site: -Create a `POST` request [using the API](/api/operations/magic-sites-create-site) to create a site. +Create a `POST` request [using the API](/api/resources/magic_transit/subresources/sites/methods/create/) to create a site. Example: @@ -93,7 +93,7 @@ Take note of the site `id` parameter, as you will need it to create WANs and LAN -Create a `POST` request [using the API](/api/operations/magic-site-wans-create-wan) to create a WAN. +Create a `POST` request [using the API](/api/resources/magic_transit/subresources/sites/subresources/wans/methods/create/) to create a WAN. The `static_addressing` object is optional. Omit it if you are using DHCP. If you are using static addressing, add the `secondary_address` parameter when your site is in high availability (HA) mode. @@ -137,7 +137,7 @@ curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/sites/{sit -Create a `POST` request [using the API](/api/operations/magic-site-lans-create-lan) to create a LAN. +Create a `POST` request [using the API](/api/resources/magic_transit/subresources/sites/subresources/lans/methods/create/) to create a LAN. Example: diff --git a/src/content/partials/pages/prod-branch-update.mdx b/src/content/partials/pages/prod-branch-update.mdx index 0c267a0e911f5fd..09fee36fe5dc103 100644 --- a/src/content/partials/pages/prod-branch-update.mdx +++ b/src/content/partials/pages/prod-branch-update.mdx @@ -3,7 +3,7 @@ --- -If your project is a [Direct Upload](/pages/get-started/direct-upload/) project, you will not have the option to configure production branch controls. To update your production branch, you will need to manually call the [Update Project](/api/operations/pages-project-update-project) endpoint in the API. +If your project is a [Direct Upload](/pages/get-started/direct-upload/) project, you will not have the option to configure production branch controls. To update your production branch, you will need to manually call the [Update Project](/api/resources/pages/subresources/projects/methods/edit/) endpoint in the API. ```bash curl --request PATCH \ diff --git a/src/content/partials/rules/rules-creation-workflow.mdx b/src/content/partials/rules/rules-creation-workflow.mdx index d559d8dc42b581c..0dd4ffd030a65ca 100644 --- a/src/content/partials/rules/rules-creation-workflow.mdx +++ b/src/content/partials/rules/rules-creation-workflow.mdx @@ -7,11 +7,11 @@ import { Markdown } from "~/components" Follow this workflow to create {props.one} for a given zone via API: -1. Use the [List zone rulesets](/api/operations/listZoneRulesets) operation to check if there is already a ruleset for the {props.two} phase at the zone level. +1. Use the [List zone rulesets](/api/resources/rulesets/methods/list/) operation to check if there is already a ruleset for the {props.two} phase at the zone level. -2. If the phase ruleset does not exist, create it using the [Create a zone ruleset](/api/operations/createZoneRuleset) operation. In the new ruleset properties, set the following values: +2. If the phase ruleset does not exist, create it using the [Create a zone ruleset](/api/resources/rulesets/methods/create/) operation. In the new ruleset properties, set the following values: * **kind**: `zone` * **phase**: {props.two} -3. Use the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation to add {props.one} to the list of ruleset rules. Alternatively, include the rule in the [Create a zone ruleset](/api/operations/createZoneRuleset) request mentioned in the previous step. +3. Use the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation to add {props.one} to the list of ruleset rules. Alternatively, include the rule in the [Create a zone ruleset](/api/resources/rulesets/methods/create/) request mentioned in the previous step. diff --git a/src/content/partials/security-center/indicator-feeds-overview.mdx b/src/content/partials/security-center/indicator-feeds-overview.mdx index b87ca9d69cb9011..8b5d35a41267823 100644 --- a/src/content/partials/security-center/indicator-feeds-overview.mdx +++ b/src/content/partials/security-center/indicator-feeds-overview.mdx @@ -8,4 +8,4 @@ Cloudflare threat intelligence data consists of a data exchange between provider A provider is an organization that has a set of data that they are interested in sharing with other Cloudflare organizations. Any organization can be a provider. Examples of current providers are Government Cyber Defense groups. -Subscribers can be any Cloudflare customer that wants to secure their environment further by creating rules based on provider datasets. Subscribers must be authorized by a provider. Authorization is granted using the [Grant permission to indicator feed endpoint](/api/operations/custom-indicator-feeds-add-permission). +Subscribers can be any Cloudflare customer that wants to secure their environment further by creating rules based on provider datasets. Subscribers must be authorized by a provider. Authorization is granted using the [Grant permission to indicator feed endpoint](/api/resources/intel/subresources/indicator_feeds/subresources/permissions/methods/create/). diff --git a/src/content/partials/ssl/acm-validate-cert.mdx b/src/content/partials/ssl/acm-validate-cert.mdx index f5133de32822ea3..b7c0442b9204788 100644 --- a/src/content/partials/ssl/acm-validate-cert.mdx +++ b/src/content/partials/ssl/acm-validate-cert.mdx @@ -6,4 +6,4 @@ To check whether your certificates have been validated and reissued: * **Dashboard**: Find the certificate(s) **SSL/TLS** > **Edge Certificates** and make sure that the **Status** is **Active**. -* **API**: Send a [`GET`](/api/operations/certificate-packs-list-certificate-packs) request and confirm that your certificate(s) have `"status": "active"`. +* **API**: Send a [`GET`](/api/resources/ssl/subresources/certificate_packs/methods/list/) request and confirm that your certificate(s) have `"status": "active"`. diff --git a/src/content/partials/ssl/aop-enable-feature.mdx b/src/content/partials/ssl/aop-enable-feature.mdx index f8dad78068d1a34..e66e014036905f4 100644 --- a/src/content/partials/ssl/aop-enable-feature.mdx +++ b/src/content/partials/ssl/aop-enable-feature.mdx @@ -24,7 +24,7 @@ Note that this step means Authenticated Origin Pulls will be available, but you -To enable or disable **Authenticated Origin Pulls** with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `tls_client_auth` as the setting name in the URI path, and the `value` parameter set to your desired setting (`"on"` or `"off"`). +To enable or disable **Authenticated Origin Pulls** with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `tls_client_auth` as the setting name in the URI path, and the `value` parameter set to your desired setting (`"on"` or `"off"`). :::caution diff --git a/src/content/partials/ssl/change-encryption-mode-api.mdx b/src/content/partials/ssl/change-encryption-mode-api.mdx index 58bd8b128529e4a..56ae28c0a1ced82 100644 --- a/src/content/partials/ssl/change-encryption-mode-api.mdx +++ b/src/content/partials/ssl/change-encryption-mode-api.mdx @@ -3,4 +3,4 @@ --- -To adjust your encryption mode with the API, send a [`PATCH`](/api/operations/zone-settings-edit-single-setting) request with `ssl` as the setting name in the URI path, and the `value` parameter set to your desired setting (`off`, `flexible`, `full`, `strict`, or `origin_pull`). +To adjust your encryption mode with the API, send a [`PATCH`](/api/resources/zones/subresources/settings/methods/edit/) request with `ssl` as the setting name in the URI path, and the `value` parameter set to your desired setting (`off`, `flexible`, `full`, `strict`, or `origin_pull`). diff --git a/src/content/partials/ssl/dcv-validate-patch.mdx b/src/content/partials/ssl/dcv-validate-patch.mdx index f978ecf52d063de..26c6cda69d9927a 100644 --- a/src/content/partials/ssl/dcv-validate-patch.mdx +++ b/src/content/partials/ssl/dcv-validate-patch.mdx @@ -3,4 +3,4 @@ --- -To request an immediate recheck, send another [PATCH request](/api/operations/ssl-verification-edit-ssl-certificate-pack-validation-method) with the same `validation_method` as your current validation method. +To request an immediate recheck, send another [PATCH request](/api/resources/ssl/subresources/verification/methods/edit/) with the same `validation_method` as your current validation method. diff --git a/src/content/partials/ssl/forward-client-certificate.mdx b/src/content/partials/ssl/forward-client-certificate.mdx index 54e23618e1baee6..9a8d1368f1093fb 100644 --- a/src/content/partials/ssl/forward-client-certificate.mdx +++ b/src/content/partials/ssl/forward-client-certificate.mdx @@ -15,7 +15,7 @@ This process is only available on accounts with [Cloudflare Access](/cloudflare- ### Cloudflare API -The most common approach to forwarding a certificate is to use the Cloudflare API to [update an mTLS certificate's hostname settings](/api/operations/zone-level-access-mtls-authentication-update-an-mtls-certificate-settings). +The most common approach to forwarding a certificate is to use the Cloudflare API to [update an mTLS certificate's hostname settings](/api/resources/zero_trust/subresources/access/subresources/certificates/subresources/settings/methods/update/). ```bash title="Request" {11} curl --request PUT \ diff --git a/src/content/partials/ssl/generic-validation-process.mdx b/src/content/partials/ssl/generic-validation-process.mdx index 8b21015c52d592c..0b3edf72e02fea2 100644 --- a/src/content/partials/ssl/generic-validation-process.mdx +++ b/src/content/partials/ssl/generic-validation-process.mdx @@ -3,6 +3,6 @@ --- -If you want to use a [Universal SSL certificate](/ssl/edge-certificates/universal-ssl/enable-universal-ssl/), you will need to edit the `validation_method` [via the API](/api/operations/ssl-verification-edit-ssl-certificate-pack-validation-method) and specify your chosen validation method. +If you want to use a [Universal SSL certificate](/ssl/edge-certificates/universal-ssl/enable-universal-ssl/), you will need to edit the `validation_method` [via the API](/api/resources/ssl/subresources/verification/methods/edit/) and specify your chosen validation method. Alternatively, you could [order an advanced certificate](/ssl/edge-certificates/advanced-certificate-manager/) via the dashboard or the API. diff --git a/src/content/partials/ssl/generic-view-validation-status.mdx b/src/content/partials/ssl/generic-view-validation-status.mdx index 5845d7a69e02346..744ea22480638f1 100644 --- a/src/content/partials/ssl/generic-view-validation-status.mdx +++ b/src/content/partials/ssl/generic-view-validation-status.mdx @@ -4,4 +4,4 @@ --- * Going to **SSL/TLS** > **Edge Certificates** in the dashboard and selecting a certificate. -* Getting certificate details by making a [`GET` request](/api/operations/certificate-packs-get-certificate-pack) with `status=pending_validation` in the request parameter and finding the `validation_method` and `validation_records`. +* Getting certificate details by making a [`GET` request](/api/resources/ssl/subresources/certificate_packs/methods/get/) with `status=pending_validation` in the request parameter and finding the `validation_method` and `validation_records`. diff --git a/src/content/partials/ssl/http-cname-validation-process.mdx b/src/content/partials/ssl/http-cname-validation-process.mdx index 41a7a32a0581408..f5e56eee7eb0688 100644 --- a/src/content/partials/ssl/http-cname-validation-process.mdx +++ b/src/content/partials/ssl/http-cname-validation-process.mdx @@ -3,6 +3,6 @@ --- -If you want to use a [Universal SSL certificate](/ssl/edge-certificates/universal-ssl/enable-universal-ssl/), you will need to edit the `validation_method` [via the API](/api/operations/ssl-verification-edit-ssl-certificate-pack-validation-method) and specify your chosen validation method. +If you want to use a [Universal SSL certificate](/ssl/edge-certificates/universal-ssl/enable-universal-ssl/), you will need to edit the `validation_method` [via the API](/api/resources/ssl/subresources/verification/methods/edit/) and specify your chosen validation method. Alternatively, you could [order an advanced certificate](/ssl/edge-certificates/advanced-certificate-manager/manage-certificates/#create-a-certificate) via the API. diff --git a/src/content/partials/ssl/txt-validation-api.mdx b/src/content/partials/ssl/txt-validation-api.mdx index b7b2923ba665372..cdf1f38f24b2fcc 100644 --- a/src/content/partials/ssl/txt-validation-api.mdx +++ b/src/content/partials/ssl/txt-validation-api.mdx @@ -3,7 +3,7 @@ --- -You can access these tokens using the API with the [`GET` request](/api/operations/certificate-packs-get-certificate-pack) and including `status=pending_validation` as a request parameter. +You can access these tokens using the API with the [`GET` request](/api/resources/ssl/subresources/certificate_packs/methods/get/) and including `status=pending_validation` as a request parameter. For example, here are two tokens highlighted in the API response for a wildcard certificate. diff --git a/src/content/partials/tenant/create-account-subscription.mdx b/src/content/partials/tenant/create-account-subscription.mdx index 918dfa4a9e7ff2b..3079c476a2951ff 100644 --- a/src/content/partials/tenant/create-account-subscription.mdx +++ b/src/content/partials/tenant/create-account-subscription.mdx @@ -5,7 +5,7 @@ -To create an account subscription, send a [POST](/api/operations/account-subscriptions-create-subscription) request to the `/accounts/{account_id}/subscriptions` endpoint and include the following values: +To create an account subscription, send a [POST](/api/resources/accounts/subresources/subscriptions/methods/create/) request to the `/accounts/{account_id}/subscriptions` endpoint and include the following values: * `rate_plan` object diff --git a/src/content/partials/tenant/create-zone-subscription.mdx b/src/content/partials/tenant/create-zone-subscription.mdx index d9d0e5fc5fbd80c..4535e906db668f5 100644 --- a/src/content/partials/tenant/create-zone-subscription.mdx +++ b/src/content/partials/tenant/create-zone-subscription.mdx @@ -5,7 +5,7 @@ -To create a zone subscription, typically used to upgrade a zone's plan from `PARTNERS_FREE` to a paid [Zone plan](/tenant/reference/subscriptions/#zone-plans), send a [POST](/api/operations/zone-subscription-create-zone-subscription) request to the `/zones/{zone_id}/subscription` endpoint and include the following values: +To create a zone subscription, typically used to upgrade a zone's plan from `PARTNERS_FREE` to a paid [Zone plan](/tenant/reference/subscriptions/#zone-plans), send a [POST](/api/resources/zones/subresources/subscriptions/methods/create/) request to the `/zones/{zone_id}/subscription` endpoint and include the following values: * `rate_plan` object diff --git a/src/content/partials/terraform/find-ids-managed-rulesets.mdx b/src/content/partials/terraform/find-ids-managed-rulesets.mdx index 4ad71fa558de638..e93b48bff9fb814 100644 --- a/src/content/partials/terraform/find-ids-managed-rulesets.mdx +++ b/src/content/partials/terraform/find-ids-managed-rulesets.mdx @@ -5,7 +5,7 @@ The Terraform configurations provided in this page need the zone ID (or account ID) of the zone/account where you will deploy the managed rulesets. -* To retrieve the list of accounts you have access to, including their IDs, use the [List accounts](/api/operations/accounts-list-accounts) operation. -* To retrieve the list of zones you have access to, including their IDs, use the [List zones](/api/operations/zones-get) operation. +* To retrieve the list of accounts you have access to, including their IDs, use the [List accounts](/api/resources/accounts/methods/list/) operation. +* To retrieve the list of zones you have access to, including their IDs, use the [List zones](/api/resources/zones/methods/list/) operation. -The deployment of managed rulesets via Terraform requires that you use the ruleset IDs. To find the IDs of managed rulesets, use the [List account rulesets](/api/operations/listAccountRulesets) operation. The response will include the description and IDs of existing managed rulesets. +The deployment of managed rulesets via Terraform requires that you use the ruleset IDs. To find the IDs of managed rulesets, use the [List account rulesets](/api/resources/rulesets/methods/list/) operation. The response will include the description and IDs of existing managed rulesets. diff --git a/src/content/partials/terraform/find-ids.mdx b/src/content/partials/terraform/find-ids.mdx index dfe1abfb1dabf64..25181bac1db4ec9 100644 --- a/src/content/partials/terraform/find-ids.mdx +++ b/src/content/partials/terraform/find-ids.mdx @@ -5,5 +5,5 @@ The Terraform configurations provided in this page need the zone ID (or account ID) of the zone/account where you will deploy rulesets. -* To retrieve the list of accounts you have access to, including their IDs, use the [List accounts](/api/operations/accounts-list-accounts) operation. -* To retrieve the list of zones you have access to, including their IDs, use the [List zones](/api/operations/zones-get) operation. +* To retrieve the list of accounts you have access to, including their IDs, use the [List accounts](/api/resources/accounts/methods/list/) operation. +* To retrieve the list of zones you have access to, including their IDs, use the [List zones](/api/resources/zones/methods/list/) operation. diff --git a/src/content/partials/terraform/terraform/find-ids-managed-rulesets.mdx b/src/content/partials/terraform/terraform/find-ids-managed-rulesets.mdx index 4ad71fa558de638..e93b48bff9fb814 100644 --- a/src/content/partials/terraform/terraform/find-ids-managed-rulesets.mdx +++ b/src/content/partials/terraform/terraform/find-ids-managed-rulesets.mdx @@ -5,7 +5,7 @@ The Terraform configurations provided in this page need the zone ID (or account ID) of the zone/account where you will deploy the managed rulesets. -* To retrieve the list of accounts you have access to, including their IDs, use the [List accounts](/api/operations/accounts-list-accounts) operation. -* To retrieve the list of zones you have access to, including their IDs, use the [List zones](/api/operations/zones-get) operation. +* To retrieve the list of accounts you have access to, including their IDs, use the [List accounts](/api/resources/accounts/methods/list/) operation. +* To retrieve the list of zones you have access to, including their IDs, use the [List zones](/api/resources/zones/methods/list/) operation. -The deployment of managed rulesets via Terraform requires that you use the ruleset IDs. To find the IDs of managed rulesets, use the [List account rulesets](/api/operations/listAccountRulesets) operation. The response will include the description and IDs of existing managed rulesets. +The deployment of managed rulesets via Terraform requires that you use the ruleset IDs. To find the IDs of managed rulesets, use the [List account rulesets](/api/resources/rulesets/methods/list/) operation. The response will include the description and IDs of existing managed rulesets. diff --git a/src/content/partials/terraform/terraform/find-ids.mdx b/src/content/partials/terraform/terraform/find-ids.mdx index dfe1abfb1dabf64..25181bac1db4ec9 100644 --- a/src/content/partials/terraform/terraform/find-ids.mdx +++ b/src/content/partials/terraform/terraform/find-ids.mdx @@ -5,5 +5,5 @@ The Terraform configurations provided in this page need the zone ID (or account ID) of the zone/account where you will deploy rulesets. -* To retrieve the list of accounts you have access to, including their IDs, use the [List accounts](/api/operations/accounts-list-accounts) operation. -* To retrieve the list of zones you have access to, including their IDs, use the [List zones](/api/operations/zones-get) operation. +* To retrieve the list of accounts you have access to, including their IDs, use the [List accounts](/api/resources/accounts/methods/list/) operation. +* To retrieve the list of zones you have access to, including their IDs, use the [List zones](/api/resources/zones/methods/list/) operation. diff --git a/src/content/partials/waf/api-generic-create-rule-procedure.mdx b/src/content/partials/waf/api-generic-create-rule-procedure.mdx index 916c3190d226e44..0ff61899d2e762a 100644 --- a/src/content/partials/waf/api-generic-create-rule-procedure.mdx +++ b/src/content/partials/waf/api-generic-create-rule-procedure.mdx @@ -9,8 +9,8 @@ import { Markdown } from "~/components"; To create a {props.ruleType} for a zone, add a rule to the {props.phaseName} phase entry point ruleset. -1. Invoke the [Get a zone entry point ruleset](/api/operations/getZoneEntrypointRuleset) operation to obtain the definition of the entry point ruleset for the {props.phaseName} phase. You will need the [zone ID](/fundamentals/setup/find-account-and-zone-ids/) for this task. +1. Invoke the [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/) operation to obtain the definition of the entry point ruleset for the {props.phaseName} phase. You will need the [zone ID](/fundamentals/setup/find-account-and-zone-ids/) for this task. -2. If the entry point ruleset already exists (that is, if you received a `200 OK` status code and the ruleset definition), take note of the ruleset ID in the response. Then, invoke the [Create a zone ruleset rule](/api/operations/createZoneRulesetRule) operation to add a {props.ruleType} to the existing ruleset. Refer to the examples below for details. +2. If the entry point ruleset already exists (that is, if you received a `200 OK` status code and the ruleset definition), take note of the ruleset ID in the response. Then, invoke the [Create a zone ruleset rule](/api/resources/rulesets/methods/create/) operation to add a {props.ruleType} to the existing ruleset. Refer to the examples below for details. -3. If the entry point ruleset does not exist (that is, if you received a `404 Not Found` status code in step 1), create it using the [Create a zone ruleset](/api/operations/createZoneRuleset) operation. Include your {props.ruleType} in the `rules` array. Refer to [Create ruleset](/ruleset-engine/rulesets-api/create/#example---create-a-zone-level-phase-entry-point-ruleset) for an example. +3. If the entry point ruleset does not exist (that is, if you received a `404 Not Found` status code in step 1), create it using the [Create a zone ruleset](/api/resources/rulesets/methods/create/) operation. Include your {props.ruleType} in the `rules` array. Refer to [Create ruleset](/ruleset-engine/rulesets-api/create/#example---create-a-zone-level-phase-entry-point-ruleset) for an example. diff --git a/src/content/partials/waf/rules-next-steps-table.mdx b/src/content/partials/waf/rules-next-steps-table.mdx index 6d8d2f6cd48d9f3..8f12446af3318fa 100644 --- a/src/content/partials/waf/rules-next-steps-table.mdx +++ b/src/content/partials/waf/rules-next-steps-table.mdx @@ -8,8 +8,8 @@ import { Markdown } from "~/components"; | Task | Procedure | | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| List all rules in ruleset |

Use the [Get a zone entry point ruleset](/api/operations/getZoneEntrypointRuleset) operation with the {props.phaseName} phase name to obtain the list of configured {props.rulesType} and their IDs.

For more information, refer to [View a specific ruleset](/ruleset-engine/rulesets-api/view/#view-a-specific-ruleset).

| -| Update a rule |

Use the [Update a zone ruleset rule](/api/operations/updateZoneRulesetRule) operation.

You will need to provide the ruleset ID and the rule ID. To obtain these IDs, you can use the [Get a zone entry point ruleset](/api/operations/getZoneEntrypointRuleset) operation with the {props.phaseName} phase name.

For more information, refer to [Update a rule in a ruleset](/ruleset-engine/rulesets-api/update-rule/).

| -| Delete a rule |

Use the [Delete a zone ruleset rule](/api/operations/deleteZoneRulesetRule) operation.

You will need to provide the ruleset ID and the rule ID. To obtain these IDs, you can use the [Get a zone entry point ruleset](/api/operations/getZoneEntrypointRuleset) operation with the {props.phaseName} phase name.

For more information, refer to [Delete a rule in a ruleset](/ruleset-engine/rulesets-api/delete-rule/).

| +| List all rules in ruleset |

Use the [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/) operation with the {props.phaseName} phase name to obtain the list of configured {props.rulesType} and their IDs.

For more information, refer to [View a specific ruleset](/ruleset-engine/rulesets-api/view/#view-a-specific-ruleset).

| +| Update a rule |

Use the [Update a zone ruleset rule](/api/resources/rulesets/methods/update/) operation.

You will need to provide the ruleset ID and the rule ID. To obtain these IDs, you can use the [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/) operation with the {props.phaseName} phase name.

For more information, refer to [Update a rule in a ruleset](/ruleset-engine/rulesets-api/update-rule/).

| +| Delete a rule |

Use the [Delete a zone ruleset rule](/api/resources/rulesets/methods/delete/) operation.

You will need to provide the ruleset ID and the rule ID. To obtain these IDs, you can use the [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/) operation with the {props.phaseName} phase name.

For more information, refer to [Delete a rule in a ruleset](/ruleset-engine/rulesets-api/delete-rule/).

| These operations are covered in the Ruleset Engine documentation. The Ruleset Engine powers different Cloudflare products, including {props.rulesType}. diff --git a/src/content/partials/waf/rulesets/api-account/step1-get-entrypoint.mdx b/src/content/partials/waf/rulesets/api-account/step1-get-entrypoint.mdx index 0ebfc9de928b747..4594288d9f1554a 100644 --- a/src/content/partials/waf/rulesets/api-account/step1-get-entrypoint.mdx +++ b/src/content/partials/waf/rulesets/api-account/step1-get-entrypoint.mdx @@ -3,4 +3,4 @@ params: - phaseName --- -Invoke the [Get an account entry point ruleset](/api/operations/getAccountEntrypointRuleset) operation to obtain the definition of the entry point ruleset for the {props.phaseName} phase. You will need the [account ID](/fundamentals/setup/find-account-and-zone-ids/) for this task. +Invoke the [Get an account entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/) operation to obtain the definition of the entry point ruleset for the {props.phaseName} phase. You will need the [account ID](/fundamentals/setup/find-account-and-zone-ids/) for this task. diff --git a/src/content/partials/waf/rulesets/api-account/step2-create-rule.mdx b/src/content/partials/waf/rulesets/api-account/step2-create-rule.mdx index ef71dc24289a91d..ba3403331d5afc5 100644 --- a/src/content/partials/waf/rulesets/api-account/step2-create-rule.mdx +++ b/src/content/partials/waf/rulesets/api-account/step2-create-rule.mdx @@ -5,4 +5,4 @@ params: import { Markdown } from "~/components"; -If the entry point ruleset already exists (that is, if you received a `200 OK` status code and the ruleset definition), take note of the ruleset ID in the response. Then, invoke the [Create an account ruleset rule](/api/operations/createAccountRulesetRule) operation to add an `execute` rule to the existing ruleset deploying the . By default, the rule will be added at the end of the list of rules already in the ruleset. +If the entry point ruleset already exists (that is, if you received a `200 OK` status code and the ruleset definition), take note of the ruleset ID in the response. Then, invoke the [Create an account ruleset rule](/api/resources/rulesets/methods/create/Rule) operation to add an `execute` rule to the existing ruleset deploying the . By default, the rule will be added at the end of the list of rules already in the ruleset. diff --git a/src/content/partials/waf/rulesets/api-account/step3-create-ruleset.mdx b/src/content/partials/waf/rulesets/api-account/step3-create-ruleset.mdx index f1e1e70e50e14a6..8cf27eca2f01b52 100644 --- a/src/content/partials/waf/rulesets/api-account/step3-create-ruleset.mdx +++ b/src/content/partials/waf/rulesets/api-account/step3-create-ruleset.mdx @@ -6,4 +6,4 @@ params: import { Markdown } from "~/components"; -If the entry point ruleset does not exist (that is, if you received a `404 Not Found` status code in step 1), create it using the [Create an account ruleset](/api/operations/createAccountRuleset) operation. Include a single rule in the `rules` array that executes the for . +If the entry point ruleset does not exist (that is, if you received a `404 Not Found` status code in step 1), create it using the [Create an account ruleset](/api/resources/rulesets/methods/create/) operation. Include a single rule in the `rules` array that executes the for . diff --git a/src/content/partials/waf/rulesets/api-zone/step1-get-entrypoint.mdx b/src/content/partials/waf/rulesets/api-zone/step1-get-entrypoint.mdx index fa3fe02fe59fd21..efc937682c473e3 100644 --- a/src/content/partials/waf/rulesets/api-zone/step1-get-entrypoint.mdx +++ b/src/content/partials/waf/rulesets/api-zone/step1-get-entrypoint.mdx @@ -3,4 +3,4 @@ params: - phaseName --- -Invoke the [Get a zone entry point ruleset](/api/operations/getZoneEntrypointRuleset) operation to obtain the definition of the entry point ruleset for the {props.phaseName} phase. You will need the [zone ID](/fundamentals/setup/find-account-and-zone-ids/) for this task. +Invoke the [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/) operation to obtain the definition of the entry point ruleset for the {props.phaseName} phase. You will need the [zone ID](/fundamentals/setup/find-account-and-zone-ids/) for this task. diff --git a/src/content/partials/waf/rulesets/api-zone/step2-create-rule.mdx b/src/content/partials/waf/rulesets/api-zone/step2-create-rule.mdx index 851b7a1214ef1a4..184be6084f046af 100644 --- a/src/content/partials/waf/rulesets/api-zone/step2-create-rule.mdx +++ b/src/content/partials/waf/rulesets/api-zone/step2-create-rule.mdx @@ -5,4 +5,4 @@ params: import { Markdown } from "~/components"; -If the entry point ruleset already exists (that is, if you received a `200 OK` status code and the ruleset definition), take note of the ruleset ID in the response. Then, invoke the [Create a zone ruleset rule](/api/operations/createZoneRulesetRule) operation to add an `execute` rule to the existing ruleset deploying the . By default, the rule will be added at the end of the list of rules already in the ruleset. +If the entry point ruleset already exists (that is, if you received a `200 OK` status code and the ruleset definition), take note of the ruleset ID in the response. Then, invoke the [Create a zone ruleset rule](/api/resources/rulesets/methods/create/) operation to add an `execute` rule to the existing ruleset deploying the . By default, the rule will be added at the end of the list of rules already in the ruleset. diff --git a/src/content/partials/waf/rulesets/api-zone/step3-create-ruleset.mdx b/src/content/partials/waf/rulesets/api-zone/step3-create-ruleset.mdx index f3a3e6a9d4f5eb1..7541461d3e57d92 100644 --- a/src/content/partials/waf/rulesets/api-zone/step3-create-ruleset.mdx +++ b/src/content/partials/waf/rulesets/api-zone/step3-create-ruleset.mdx @@ -6,4 +6,4 @@ params: import { Markdown } from "~/components"; -If the entry point ruleset does not exist (that is, if you received a `404 Not Found` status code in step 1), create it using the [Create a zone ruleset](/api/operations/createZoneRuleset) operation. Include a single rule in the `rules` array that executes the for . +If the entry point ruleset does not exist (that is, if you received a `404 Not Found` status code in step 1), create it using the [Create a zone ruleset](/api/resources/rulesets/methods/create/) operation. Include a single rule in the `rules` array that executes the for . diff --git a/src/content/partials/web3/create-gateway-api.mdx b/src/content/partials/web3/create-gateway-api.mdx index 2655689ed554874..e1952e8378a32e6 100644 --- a/src/content/partials/web3/create-gateway-api.mdx +++ b/src/content/partials/web3/create-gateway-api.mdx @@ -3,7 +3,7 @@ --- -To create a gateway using the API, send a [`POST`](/api/operations/web3-hostname-create-web3-hostname) request that includes the following parameters: +To create a gateway using the API, send a [`POST`](/api/resources/web3/subresources/hostnames/methods/create/) request that includes the following parameters: * `name`: The hostname that will point to the target gateway via a `CNAME` record. * `target`: The gateway target for the hostname (`ethereum`, `ipfs`, `ipfs_universal_path`). diff --git a/src/pages/search.astro b/src/pages/search.astro index 802b2480c0e013b..c12bf1185a285c7 100644 --- a/src/pages/search.astro +++ b/src/pages/search.astro @@ -318,7 +318,7 @@ import "instantsearch.css/themes/satellite.css"; container: "#hits", templates: { item(hit, { html, components }) { - if (hit.path.startsWith("/api/operations/")) { + if (hit.path.startsWith("/api/resources/")) { return html`