How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cloudflare R2 R2 Catalog Management API

The R2 Catalog Management API from Cloudflare R2 — 4 operation(s) for r2 catalog management.

Cloudflare R2 R2 Catalog Management API is one of 14 APIs that Cloudflare R2 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include R2 Catalog Management. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against a single base URL, https://api.cloudflare.com/client/v4.

4 operations 4 paths 17 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Base URL
https://.r2.cloudflarestorage.com
Authentication
API Key, API Key, HTTP Bearer, API Key
Terms of Service
Resource Areas
1

Authentication & Security 4

Cloudflare R2 R2 Catalog Management API declares 4 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Email (api_email). An API key is passed in the header as X-Auth-Key (api_key). It accepts HTTP bearer tokens (api_token). An API key is passed in the header as X-Auth-User-Service-Key (user_service_key).

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

R2 Catalog Management 4
GET
/accounts/{account_id}/r2-catalog
List R2 catalogs
list-catalogs 1 param → 200400401403500
GET
/accounts/{account_id}/r2-catalog/{bucket_name}
Get R2 catalog details
get-catalog-details 2 params → 200400401403404500
POST
/accounts/{account_id}/r2-catalog/{bucket_name}/disable
Disable R2 catalog
disable-catalog 2 params → 204400401403404500
POST
/accounts/{account_id}/r2-catalog/{bucket_name}/enable
Enable R2 bucket as a catalog
enable-catalog 2 params → 200400401403404409500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are r2-data-catalog_catalog (6 properties), r2-data-catalog_api-response-single (3 properties), r2-data-catalog_snapshot-expiration-config (3 properties), r2-data-catalog_api-response-common-failure (3 properties). Each schema is shown below with its type and property counts.

r2-data-catalog_api-response-single
object
3 properties 3 required
r2-data-catalog_catalog-maintenance-state
string
Specifies the state of maintenance operations.
r2-data-catalog_api-response-success
boolean
Indicates whether the API call was successful.
r2-data-catalog_api-response-errors
array
Contains errors if the API call was unsuccessful.
r2-data-catalog_api-response-common-failure
object
3 properties
r2-data-catalog_account-id
string
Use this to identify the account.
r2-data-catalog_snapshot-expiration-config
object
Configures snapshot expiration settings.
3 properties 3 required
r2-data-catalog_catalog
object
Contains R2 Data Catalog information.
6 properties 4 required
r2-data-catalog_catalog-maintenance-config
object
Configures maintenance for the catalog.
2 properties
r2-data-catalog_catalog-list
object
Contains the list of catalogs.
1 property 1 required
r2-data-catalog_catalog-compaction-config
object
Configures compaction for catalog maintenance.
2 properties 2 required
r2-data-catalog_api-response-messages
array
Contains informational messages.
r2-data-catalog_credential-status
string
Shows the credential configuration status.
r2-data-catalog_catalog-status
string
Indicates the status of the catalog.
r2-data-catalog_catalog-activation-response
object
Contains response from activating an R2 bucket as a catalog.
2 properties 2 required
r2-data-catalog_bucket-name
string
Specifies the R2 bucket name.
r2-data-catalog_catalog-target-file-size
string
Sets the target file size for compaction in megabytes. Defaults to "128".

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudflare-r2-r2-catalog-management-api-openapi.yml Raw ↑

Other APIs Cloudflare R2 publishes across the network.

Cloudflare R2 Buckets API
Cloudflare R2 CORS API
Cloudflare R2 Credential Management API
Cloudflare R2 Lifecycle API
Cloudflare R2 Maintenance Configuration API
Cloudflare R2 Multipart Upload API
Cloudflare R2 Namespace Management API
Cloudflare R2 Objects API
Cloudflare R2 R2 Account API
Cloudflare R2 R2 Bucket API
Cloudflare R2 R2 Object API
Cloudflare R2 Table Maintenance Configuration API
Where this information came from

This is an independent, third-party profile of Cloudflare R2 R2 Catalog Management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.