Skip to content

[R2] Updating instructions regarding R2 APIs #25143

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Sep 15, 2025
Merged

[R2] Updating instructions regarding R2 APIs #25143

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0a76d7
Updating instructions to match new Dash
Oxyjun Sep 15, 2025
e599c30
Apply suggestions from code review
Oxyjun Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/content/docs/r2/api/tokens.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ import { DashButton } from "~/components";

You can generate an API token to serve as the Access Key for usage with existing S3-compatible SDKs or XML APIs.

:::note
This page contains instructions on generating API tokens _specifically_ for R2. Note that this is different from generating API tokens for other service, as documented in [Create API token](/fundamentals/api/get-started/create-token/).
:::

You must purchase R2 before you can generate an API token.

To create an API token:
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/r2/data-catalog/get-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,13 +96,13 @@ When you run this command, take note of the "Warehouse" and "Catalog URI". You w

## 3. Create an API token

Iceberg clients (including [PyIceberg](https://py.iceberg.apache.org/)) must authenticate to the catalog with a [Cloudflare API token](/fundamentals/api/get-started/create-token/) that has both R2 and catalog permissions.
Iceberg clients (including [PyIceberg](https://py.iceberg.apache.org/)) must authenticate to the catalog with a [R2 API token](/r2/api/tokens/) that has both R2 and catalog permissions.

<Steps>
1. In the Cloudflare dashboard, go to the **R2 object storage** page.

<DashButton url="/?to=/:account/r2/overview" />
2. Expand the **API** dropdown and select **Manage API tokens**.
2. Select **Manage API tokens**.

3. Select **Create API token**.

Expand Down