Cloudflare Docs
R2
Cloudflare Docs
R2
Edit this page
Give us feedback
Set theme to dark (⇧+D)
  1. Products
  2. R2
  3. ...
  4. S3
  5. Authentication

Authentication

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

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

To create an API token:

  1. In Account Home, select R2.
  2. Under Account details, select Manage R2 API tokens.
  3. Select Create API token.
  4. Select the R2 Token text to edit your API token name.
  5. Under Permissions, choose a permission types for your token. Refer to Permissions for information about each option.
  6. (Optional) If you select the Object Read and Write or Object Read permissions, you can scope your token to a set of buckets.
  7. Select Create API Token.

After your token has been successfully created, review your Secret Access Key and Access Key ID values. These may often be referred to as Client Secret and Client ID, respectively.

You will also need to configure the endpoint in your S3 client to https://<ACCOUNT_ID>.r2.cloudflarestorage.com.

Find your account ID in the Cloudflare dashboard.

Buckets created with jurisdictions must be accessed via jurisdiction-specific endpoints:

  • European Union (EU): https://<ACCOUNT_ID>.eu.r2.cloudflarestorage.com
  • FedRAMP: https://<ACCOUNT_ID>.fedramp.r2.cloudflarestorage.com

​​ Permissions

PermissionDescription
Admin Read and WriteAllows the ability to create, list and delete buckets, and edit bucket configurations in addition to list, write, and read object access.
Admin Read onlyAllows the ability to list buckets and view bucket configuration in addition to list and read object access.
Object Read & WriteAllows the ability to read, write, and list objects in specific buckets.
Object Read onlyAllows the ability to read and list objects in specific buckets.

​​ 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 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 = <accessKeyId>
AWS_SECRET_ACCESS_KEY = <secretAccessKey>
AWS_SESSION_TOKEN = <sessionToken>