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

r2_data_catalog.maintenance_configs.get(strbucket_name, MaintenanceConfigGetParams**kwargs) -> MaintenanceConfigGetResponse

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

Update catalog maintenance configuration

r2_data_catalog.maintenance_configs.update(strbucket_name, MaintenanceConfigUpdateParams**kwargs) -> MaintenanceConfigUpdateResponse

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

ModelsExpand Collapse

class MaintenanceConfigGetResponse: …

Contains maintenance configuration and credential status.

credential_status: Literal["present", "absent"]

Shows the credential configuration status.

One of the following:

"present"

"absent"

maintenance_config: MaintenanceConfig

Configures maintenance for the catalog.

compaction: Optional[MaintenanceConfigCompaction]

Configures compaction for catalog maintenance.

state: Literal["enabled", "disabled"]

Specifies the state of maintenance operations.

One of the following:

"enabled"

"disabled"

target_size_mb: Literal["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: Optional[MaintenanceConfigSnapshotExpiration]

Configures snapshot expiration settings.

max_snapshot_age: str

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: int

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

formatint64

minimum1

state: Literal["enabled", "disabled"]

Specifies the state of maintenance operations.

One of the following:

"enabled"

"disabled"

class MaintenanceConfigUpdateResponse: …

Configures maintenance for the catalog.

compaction: Optional[Compaction]

Configures compaction for catalog maintenance.

state: Literal["enabled", "disabled"]

Specifies the state of maintenance operations.

One of the following:

"enabled"

"disabled"

target_size_mb: Literal["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: Optional[SnapshotExpiration]

Configures snapshot expiration settings.

max_snapshot_age: str

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: int

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

formatint64

minimum1

state: Literal["enabled", "disabled"]

Specifies the state of maintenance operations.

One of the following:

"enabled"

"disabled"