--- title: Basin Catalog --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Basin Catalog ##### [List Basin Catalogs](https://developers.cloudflare.com/api/typescript/resources/basin_catalog/methods/list) client.basinCatalog.list(BasinCatalogListParams {account\_id } params, RequestOptionsoptions?): [BasinCatalogListResponse]() {warehouses } GET/accounts/{account\_id}/basin-catalog ##### [Get Basin Catalog details](https://developers.cloudflare.com/api/typescript/resources/basin_catalog/methods/get) client.basinCatalog.get(stringbucketName, BasinCatalogGetParams {account\_id } params, RequestOptionsoptions?): [BasinCatalogGetResponse]() {id, bucket, name, 3 more } GET/accounts/{account\_id}/basin-catalog/{bucket\_name} ##### [Enable R2 bucket as a catalog](https://developers.cloudflare.com/api/typescript/resources/basin_catalog/methods/enable) client.basinCatalog.enable(stringbucketName, BasinCatalogEnableParams {account\_id } params, RequestOptionsoptions?): [BasinCatalogEnableResponse]() {id, name } POST/accounts/{account\_id}/basin-catalog/{bucket\_name}/enable ##### [Disable Basin Catalog](https://developers.cloudflare.com/api/typescript/resources/basin_catalog/methods/disable) client.basinCatalog.disable(stringbucketName, BasinCatalogDisableParams {account\_id } params, RequestOptionsoptions?): void POST/accounts/{account\_id}/basin-catalog/{bucket\_name}/disable ##### [Delete Basin Catalog metadata](https://developers.cloudflare.com/api/typescript/resources/basin_catalog/methods/delete) client.basinCatalog.delete(stringbucketName, BasinCatalogDeleteParams {account\_id, force } params, RequestOptionsoptions?): void POST/accounts/{account\_id}/basin-catalog/{bucket\_name}/delete ##### ModelsExpand Collapse
BasinCatalogListResponse {warehouses } Contains the list of catalogs.
warehouses: Array<Warehouse> Lists catalogs in the account. id: string Use this to uniquely identify the catalog. formatuuid Link to this property bucket: string Specifies the associated R2 bucket name. Link to this property name: string Specifies the catalog name (generated from account and bucket name). Link to this property
status: "active"| "inactive" Indicates the status of the catalog. One of the following: "active" Link to this property "inactive" Link to this property
Link to this property
credential\_status?: "present"| "absent"| null 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?: MaintenanceConfig| null 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" Link to this property "disabled" Link to this property
Link to this property
target\_size\_mb: "64"| "128"| "256"| "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?: string Scheduling interval between normal table maintenance runs. Link to this property
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”. 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"| "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
[Link to this property](<#(resource)%20basin_catalog%20%3E%20(model)%20basin_catalog_list_response%20%3E%20(schema)>)
BasinCatalogGetResponse {id, bucket, name, 3 more } Contains catalog information. id: string Use this to uniquely identify the catalog. formatuuid Link to this property bucket: string Specifies the associated R2 bucket name. Link to this property name: string Specifies the catalog name (generated from account and bucket name). Link to this property
status: "active"| "inactive" Indicates the status of the catalog. One of the following: "active" Link to this property "inactive" Link to this property
Link to this property
credential\_status?: "present"| "absent"| null 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?: MaintenanceConfig| null 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" Link to this property "disabled" Link to this property
Link to this property
target\_size\_mb: "64"| "128"| "256"| "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?: string Scheduling interval between normal table maintenance runs. Link to this property
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”. 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"| "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%20%3E%20(model)%20basin_catalog_get_response%20%3E%20(schema)>)
BasinCatalogEnableResponse {id, name } Contains response from activating an R2 bucket as a catalog. id: string Use this to uniquely identify the activated catalog. formatuuid Link to this property name: string Specifies the name of the activated catalog. Link to this property
[Link to this property](<#(resource)%20basin_catalog%20%3E%20(model)%20basin_catalog_enable_response%20%3E%20(schema)>) #### Basin CatalogMaintenance Configs ##### [Get catalog maintenance configuration](https://developers.cloudflare.com/api/typescript/resources/basin_catalog/subresources/maintenance_configs/methods/get) client.basinCatalog.maintenanceConfigs.get(stringbucketName, MaintenanceConfigGetParams {account\_id } params, RequestOptionsoptions?): [MaintenanceConfigGetResponse]() {credential\_status, maintenance\_config } GET/accounts/{account\_id}/basin-catalog/{bucket\_name}/maintenance-configs ##### [Update catalog maintenance configuration](https://developers.cloudflare.com/api/typescript/resources/basin_catalog/subresources/maintenance_configs/methods/update) client.basinCatalog.maintenanceConfigs.update(stringbucketName, MaintenanceConfigUpdateParams {account\_id, compaction, snapshot\_expiration } params, RequestOptionsoptions?): [MaintenanceConfigUpdateResponse]() {compaction, interval, snapshot\_expiration } POST/accounts/{account\_id}/basin-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" Link to this property "absent" Link to this property
Link to this property
maintenance\_config: MaintenanceConfig {compaction, interval, 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" Link to this property "disabled" Link to this property
Link to this property
target\_size\_mb: "64"| "128"| "256"| "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?: string Scheduling interval between normal table maintenance runs. Link to this property
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”. 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"| "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(model)%20maintenance_config_get_response%20%3E%20(schema)>)
MaintenanceConfigUpdateResponse {compaction, interval, 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" Link to this property "disabled" Link to this property
Link to this property
target\_size\_mb: "64"| "128"| "256"| "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?: string Scheduling interval between normal table maintenance runs. Link to this property
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”. 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"| "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](<#(resource)%20basin_catalog.maintenance_configs%20%3E%20(model)%20maintenance_config_update_response%20%3E%20(schema)>) #### Basin CatalogCredentials ##### [Store catalog credentials](https://developers.cloudflare.com/api/typescript/resources/basin_catalog/subresources/credentials/methods/create) client.basinCatalog.credentials.create(stringbucketName, CredentialCreateParams {account\_id, token } params, RequestOptionsoptions?): [CredentialCreateResponse]()| null POST/accounts/{account\_id}/basin-catalog/{bucket\_name}/credential ##### ModelsExpand Collapse CredentialCreateResponse = unknown [Link to this property](<#(resource)%20basin_catalog.credentials%20%3E%20(model)%20credential_create_response%20%3E%20(schema)>) #### Basin CatalogNamespaces ##### [List namespaces in catalog](https://developers.cloudflare.com/api/typescript/resources/basin_catalog/subresources/namespaces/methods/list) client.basinCatalog.namespaces.list(stringbucketName, NamespaceListParams {account\_id, page\_size, page\_token, 3 more } params, RequestOptionsoptions?): [NamespaceListResponse]() {namespaces, details, namespace\_uuids, next\_page\_token } GET/accounts/{account\_id}/basin-catalog/{bucket\_name}/namespaces ##### ModelsExpand Collapse
NamespaceListResponse {namespaces, details, namespace\_uuids, next\_page\_token } Contains the list of namespaces with optional pagination. namespaces: Array<Array<string>> Lists namespaces in the catalog. Link to this property
details?: Array<Detail>| null Contains detailed metadata for each namespace when return\_details is true. Each object includes the namespace, UUID, and timestamps. namespace: Array<string> Specifies the hierarchical namespace parts as an array of strings. For example, \[“bronze”, “analytics”] represents the namespace “bronze.analytics”. Link to this property namespace\_uuid: string Contains the UUID that persists across renames. formatuuid Link to this property created\_at?: string| null Indicates the creation timestamp in ISO 8601 format. formatdate-time Link to this property updated\_at?: string| null Shows the last update timestamp in ISO 8601 format. Null if never updated. formatdate-time Link to this property
Link to this property namespace\_uuids?: Array<string>| null Contains UUIDs for each namespace when return\_uuids is true. The order corresponds to the namespaces array. Link to this property next\_page\_token?: string| null Use this opaque token to fetch the next page of results. A null or absent value indicates the last page. Link to this property
[Link to this property](<#(resource)%20basin_catalog.namespaces%20%3E%20(model)%20namespace_list_response%20%3E%20(schema)>) #### Basin CatalogNamespacesTables ##### [List tables in namespace](https://developers.cloudflare.com/api/typescript/resources/basin_catalog/subresources/namespaces/subresources/tables/methods/list) client.basinCatalog.namespaces.tables.list(stringnamespace, TableListParams {account\_id, bucket\_name, page\_size, 3 more } params, RequestOptionsoptions?): [TableListResponse]() {identifiers, details, next\_page\_token, table\_uuids } GET/accounts/{account\_id}/basin-catalog/{bucket\_name}/namespaces/{namespace}/tables ##### ModelsExpand Collapse
TableListResponse {identifiers, details, next\_page\_token, table\_uuids } Contains the list of tables with optional pagination.
identifiers: Array<Identifier> Lists tables in the namespace. name: string Specifies the table name. Link to this property namespace: Array<string> Specifies the hierarchical namespace parts as an array of strings. For example, \[“bronze”, “analytics”] represents the namespace “bronze.analytics”. Link to this property
Link to this property
details?: Array<Detail>| null Contains detailed metadata for each table when return\_details is true. Each object includes identifier, UUID, timestamps, and locations.
identifier: Identifier {name, namespace } Specifies a unique table identifier within a catalog. name: string Specifies the table name. Link to this property namespace: Array<string> Specifies the hierarchical namespace parts as an array of strings. For example, \[“bronze”, “analytics”] represents the namespace “bronze.analytics”. Link to this property
Link to this property table\_uuid: string Contains the UUID that persists across renames. formatuuid Link to this property created\_at?: string| null Indicates the creation timestamp in ISO 8601 format. formatdate-time Link to this property location?: string| null Specifies the base S3 URI for table storage location. Link to this property metadata\_location?: string| null Contains the S3 URI to table metadata file. Null for staged tables. Link to this property updated\_at?: string| null Shows the last update timestamp in ISO 8601 format. Null if never updated. formatdate-time Link to this property
Link to this property next\_page\_token?: string| null Use this opaque token to fetch the next page of results. A null or absent value indicates the last page. Link to this property table\_uuids?: Array<string>| null Contains UUIDs for each table when return\_uuids is true. The order corresponds to the identifiers array. Link to this property
[Link to this property](<#(resource)%20basin_catalog.namespaces.tables%20%3E%20(model)%20table_list_response%20%3E%20(schema)>) #### Basin CatalogNamespacesTablesMaintenance Configs ##### [Get table maintenance configuration](https://developers.cloudflare.com/api/typescript/resources/basin_catalog/subresources/namespaces/subresources/tables/subresources/maintenance_configs/methods/get) client.basinCatalog.namespaces.tables.maintenanceConfigs.get(stringtableName, MaintenanceConfigGetParams {account\_id, bucket\_name, namespace } params, RequestOptionsoptions?): [MaintenanceConfigGetResponse]() {maintenance\_config } GET/accounts/{account\_id}/basin-catalog/{bucket\_name}/namespaces/{namespace}/tables/{table\_name}/maintenance-configs ##### [Update table maintenance configuration](https://developers.cloudflare.com/api/typescript/resources/basin_catalog/subresources/namespaces/subresources/tables/subresources/maintenance_configs/methods/update) client.basinCatalog.namespaces.tables.maintenanceConfigs.update(stringtableName, MaintenanceConfigUpdateParams {account\_id, bucket\_name, namespace, 2 more } params, RequestOptionsoptions?): [MaintenanceConfigUpdateResponse]() {compaction, interval, snapshot\_expiration } POST/accounts/{account\_id}/basin-catalog/{bucket\_name}/namespaces/{namespace}/tables/{table\_name}/maintenance-configs ##### ModelsExpand Collapse
MaintenanceConfigGetResponse {maintenance\_config } Contains table maintenance configuration.
maintenance\_config: MaintenanceConfig {compaction, interval, snapshot\_expiration } Configures maintenance for the table.
compaction?: Compaction {state, target\_size\_mb, next\_eligible\_at } Configures compaction settings for table optimization.
state: "enabled"| "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"| "128"| "256"| "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 next\_eligible\_at?: string| null Earliest time when the scheduler can claim this operation. Null when disabled. formatdate-time Link to this property
Link to this property interval?: string Scheduling interval between normal table maintenance runs. Link to this property
snapshot\_expiration?: SnapshotExpiration {max\_snapshot\_age, min\_snapshots\_to\_keep, state, next\_eligible\_at } max\_snapshot\_age: string Specifies the maximum age for snapshots. 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"| "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 next\_eligible\_at?: string| null Earliest time when the scheduler can claim this operation. Null when disabled. formatdate-time Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20basin_catalog.namespaces.tables.maintenance_configs%20%3E%20(model)%20maintenance_config_get_response%20%3E%20(schema)>)
MaintenanceConfigUpdateResponse {compaction, interval, snapshot\_expiration } Configures maintenance for the table.
compaction?: Compaction {state, target\_size\_mb, next\_eligible\_at } Configures compaction settings for table optimization.
state: "enabled"| "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"| "128"| "256"| "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 next\_eligible\_at?: string| null Earliest time when the scheduler can claim this operation. Null when disabled. formatdate-time Link to this property
Link to this property interval?: string Scheduling interval between normal table maintenance runs. Link to this property
snapshot\_expiration?: SnapshotExpiration {max\_snapshot\_age, min\_snapshots\_to\_keep, state, next\_eligible\_at } max\_snapshot\_age: string Specifies the maximum age for snapshots. 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"| "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 next\_eligible\_at?: string| null Earliest time when the scheduler can claim this operation. Null when disabled. formatdate-time Link to this property
Link to this property
[Link to this property](<#(resource)%20basin_catalog.namespaces.tables.maintenance_configs%20%3E%20(model)%20maintenance_config_update_response%20%3E%20(schema)>)