API Reference

R2 Data Catalog

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Maintenance Configs

Get catalog maintenance configuration

client.r2DataCatalog.maintenanceConfigs.get(stringbucketName, MaintenanceConfigGetParams { account_id } params, RequestOptionsoptions?): MaintenanceConfigGetResponse { credential_status, maintenance_config }

GET/accounts/{account_id}/r2-catalog/{bucket_name}/maintenance-configs

Update catalog maintenance configuration

client.r2DataCatalog.maintenanceConfigs.update(stringbucketName, MaintenanceConfigUpdateParams { account_id, compaction, snapshot_expiration } params, RequestOptionsoptions?): MaintenanceConfigUpdateResponse { compaction, snapshot_expiration }

POST/accounts/{account_id}/r2-catalog/{bucket_name}/maintenance-configs

ModelsExpand Collapse

MaintenanceConfigGetResponse { credential_status, maintenance_config }

Contains maintenance configuration and credential status.

credential_status: "present" | "absent"

Shows the credential configuration status.

One of the following:

"present"

"absent"

maintenance_config: MaintenanceConfig { compaction, snapshot_expiration }

Configures maintenance for the catalog.

compaction?: Compaction { state, target_size_mb }

Configures compaction for catalog maintenance.

state: "enabled" | "disabled"

Specifies the state of maintenance operations.

One of the following:

"enabled"

"disabled"

target_size_mb: "64" | "128" | "256" | "512"

Sets the target file size for compaction in megabytes. Defaults to “128”.

One of the following:

"64"

"128"

"256"

"512"

snapshot_expiration?: SnapshotExpiration { max_snapshot_age, min_snapshots_to_keep, state }

Configures snapshot expiration settings.

max_snapshot_age: string

Specifies the maximum age for snapshots. The system deletes snapshots older than this age. Format: where unit is d (days), h (hours), m (minutes), or s (seconds). Examples: “7d” (7 days), “48h” (48 hours), “2880m” (2,880 minutes). Defaults to “7d”.

min_snapshots_to_keep: number

Specifies the minimum number of snapshots to retain. Defaults to 100.

formatint64

minimum1

state: "enabled" | "disabled"

Specifies the state of maintenance operations.

One of the following:

"enabled"

"disabled"

MaintenanceConfigUpdateResponse { compaction, snapshot_expiration }

Configures maintenance for the catalog.

compaction?: Compaction { state, target_size_mb }

Configures compaction for catalog maintenance.

state: "enabled" | "disabled"

Specifies the state of maintenance operations.

One of the following:

"enabled"

"disabled"

target_size_mb: "64" | "128" | "256" | "512"

Sets the target file size for compaction in megabytes. Defaults to “128”.

One of the following:

"64"

"128"

"256"

"512"

snapshot_expiration?: SnapshotExpiration { max_snapshot_age, min_snapshots_to_keep, state }

Configures snapshot expiration settings.

max_snapshot_age: string

Specifies the maximum age for snapshots. The system deletes snapshots older than this age. Format: where unit is d (days), h (hours), m (minutes), or s (seconds). Examples: “7d” (7 days), “48h” (48 hours), “2880m” (2,880 minutes). Defaults to “7d”.

min_snapshots_to_keep: number

Specifies the minimum number of snapshots to retain. Defaults to 100.

formatint64

minimum1

state: "enabled" | "disabled"

Specifies the state of maintenance operations.

One of the following:

"enabled"

"disabled"