Skip to content

Improve API and documentation clarity #22181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: production
Choose a base branch
from
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Sometimes there will be too many results to display via the default page size, f
"total_count": 200,
```

There are two query parameter options, which can be combined to paginate across the results.
Two query parameter options exist, which can be combined to paginate across the results.

- `page=x` enables you to select a specific page.
- `per_page=xx` enables you to adjust the number of results displayed on a page. If you select too many, you may get a timeout.
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/fundamentals/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ With the version 5 release of Cloudflare's Terraform Provider, Terraform resourc

Warning: Version 5 of the Cloudflare Terraform Provider is a ground-up rewrite of the provider and introduces breaking changes.

Refer to the [upgrade guide](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/guides/version-5-upgrade) for best practices, or the [blog post on automatically generating Cloudflares Terraform Provider](https://blog.cloudflare.com/automatically-generating-cloudflares-terraform-provider/) for more information.
Refer to the [upgrade guide](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/guides/version-5-upgrade) for best practices, or the [blog post on automatically generating Cloudflare's Terraform Provider](https://blog.cloudflare.com/automatically-generating-cloudflares-terraform-provider/) for more information.

## 2024-12-18

Expand Down Expand Up @@ -67,4 +67,4 @@ Refer to the [Terraform documentation](https://registry.terraform.io/providers/c

Cloudflare's API documentation is now [available in preview](/api/) with new automatically generated documentation. This documentation includes code snippets that refer to language-specific SDKs to make it easier to get started than ever.

Refer to the [blog post](https://blog.cloudflare.com/automatically-generating-cloudflares-terraform-provider/) for more details.
Refer to the [blog post](https://blog.cloudflare.com/automatically-generating-cloudflares-terraform-provider/) for more details.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A **Cloudflare Ray ID** is an identifier given to every request that goes throug

Ray IDs are particularly useful when evaluating Security Events for patterns or false positives or more generally understanding your application traffic.

Ray IDs are added as a [request header, cf-ray](/fundamentals/reference/http-headers/#cf-ray), to the connection from Cloudflare to the origin web server.
Ray IDs are added as a [request header, cf-ray](/fundamentals/reference/http-headers/#cf-ray), to the connection from Cloudflare to the origin web server.
As such the Ray IDs can be found using the Developer Tools in your browser or using curl with the `-v` option to show the headers.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Currently Cloudflare only supports Session Affinity in "orange-cloud" (proxied)

Cloudflare's [bot products](/bots/) identify and mitigate automated traffic to protect your site from bad bots. Cloudflare places the `__cf_bm` cookie on end-user devices that access customer sites protected by Bot Management or Bot Fight Mode. The `__cf_bm` cookie is necessary for these bot solutions to function properly.

This cookie expires after 30 minutes of continuous inactivity by the end user. The cookie contains information related to the calculation of Cloudflares proprietary bot score and, when Anomaly Detection is enabled on Bot Management, a session identifier. The information in the cookie (other than time-related information) is encrypted and can only be decrypted by Cloudflare.
This cookie expires after 30 minutes of continuous inactivity by the end user. The cookie contains information related to the calculation of Cloudflare's proprietary bot score and, when Anomaly Detection is enabled on Bot Management, a session identifier. The information in the cookie (other than time-related information) is encrypted and can only be decrypted by Cloudflare.

A separate `__cf_bm` cookie is generated for each site that an end user visits, as Cloudflare does not track users from site to site or from session to session. The `__cf_bm` cookie is generated independently by Cloudflare, and does not correspond to any user ID or other identifiers in a customer’s web application.

Expand Down Expand Up @@ -60,7 +60,7 @@ The `cf_use_ob` cookie informs Cloudflare to fetch the requested resource from t

### \_\_cfwaitingroom for Cloudflare Waiting Room

[Cloudflares Waiting Room](/waiting-room/) product enables a waiting room for a particular host and path combination within a zone. Visitors are put in the waiting room and provided an estimate of when they will be allowed to access the application, if not immediately available.
[Cloudflare's Waiting Room](/waiting-room/) product enables a waiting room for a particular host and path combination within a zone. Visitors are put in the waiting room and provided an estimate of when they will be allowed to access the application, if not immediately available.

The `__cfwaitingroom` cookie is only used to track visitors that access a waiting room enabled host and path combination for a zone. Visitors using a browser that does not accept cookies cannot visit the host and path combination while the waiting room is active. For more details, refer to [Waiting Room cookies](/waiting-room/reference/waiting-room-cookie/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To learn more about configuring a CSP in general, refer to the [Mozilla document

## Using a CSP with Cloudflare

Cloudflares [CDN](/cache/) is compatible with CSP.
Cloudflare's [CDN](/cache/) is compatible with CSP.

Cloudflare does not:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Project Cybersafe Schools grants eligible schools with free access to Cloudflare

## Children’s Internet Protection Act (CIPA)

<Render file="cybersafe-description" product="fundamentals" />
<Render file='cybersafe-description' product='fundamentals' />

### CIPA Requirements

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: Delivering Videos with Cloudflare

## Using Cloudflare's Services

Cloudflare launched in 2010 believing everyone deserves a secure, fast, reliable web presence. We did not think you should have to pay more when you came under cyber attack, so we offered free and fixed-rate pricing for websites. That worked because most websites don't consume much bandwidth, and so we could provide our services in an affordable way to everyone. From the beginning, we prohibited streaming video content using our bandwidth. While you could embed a video from another provider, we limited your ability to use our services to deliver video bits from our network to your visitors. This is because every second of a typical video requires as much bandwidth as loading a full web page.
This restriction exists because every second of a typical video requires as much bandwidth as loading a full web page.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hallucination city.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for heads up!


Over time we recognized that some of our customers wanted to stream video using our network. To accommodate them, we developed our [Stream](https://www.cloudflare.com/products/cloudflare-stream/) product. Stream delivers great performance at an affordable rate charged based on how much load you place on our network.

Expand Down Expand Up @@ -35,17 +35,17 @@ Cloudflare permits the delivery of video content with specific paid services. If

[Stream](https://www.cloudflare.com/products/cloudflare-stream/) is a video-on-demand platform for building video applications. Stream encodes, stores, and delivers optimized video formatted for different devices and network connections.

To get started with Stream, visit **Stream** from your Dashboard or [sign up](https://dash.cloudflare.com/sign-up/stream). Your Stream videos are not attached to a domain in your Cloudflare account, and you don't need a domain on Cloudflare to use Stream.
To get started with Stream, visit **Stream** from your Dashboard or [sign up](https://dash.cloudflare.com/sign-up/stream). Your Stream videos are not attached to a domain in your Cloudflare account, and you do not need a domain on Cloudflare to use Stream.

### Option 2: Stream Delivery (Enterprise only)

[Stream Delivery](https://www.cloudflare.com/products/stream-delivery/) offers caching and delivery of video content through Cloudflare data centers around the globe. This CDN feature is only available on the Cloudflare Enterprise Plan. Please [contact sales](https://www.cloudflare.com/products/stream-delivery/#) if youd like to explore this option.
[Stream Delivery](https://www.cloudflare.com/products/stream-delivery/) offers caching and delivery of video content through Cloudflare data centers around the globe. This CDN feature is only available on the Cloudflare Enterprise Plan. Please [contact sales](https://www.cloudflare.com/products/stream-delivery/#) if you'd like to explore this option.

***

## Getting information on the content you are delivering

If you need more information about the content your zone is serving (e.g. content type), you can use the following tools:
If you need more information about the content your zone is serving (for example, content type), you can use the following tools:

* Cache Analytics users: Open the **Caching tab** on the Dashboard to filter by content type and identify the type of traffic you are transferring.
* Users without Cache Analytics: Open the **Analytics tab** on the Dashboard and select the **Performance** section for information about the content you are serving.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ To get the URL for a specific piece of content on a webpage:

6. Copy the URL.

This is typically the most specific and helpful URL that someone reporting abuse can provide to Cloudflare, so that Cloudflare can correctly identify any services Cloudflare may be providing with respect to that content.
Providing the most specific and helpful URL enables Cloudflare to correctly identify any services it may be providing with respect to that content.

## Submitting the abuse report

Once you have identified the URL for the specific asset, you can [submit an abuse report](https://abuse.cloudflare.com) through Cloudflares online abuse reporting process.
Once you have identified the URL for the specific asset, you can [submit an abuse report](https://abuse.cloudflare.com) through Cloudflare's online abuse reporting process.

You can learn more about the process, and what you can expect from Cloudflare in response to such abuse reports, from [our abuse policy](https://www.cloudflare.com/trust-hub/reporting-abuse/).
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Targets like `*.cloudflare.com` or other Cloudflare-owned destinations are only
### Penetration testing

- **Network behavior**:
- Cloudflare's [anycast network](/fundamentals/concepts/how-cloudflare-works/) will report ports other than `80` and `443` as open due to its shared infrastructure and the nature of Cloudflare's proxy. This is expected behavior and does not indicate a vulnerability.
- Cloudflare's [anycast network](/fundamentals/concepts/how-cloudflare-works/) will report ports other than `80` and `443` as open due to its shared infrastructure and the nature of Cloudflare's proxy. The open port reporting is expected behavior and does not indicate a vulnerability.
- Tools like Netcat may list [non-standard HTTP ports](/fundamentals/reference/network-ports/) as open; however, these ports are open solely for Cloudflare's routing purposes and do not necessarily indicate that a connection can be established with the customer's origin over those ports.
- **Known false positives**: Any findings related to the [ROBOT vulnerability](/ssl/reference/compliance-and-vulnerabilities/#return-of-bleichenbachers-oracle-threat-robot) are false positives when the customer's assets are behind Cloudflare.
- **Customer security review**: During penetration testing, customers should be aware of the Cloudflare security and performance features, configurations, and rules active on their account or zone. After completing the test, it is recommended that customers review their security posture and make any necessary adjustments based on the findings.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Most challenges are quick and should take only a few seconds to complete. If it
:::note
If the issue persists, try switching to a different network or device to rule out any issues with your browser environment.

Make sure that your browser is updated to the latest version.
Ensure your browser is updated to the latest version to maintain compatibility.
:::

## Troubleshooting
Expand All @@ -32,4 +32,4 @@ Follow the steps below to ensure that your environment is properly configured.

<Render file="troubleshooting-steps" product="turnstile"/>

If none of the above resolves your issue, contact the website administrator with the [error code](/turnstile/troubleshooting/client-side-errors/error-codes/) and Ray ID or submit a [feedback report](/turnstile/troubleshooting/feedback-reports/) through the Turnstile widget by selecting **Submit Feedback**.
If none of the above resolves your issue, contact the website administrator with the [error code](/turnstile/troubleshooting/client-side-errors/error-codes/) and Ray ID or submit a [feedback report](/turnstile/troubleshooting/feedback-reports/) through the Turnstile widget by selecting **Submit Feedback**.