---
title: Get catalog maintenance configuration
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Basin Catalog](https://developers.cloudflare.com/api/resources/basin_catalog)
[Maintenance Configs](https://developers.cloudflare.com/api/resources/basin_catalog/subresources/maintenance_configs)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Get catalog maintenance configuration
GET/accounts/{account\_id}/basin-catalog/{bucket\_name}/maintenance-configs
Retrieve the maintenance configuration for a specific catalog, including compaction settings and credential status.
##### Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
**Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required)
`Workers R2 Data Catalog Write``Workers R2 Data Catalog Read`
##### P ath ParametersExpand Collapse
account\_id: string
Use this to identify the account.
[Link to this property](<#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)
bucket\_name: string
Specifies the R2 bucket name.
maxLength63
minLength3
[Link to this property](<#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20bucket_name%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of object {code, message }
Contains errors if the API call was unsuccessful.
code: number
Specifies the error code.
Link to this property
message: string
Describes the error.
Link to this property
[Link to this property](<#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of object {code, message }
Contains informational messages.
code: number
Specifies the message code.
Link to this property
message: string
Contains the message text.
Link to this property
[Link to this property](<#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
success: boolean
Indicates whether the API call was successful.
[Link to this property](<#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result: optional object {credential\_status, maintenance\_config }
Contains maintenance configuration and credential status.
credential\_status: "present"or "absent"
Shows the credential configuration status.
One of the following:
"present"
Link to this property
"absent"
Link to this property
Link to this property
maintenance\_config: object {compaction, interval, snapshot\_expiration }
Configures maintenance for the catalog.
compaction: optional object {state, target\_size\_mb }
Configures compaction for catalog maintenance.
state: "enabled"or "disabled"
Specifies the state of maintenance operations.
One of the following:
"enabled"
Link to this property
"disabled"
Link to this property
Link to this property
target\_size\_mb: "64"or "128"or "256"or "512"
Sets the target file size for compaction in megabytes. Defaults to “128”.
One of the following:
"64"
Link to this property
"128"
Link to this property
"256"
Link to this property
"512"
Link to this property
Link to this property
Link to this property
interval: optional string
Scheduling interval between normal table maintenance runs.
Link to this property
snapshot\_expiration: optional object {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”.
Link to this property
min\_snapshots\_to\_keep: number
Specifies the minimum number of snapshots to retain. Defaults to 100.
formatint64
minimum1
Link to this property
state: "enabled"or "disabled"
Specifies the state of maintenance operations.
One of the following:
"enabled"
Link to this property
"disabled"
Link to this property
Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
### Get catalog maintenance configuration
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/basin-catalog/$BUCKET_NAME/maintenance-configs \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
200 example
```
{
"errors": [],
"messages": [],
"result": {
"credential_status": "present",
"maintenance_config": {
"compaction": {
"state": "enabled",
"target_size_mb": "128"
},
"snapshot_expiration": {
"max_snapshot_age": "7d",
"min_snapshots_to_keep": 100,
"state": "enabled"
}
}
},
"success": true
}
```
##### Returns Examples
200 example
```
{
"errors": [],
"messages": [],
"result": {
"credential_status": "present",
"maintenance_config": {
"compaction": {
"state": "enabled",
"target_size_mb": "128"
},
"snapshot_expiration": {
"max_snapshot_age": "7d",
"min_snapshots_to_keep": 100,
"state": "enabled"
}
}
},
"success": true
}
```