From 827c4b90a6d0d2f51db14e764273cd8018ba0d38 Mon Sep 17 00:00:00 2001 From: Angela Costa Date: Thu, 24 Jul 2025 10:12:05 +0100 Subject: [PATCH 1/2] Moves API configuration page --- public/__redirects | 5 +++-- .../docs/logs/logpush/examples/example-logpush-curl.mdx | 8 ++++---- src/content/docs/logs/logpush/index.mdx | 2 +- .../logpush-job}/api-configuration.mdx | 2 +- .../docs/logs/logpush/logpush-job/edge-log-delivery.mdx | 2 +- .../logpush/logpush-job/enable-destinations/aws-s3.mdx | 2 +- .../logpush/logpush-job/enable-destinations/azure.mdx | 2 +- .../logpush/logpush-job/enable-destinations/datadog.mdx | 2 +- .../enable-destinations/google-cloud-storage.mdx | 2 +- .../logs/logpush/logpush-job/enable-destinations/http.mdx | 4 ++-- .../logpush/logpush-job/enable-destinations/new-relic.mdx | 2 +- .../logpush-job/enable-destinations/other-providers.mdx | 2 +- .../logs/logpush/logpush-job/enable-destinations/r2.mdx | 4 ++-- .../enable-destinations/s3-compatible-endpoints.mdx | 2 +- .../logpush/logpush-job/enable-destinations/splunk.mdx | 2 +- .../logpush-job/enable-destinations/sumo-logic.mdx | 2 +- .../docs/logs/logpush/logpush-job/log-output-options.mdx | 2 +- .../content-types/reference.mdx | 2 +- src/content/docs/workers/observability/logs/logpush.mdx | 4 ++-- 19 files changed, 27 insertions(+), 26 deletions(-) rename src/content/docs/logs/{get-started => logpush/logpush-job}/api-configuration.mdx (99%) diff --git a/public/__redirects b/public/__redirects index 93fccf3dbdca244..36feb99ec672eaf 100644 --- a/public/__redirects +++ b/public/__redirects @@ -961,10 +961,10 @@ /logs/logpush/azure/ /logs/logpush/logpush-job/enable-destinations/azure/ 301 /logs/logpush/google-cloud-storage/ /logs/logpush/logpush-job/enable-destinations/google-cloud-storage/ 301 /logs/logpush/logpush-configuration-api/ /logs/logpush/logpush-job/enable-destinations/ 301 -/logs/logpush/logpush-configuration-api/understanding-logpush-api/ /logs/get-started/api-configuration/ 301 +/logs/logpush/logpush-configuration-api/understanding-logpush-api/ /logs/logpush/logpush-job/api-configuration/ 301 /logs/logpush/logpush-dashboard/ /logs/logpush/logpush-job/enable-destinations/ 301 /logs/logpush/s3-compatible-endpoints/ /logs/logpush/logpush-job/enable-destinations/s3-compatible-endpoints/ 301 -/logs/reference/logpush-api-configuration/ /logs/get-started/api-configuration/ 301 +/logs/reference/logpush-api-configuration/ /logs/logpush/logpush-job/api-configuration/ 301 /logs/reference/logpush-api-configuration/filters/ /logs/logpush/logpush-job/filters/ 301 # Non-slashed version is being used in the Cloudflare dashboard /logs/reference/logpush-api-configuration/examples/example-logpush-curl/ /logs/logpush/examples/example-logpush-curl/ 301 @@ -981,6 +981,7 @@ /logs/reference/filters/ /logs/logpush/logpush-job/filters/ 301 /logs/reference/log-output-options/ /logs/logpush/logpush-job/log-output-options/ 301 /logs/reference/custom-fields/ /logs/logpush/logpush-job/custom-fields/ 301 +/logs/get-started/api-configuration/ /logs/logpush/logpush-job/api-configuration/ 301 # magic-firewall /magic-firewall/reference/examples/ /magic-firewall/how-to/add-rules/ 301 diff --git a/src/content/docs/logs/logpush/examples/example-logpush-curl.mdx b/src/content/docs/logs/logpush/examples/example-logpush-curl.mdx index 62c9a769230053b..74195744202c8f4 100644 --- a/src/content/docs/logs/logpush/examples/example-logpush-curl.mdx +++ b/src/content/docs/logs/logpush/examples/example-logpush-curl.mdx @@ -12,7 +12,7 @@ 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/) +* [API configuration](/logs/logpush/logpush-job/api-configuration/) :::note @@ -34,7 +34,7 @@ The examples below are for zone-scoped datasets. Account-scoped datasets should ### Parameters -* **destination\_conf** - Refer to [Destination](/logs/get-started/api-configuration/#destination) for details. +* **destination\_conf** - Refer to [Destination](/logs/logpush/logpush-job/api-configuration/#destination) for details. ### Response @@ -93,7 +93,7 @@ When using Sumo Logic, you may find it helpful to have [Live Tail](https://help. ### Parameters * **name** (optional) - We suggest using your domain name as the job name; the name cannot be changed after the job is created. -* **destination\_conf** - Refer to [Destination](/logs/get-started/api-configuration/#destination) for details. +* **destination\_conf** - Refer to [Destination](/logs/logpush/logpush-job/api-configuration/#destination) for details. * **dataset** - The category of logs you want to receive. Refer to [Log fields](/logs/reference/log-fields/) for the full list of supported datasets; this parameter cannot be changed after the job is created. * **output\_options** (optional) - Refer to [Log Output Options](/logs/logpush/logpush-job/log-output-options/). * Typically includes the desired fields and timestamp format. @@ -101,7 +101,7 @@ When using Sumo Logic, you may find it helpful to have [Live Tail](https://help. * Google BigQuery usage. * Automated timestamp parsing within Sumo Logic; refer to [timestamps from Sumo Logic](https://help.sumologic.com/03Send-Data/Sources/04Reference-Information-for-Sources/Timestamps%2C-Time-Zones%2C-Time-Ranges%2C-and-Date-Formats) for details. * **ownership\_challenge** - Challenge token required to prove destination ownership. -* **kind** (optional) - Used to differentiate between Logpush and Edge Log Delivery jobs. Refer to [Kind](/logs/get-started/api-configuration/#kind) for details. +* **kind** (optional) - Used to differentiate between Logpush and Edge Log Delivery jobs. Refer to [Kind](/logs/logpush/logpush-job/api-configuration/#kind) for details. * **filter** (optional) - Refer to [Filters](/logs/logpush/logpush-job/filters/) for details. ### Response diff --git a/src/content/docs/logs/logpush/index.mdx b/src/content/docs/logs/logpush/index.mdx index b95f07866abeef4..c54fcd2a2909fcd 100644 --- a/src/content/docs/logs/logpush/index.mdx +++ b/src/content/docs/logs/logpush/index.mdx @@ -8,7 +8,7 @@ sidebar: import { FeatureTable, LinkButton } from "~/components" -Logpush delivers logs in batches as quickly as possible, with no minimum batch size, potentially delivering files more than once per minute. This capability enables Cloudflare to provide information almost in real time, in smaller file sizes. Users can configure the batch size [using the API](/logs/get-started/api-configuration/#max-upload-parameters) for improved control in case the log destination has specific requirements. +Logpush delivers logs in batches as quickly as possible, with no minimum batch size, potentially delivering files more than once per minute. This capability enables Cloudflare to provide information almost in real time, in smaller file sizes. Users can configure the batch size [using the API](/logs/logpush/logpush-job/api-configuration/#max-upload-parameters) for improved control in case the log destination has specific requirements. Logpush does not offer storage or search functionality for logs; its primary aim is to send logs as quickly as they arrive. diff --git a/src/content/docs/logs/get-started/api-configuration.mdx b/src/content/docs/logs/logpush/logpush-job/api-configuration.mdx similarity index 99% rename from src/content/docs/logs/get-started/api-configuration.mdx rename to src/content/docs/logs/logpush/logpush-job/api-configuration.mdx index 3cc8c56f79d8be9..a7665f0782564c5 100644 --- a/src/content/docs/logs/get-started/api-configuration.mdx +++ b/src/content/docs/logs/logpush/logpush-job/api-configuration.mdx @@ -2,7 +2,7 @@ pcx_content_type: concept title: API configuration sidebar: - order: 42 + order: 2 --- diff --git a/src/content/docs/logs/logpush/logpush-job/edge-log-delivery.mdx b/src/content/docs/logs/logpush/logpush-job/edge-log-delivery.mdx index b467a9578b34af1..ffdf78b8c9385c3 100644 --- a/src/content/docs/logs/logpush/logpush-job/edge-log-delivery.mdx +++ b/src/content/docs/logs/logpush/logpush-job/edge-log-delivery.mdx @@ -10,5 +10,5 @@ import { LinkButton } from "~/components" Edge Log Delivery allows customers to send logs directly from Cloudflare’s edge to their destination of choice. You can configure the maximum interval for your log batches between 30 seconds and five minutes. However, you cannot specify a minimum interval for log batches, meaning that log files may be sent in shorter intervals than the maximum specified. Compared to Logpush, Edge Log Delivery sends logs with lower latency, more frequently, and in smaller batches. -Edge Log Delivery is only available for HTTP request logs. Refer to the [API configuration](/logs/get-started/api-configuration/#kind) page for steps on how to configure a job to use Edge Log Delivery. +Edge Log Delivery is only available for HTTP request logs. Refer to the [API configuration](/logs/logpush/logpush-job/api-configuration/#kind) page for steps on how to configure a job to use Edge Log Delivery. diff --git a/src/content/docs/logs/logpush/logpush-job/enable-destinations/aws-s3.mdx b/src/content/docs/logs/logpush/logpush-job/enable-destinations/aws-s3.mdx index 96153829a5e6906..a813177475469f5 100644 --- a/src/content/docs/logs/logpush/logpush-job/enable-destinations/aws-s3.mdx +++ b/src/content/docs/logs/logpush/logpush-job/enable-destinations/aws-s3.mdx @@ -41,7 +41,7 @@ When you are done entering the destination details, select **Continue**. 10. In **Advanced Options**, you can: * Choose the format of timestamp fields in your logs (`RFC3339`(default),`Unix`, or `UnixNano`). - * Select a [sampling rate](/logs/get-started/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs. + * Select a [sampling rate](/logs/logpush/logpush-job/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs. * Enable redaction for `CVE-2021-44228`. This option will replace every occurrence of `${` with `x{`. 11. Select **Submit** once you are done configuring your logpush job. diff --git a/src/content/docs/logs/logpush/logpush-job/enable-destinations/azure.mdx b/src/content/docs/logs/logpush/logpush-job/enable-destinations/azure.mdx index 2f6a6a873ca561e..6c7a7215277ae94 100644 --- a/src/content/docs/logs/logpush/logpush-job/enable-destinations/azure.mdx +++ b/src/content/docs/logs/logpush/logpush-job/enable-destinations/azure.mdx @@ -35,7 +35,7 @@ When you are done entering the destination details, select **Continue**. 9. In **Advanced Options**, you can: * Choose the format of timestamp fields in your logs (`RFC3339`(default),`Unix`, or `UnixNano`). - * Select a [sampling rate](/logs/get-started/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs. + * Select a [sampling rate](/logs/logpush/logpush-job/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs. * Enable redaction for `CVE-2021-44228`. This option will replace every occurrence of `${` with `x{`. 10. Select **Submit** once you are done configuring your logpush job. diff --git a/src/content/docs/logs/logpush/logpush-job/enable-destinations/datadog.mdx b/src/content/docs/logs/logpush/logpush-job/enable-destinations/datadog.mdx index 83d69c04d584de3..3ee6d9768d817b9 100644 --- a/src/content/docs/logs/logpush/logpush-job/enable-destinations/datadog.mdx +++ b/src/content/docs/logs/logpush/logpush-job/enable-destinations/datadog.mdx @@ -48,7 +48,7 @@ When you are done entering the destination details, select **Continue**. 9. In **Advanced Options**, you can: * Choose the format of timestamp fields in your logs (`RFC3339`(default),`Unix`, or `UnixNano`). - * Select a [sampling rate](/logs/get-started/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs. + * Select a [sampling rate](/logs/logpush/logpush-job/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs. * Enable redaction for `CVE-2021-44228`. This option will replace every occurrence of `${` with `x{`. 10. Select **Submit** once you are done configuring your logpush job. diff --git a/src/content/docs/logs/logpush/logpush-job/enable-destinations/google-cloud-storage.mdx b/src/content/docs/logs/logpush/logpush-job/enable-destinations/google-cloud-storage.mdx index 1f9e0e3b6dd9698..b5312d0f4d91a3c 100644 --- a/src/content/docs/logs/logpush/logpush-job/enable-destinations/google-cloud-storage.mdx +++ b/src/content/docs/logs/logpush/logpush-job/enable-destinations/google-cloud-storage.mdx @@ -38,7 +38,7 @@ When you are done entering the destination details, select **Continue**. 10. In **Advanced Options**, you can: * Choose the format of timestamp fields in your logs (`RFC3339`(default),`Unix`, or `UnixNano`). - * Select a [sampling rate](/logs/get-started/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs. + * Select a [sampling rate](/logs/logpush/logpush-job/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs. * Enable redaction for `CVE-2021-44228`. This option will replace every occurrence of `${` with `x{`. 11. Select **Submit** once you are done configuring your logpush job. diff --git a/src/content/docs/logs/logpush/logpush-job/enable-destinations/http.mdx b/src/content/docs/logs/logpush/logpush-job/enable-destinations/http.mdx index 5a726927b45a758..530a4a7d0f5bde2 100644 --- a/src/content/docs/logs/logpush/logpush-job/enable-destinations/http.mdx +++ b/src/content/docs/logs/logpush/logpush-job/enable-destinations/http.mdx @@ -34,14 +34,14 @@ Cloudflare expects that the endpoint is available over HTTPS, using a trusted ce 9. In **Advanced Options**, you can: * Choose the format of timestamp fields in your logs (`RFC3339`(default),`Unix`, or `UnixNano`). - * Select a [sampling rate](/logs/get-started/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs. + * Select a [sampling rate](/logs/logpush/logpush-job/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs. * Enable redaction for `CVE-2021-44228`. This option will replace every occurrence of `${` with `x{`. 10. Select **Submit** once you are done configuring your logpush job. ## Manage via API -To create a Logpush job, make a `POST` request to the [Logpush job creation endpoint URL](/logs/get-started/api-configuration/) with the appropriate parameters. +To create a Logpush job, make a `POST` request to the [Logpush job creation endpoint URL](/logs/logpush/logpush-job/api-configuration/) with the appropriate parameters. The supported parameters are as follows: diff --git a/src/content/docs/logs/logpush/logpush-job/enable-destinations/new-relic.mdx b/src/content/docs/logs/logpush/logpush-job/enable-destinations/new-relic.mdx index 7bd867a14c195e9..2eb0f9c4904346d 100644 --- a/src/content/docs/logs/logpush/logpush-job/enable-destinations/new-relic.mdx +++ b/src/content/docs/logs/logpush/logpush-job/enable-destinations/new-relic.mdx @@ -44,7 +44,7 @@ When you are done entering the destination details, select **Continue**. 9. In **Advanced Options**, you can: * Choose the format of timestamp fields in your logs (`RFC3339`(default),`Unix`, or `UnixNano`). - * Select a [sampling rate](/logs/get-started/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs. + * Select a [sampling rate](/logs/logpush/logpush-job/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs. * Enable redaction for `CVE-2021-44228`. This option will replace every occurrence of `${` with `x{`. 10. Select **Submit** once you are done configuring your logpush job. diff --git a/src/content/docs/logs/logpush/logpush-job/enable-destinations/other-providers.mdx b/src/content/docs/logs/logpush/logpush-job/enable-destinations/other-providers.mdx index f78a5f64f45d92a..060ae454457af52 100644 --- a/src/content/docs/logs/logpush/logpush-job/enable-destinations/other-providers.mdx +++ b/src/content/docs/logs/logpush/logpush-job/enable-destinations/other-providers.mdx @@ -33,4 +33,4 @@ To get started: - Zone ID - Destination access details for your cloud service provider -2. Configure your Logpush job. For more information on how to configure a Logpush job, refer to [API configuration](/logs/get-started/api-configuration/). +2. Configure your Logpush job. For more information on how to configure a Logpush job, refer to [API configuration](/logs/logpush/logpush-job/api-configuration/). diff --git a/src/content/docs/logs/logpush/logpush-job/enable-destinations/r2.mdx b/src/content/docs/logs/logpush/logpush-job/enable-destinations/r2.mdx index 6f04cf0fa3e1480..8f9f33563e23205 100644 --- a/src/content/docs/logs/logpush/logpush-job/enable-destinations/r2.mdx +++ b/src/content/docs/logs/logpush/logpush-job/enable-destinations/r2.mdx @@ -77,7 +77,7 @@ When you are done entering the destination details, select **Continue**. 9. In **Advanced Options**, you can: * Choose the format of timestamp fields in your logs (`RFC3339`(default),`Unix`, or `UnixNano`). - * Select a [sampling rate](/logs/get-started/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs. + * Select a [sampling rate](/logs/logpush/logpush-job/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs. * Enable redaction for `CVE-2021-44228`. This option will replace every occurrence of `${` with `x{`. 10. Select **Submit** once you are done configuring your logpush job. @@ -99,7 +99,7 @@ r2:///{DATE}?account-id=&access-key-id=/logpush/jobs" \ @@ -69,7 +69,7 @@ curl "https://api.cloudflare.com/client/v4/accounts//logpush/jobs" \ }' | jq . ``` -In Logpush, you can configure [filters](/logs/logpush/logpush-job/filters/) and a [sampling rate](/logs/get-started/api-configuration/#sampling-rate) to have more control of the volume of data that is sent to your configured destination. For example, if you only want to receive logs for requests that did not result in an exception, add the following `filter` JSON property below `output_options`: +In Logpush, you can configure [filters](/logs/logpush/logpush-job/filters/) and a [sampling rate](/logs/logpush/logpush-job/api-configuration/#sampling-rate) to have more control of the volume of data that is sent to your configured destination. For example, if you only want to receive logs for requests that did not result in an exception, add the following `filter` JSON property below `output_options`: `"filter":"{\"where\": {\"key\":\"Outcome\",\"operator\":\"!eq\",\"value\":\"exception\"}}"` From fa164727ca785e4d25d8cae6fdde5b3ff84890dc Mon Sep 17 00:00:00 2001 From: Angela Costa Date: Thu, 24 Jul 2025 10:36:40 +0100 Subject: [PATCH 2/2] Corrects links --- .../docs/magic-firewall/how-to/use-logpush-with-ids.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/content/docs/magic-firewall/how-to/use-logpush-with-ids.mdx b/src/content/docs/magic-firewall/how-to/use-logpush-with-ids.mdx index c4a5e56369f4d54..c56756c839cc5f6 100644 --- a/src/content/docs/magic-firewall/how-to/use-logpush-with-ids.mdx +++ b/src/content/docs/magic-firewall/how-to/use-logpush-with-ids.mdx @@ -6,7 +6,7 @@ pcx_content_type: concept You can use Logpush with Magic Firewall IDS to log detected risks: -1. Consult the [Logpush Destination docs](/logs/get-started/api-configuration#destination) to learn about what destinations Logpush supports. The documentation will also instruct you on how to correctly format the destination URL for Logpush. +1. Consult the [Logpush Destination docs](/logs/logpush/logpush-job/api-configuration/#destination) to learn about what destinations Logpush supports. The documentation will also instruct you on how to correctly format the destination URL for Logpush. 2. Follow the [Manage Lopush with cURL](/logs/logpush/examples/example-logpush-curl/) tutorial to validate your Logpush destination and define a Logpush job. @@ -18,4 +18,4 @@ You can use Logpush with Magic Firewall IDS to log detected risks: * When creating the Logpush job, the dataset field should equal `magic_ids_detections`. -* Timestamps by default are unixnano. Consult the [Logpush Options docs](/logs/get-started/api-configuration#options) to learn what format you can choose that will be compatible with your destination and/or expectations. Note that all options must be added *after* all fields you want from the Logpush job, akin to URL parameters. +* Timestamps by default are unixnano. Consult the [Logpush Options docs](/logs/logpush/logpush-job/api-configuration/#options) to learn what format you can choose that will be compatible with your destination and/or expectations. Note that all options must be added *after* all fields you want from the Logpush job, akin to URL parameters.