---
title: Update catalog maintenance configuration
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/go)

[Basin Catalog](https://developers.cloudflare.com/api/go/resources/basin_catalog)

[Maintenance Configs](https://developers.cloudflare.com/api/go/resources/basin_catalog/subresources/maintenance_configs)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Update catalog maintenance configuration

client.BasinCatalog.MaintenanceConfigs.Update(ctx, bucketName, params) (\*[MaintenanceConfigUpdateResponse](<https://developers.cloudflare.com/api/go/resources/basin_catalog#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)>), error)

POST/accounts/{account\_id}/basin-catalog/{bucket\_name}/maintenance-configs

Update the maintenance configuration for a catalog. This allows you to enable or disable compaction and adjust target file sizes for optimization.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### Accepted Permissions (at least one required)

`Workers R2 Data Catalog Write`

##### ParametersExpand Collapse

bucketName string

Specifies the R2 bucket name.

maxLength63

minLength3

[Link to this property](<#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20bucket_name%20%3E%20(schema)>)

<details>

<summary>

params MaintenanceConfigUpdateParams

</summary>

AccountID param.Field\[string]

Path param: Use this to identify the account.

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20account_id">Link to this property</a>

<details>

<summary>

Compaction param.Field\[<a href="https://developers.cloudflare.com/api/go/resources/basin_catalog/subresources/maintenance_configs/methods/update#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20compaction%20%3E%20(schema)">MaintenanceConfigUpdateParamsCompaction</a>]Optional

Body param: Updates compaction configuration (all fields optional).

</summary>

<details>

<summary>

State MaintenanceConfigUpdateParamsCompactionStateOptional

Specifies the state of maintenance operations.

</summary>

One of the following:

const MaintenanceConfigUpdateParamsCompactionStateEnabled MaintenanceConfigUpdateParamsCompactionState = "enabled"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20compaction%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%200">Link to this property</a>

const MaintenanceConfigUpdateParamsCompactionStateDisabled MaintenanceConfigUpdateParamsCompactionState = "disabled"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20compaction%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20compaction%20%3E%20(schema)%20%3E%20(property)%20state">Link to this property</a>

<details>

<summary>

TargetSizeMB MaintenanceConfigUpdateParamsCompactionTargetSizeMBOptional

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

</summary>

One of the following:

const MaintenanceConfigUpdateParamsCompactionTargetSizeMB64 MaintenanceConfigUpdateParamsCompactionTargetSizeMB = "64"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20compaction%20%3E%20(schema)%20%3E%20(property)%20target_size_mb%20%3E%20(member)%200">Link to this property</a>

const MaintenanceConfigUpdateParamsCompactionTargetSizeMB128 MaintenanceConfigUpdateParamsCompactionTargetSizeMB = "128"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20compaction%20%3E%20(schema)%20%3E%20(property)%20target_size_mb%20%3E%20(member)%201">Link to this property</a>

const MaintenanceConfigUpdateParamsCompactionTargetSizeMB256 MaintenanceConfigUpdateParamsCompactionTargetSizeMB = "256"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20compaction%20%3E%20(schema)%20%3E%20(property)%20target_size_mb%20%3E%20(member)%202">Link to this property</a>

const MaintenanceConfigUpdateParamsCompactionTargetSizeMB512 MaintenanceConfigUpdateParamsCompactionTargetSizeMB = "512"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20compaction%20%3E%20(schema)%20%3E%20(property)%20target_size_mb%20%3E%20(member)%203">Link to this property</a>

</details>

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20compaction%20%3E%20(schema)%20%3E%20(property)%20target_size_mb">Link to this property</a>

</details>

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20compaction">Link to this property</a>

<details>

<summary>

SnapshotExpiration param.Field\[<a href="https://developers.cloudflare.com/api/go/resources/basin_catalog/subresources/maintenance_configs/methods/update#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20snapshot_expiration%20%3E%20(schema)">MaintenanceConfigUpdateParamsSnapshotExpiration</a>]Optional

Body param: Updates snapshot expiration configuration (all fields optional).

</summary>

MaxSnapshotAge stringOptional

Updates the maximum age for snapshots optionally.

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20snapshot_expiration%20%3E%20(schema)%20%3E%20(property)%20max_snapshot_age">Link to this property</a>

MinSnapshotsToKeep int64Optional

Updates the minimum number of snapshots to retain optionally.

formatint64

minimum1

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20snapshot_expiration%20%3E%20(schema)%20%3E%20(property)%20min_snapshots_to_keep">Link to this property</a>

<details>

<summary>

State MaintenanceConfigUpdateParamsSnapshotExpirationStateOptional

Specifies the state of maintenance operations.

</summary>

One of the following:

const MaintenanceConfigUpdateParamsSnapshotExpirationStateEnabled MaintenanceConfigUpdateParamsSnapshotExpirationState = "enabled"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20snapshot_expiration%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%200">Link to this property</a>

const MaintenanceConfigUpdateParamsSnapshotExpirationStateDisabled MaintenanceConfigUpdateParamsSnapshotExpirationState = "disabled"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20snapshot_expiration%20%3E%20(schema)%20%3E%20(property)%20state%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20snapshot_expiration%20%3E%20(schema)%20%3E%20(property)%20state">Link to this property</a>

</details>

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20snapshot_expiration">Link to this property</a>

</details>

[Link to this property](<#(resource)%20basin_catalog.maintenance_configs%20%3E%20(method)%20update%20%3E%20(params)%20default>)

##### ReturnsExpand Collapse

<details>

<summary>

type MaintenanceConfigUpdateResponse struct{…}

Configures maintenance for the catalog.

</summary>

<details>

<summary>

Compaction MaintenanceConfigUpdateResponseCompactionOptional

Configures compaction for catalog maintenance.

</summary>

<details>

<summary>

State MaintenanceConfigUpdateResponseCompactionState

Specifies the state of maintenance operations.

</summary>

One of the following:

const MaintenanceConfigUpdateResponseCompactionStateEnabled MaintenanceConfigUpdateResponseCompactionState = "enabled"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20compaction%20%3E%20(property)%20state%20%3E%20(member)%200">Link to this property</a>

const MaintenanceConfigUpdateResponseCompactionStateDisabled MaintenanceConfigUpdateResponseCompactionState = "disabled"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20compaction%20%3E%20(property)%20state%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20compaction%20%3E%20(property)%20state">Link to this property</a>

<details>

<summary>

TargetSizeMB MaintenanceConfigUpdateResponseCompactionTargetSizeMB

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

</summary>

One of the following:

const MaintenanceConfigUpdateResponseCompactionTargetSizeMB64 MaintenanceConfigUpdateResponseCompactionTargetSizeMB = "64"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20compaction%20%3E%20(property)%20target_size_mb%20%3E%20(member)%200">Link to this property</a>

const MaintenanceConfigUpdateResponseCompactionTargetSizeMB128 MaintenanceConfigUpdateResponseCompactionTargetSizeMB = "128"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20compaction%20%3E%20(property)%20target_size_mb%20%3E%20(member)%201">Link to this property</a>

const MaintenanceConfigUpdateResponseCompactionTargetSizeMB256 MaintenanceConfigUpdateResponseCompactionTargetSizeMB = "256"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20compaction%20%3E%20(property)%20target_size_mb%20%3E%20(member)%202">Link to this property</a>

const MaintenanceConfigUpdateResponseCompactionTargetSizeMB512 MaintenanceConfigUpdateResponseCompactionTargetSizeMB = "512"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20compaction%20%3E%20(property)%20target_size_mb%20%3E%20(member)%203">Link to this property</a>

</details>

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20compaction%20%3E%20(property)%20target_size_mb">Link to this property</a>

</details>

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20compaction">Link to this property</a>

Interval stringOptional

Scheduling interval between normal table maintenance runs.

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20interval">Link to this property</a>

<details>

<summary>

SnapshotExpiration MaintenanceConfigUpdateResponseSnapshotExpirationOptional

Configures snapshot expiration settings.

</summary>

MaxSnapshotAge 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”.

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20snapshot_expiration%20%3E%20(property)%20max_snapshot_age">Link to this property</a>

MinSnapshotsToKeep int64

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

formatint64

minimum1

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20snapshot_expiration%20%3E%20(property)%20min_snapshots_to_keep">Link to this property</a>

<details>

<summary>

State MaintenanceConfigUpdateResponseSnapshotExpirationState

Specifies the state of maintenance operations.

</summary>

One of the following:

const MaintenanceConfigUpdateResponseSnapshotExpirationStateEnabled MaintenanceConfigUpdateResponseSnapshotExpirationState = "enabled"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20snapshot_expiration%20%3E%20(property)%20state%20%3E%20(member)%200">Link to this property</a>

const MaintenanceConfigUpdateResponseSnapshotExpirationStateDisabled MaintenanceConfigUpdateResponseSnapshotExpirationState = "disabled"

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20snapshot_expiration%20%3E%20(property)%20state%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20snapshot_expiration%20%3E%20(property)%20state">Link to this property</a>

</details>

<a href="#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)%20%3E%20(property)%20snapshot_expiration">Link to this property</a>

</details>

[Link to this property](<#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20MaintenanceConfigUpdateResponse%20%3E%20(schema)>)

### Update catalog maintenance configuration

Go

HTTPTypeScriptPythonGoTerraform

```
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/basin_catalog"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  maintenanceConfig, err := client.BasinCatalog.MaintenanceConfigs.Update(
    context.TODO(),
    "my-data-bucket",
    basin_catalog.MaintenanceConfigUpdateParams{
      AccountID: cloudflare.F("0123456789abcdef0123456789abcdef"),
      Compaction: cloudflare.F(basin_catalog.MaintenanceConfigUpdateParamsCompaction{
        State: cloudflare.F(basin_catalog.MaintenanceConfigUpdateParamsCompactionStateEnabled),
        TargetSizeMB: cloudflare.F(basin_catalog.MaintenanceConfigUpdateParamsCompactionTargetSizeMB256),
      }),
      SnapshotExpiration: cloudflare.F(basin_catalog.MaintenanceConfigUpdateParamsSnapshotExpiration{
        MaxSnapshotAge: cloudflare.F("14d"),
        MinSnapshotsToKeep: cloudflare.F(int64(5)),
        State: cloudflare.F(basin_catalog.MaintenanceConfigUpdateParamsSnapshotExpirationStateEnabled),
      }),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", maintenanceConfig.Compaction)
}
```

200 example

```
{
  "errors": [],
  "messages": [],
  "result": {
    "compaction": {
      "state": "enabled",
      "target_size_mb": "256"
    },
    "snapshot_expiration": {
      "max_snapshot_age": "14d",
      "min_snapshots_to_keep": 5,
      "state": "enabled"
    }
  },
  "success": true
}
```

##### Returns Examples

200 example

```
{
  "errors": [],
  "messages": [],
  "result": {
    "compaction": {
      "state": "enabled",
      "target_size_mb": "256"
    },
    "snapshot_expiration": {
      "max_snapshot_age": "14d",
      "min_snapshots_to_keep": 5,
      "state": "enabled"
    }
  },
  "success": true
}
```