Skip to content
Cloudflare API
Start here
API Reference

Basin Catalog

List Basin Catalogs
client.basinCatalog.list(BasinCatalogListParams { account_id } params, RequestOptionsoptions?): BasinCatalogListResponse { warehouses }
GET/accounts/{account_id}/basin-catalog
Get Basin Catalog details
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
client.basinCatalog.enable(stringbucketName, BasinCatalogEnableParams { account_id } params, RequestOptionsoptions?): BasinCatalogEnableResponse { id, name }
POST/accounts/{account_id}/basin-catalog/{bucket_name}/enable
Disable Basin Catalog
client.basinCatalog.disable(stringbucketName, BasinCatalogDisableParams { account_id } params, RequestOptionsoptions?): void
POST/accounts/{account_id}/basin-catalog/{bucket_name}/disable
Delete Basin Catalog metadata
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
bucket: string

Specifies the associated R2 bucket name.

name: string

Specifies the catalog name (generated from account and bucket name).

status: "active" | "inactive"

Indicates the status of the catalog.

One of the following:
"active"
"inactive"
credential_status?: "present" | "absent" | null

Shows the credential configuration status.

One of the following:
"present"
"absent"
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"
"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"
interval?: string

Scheduling interval between normal table maintenance runs.

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"
BasinCatalogGetResponse { id, bucket, name, 3 more }

Contains catalog information.

id: string

Use this to uniquely identify the catalog.

formatuuid
bucket: string

Specifies the associated R2 bucket name.

name: string

Specifies the catalog name (generated from account and bucket name).

status: "active" | "inactive"

Indicates the status of the catalog.

One of the following:
"active"
"inactive"
credential_status?: "present" | "absent" | null

Shows the credential configuration status.

One of the following:
"present"
"absent"
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"
"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"
interval?: string

Scheduling interval between normal table maintenance runs.

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"
BasinCatalogEnableResponse { id, name }

Contains response from activating an R2 bucket as a catalog.

id: string

Use this to uniquely identify the activated catalog.

formatuuid
name: string

Specifies the name of the activated catalog.

Basin CatalogMaintenance Configs

Get catalog maintenance configuration
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
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"
"absent"
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"
"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"
interval?: string

Scheduling interval between normal table maintenance runs.

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, 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"
"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"
interval?: string

Scheduling interval between normal table maintenance runs.

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"

Basin CatalogCredentials

Store catalog credentials
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

Basin CatalogNamespaces

List namespaces in catalog
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.

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

namespace_uuid: string

Contains the UUID that persists across renames.

formatuuid
created_at?: string | null

Indicates the creation timestamp in ISO 8601 format.

formatdate-time
updated_at?: string | null

Shows the last update timestamp in ISO 8601 format. Null if never updated.

formatdate-time
namespace_uuids?: Array<string> | null

Contains UUIDs for each namespace when return_uuids is true. The order corresponds to the namespaces array.

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.

Basin CatalogNamespacesTables

List tables in namespace
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.

namespace: Array<string>

Specifies the hierarchical namespace parts as an array of strings. For example, [“bronze”, “analytics”] represents the namespace “bronze.analytics”.

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.

namespace: Array<string>

Specifies the hierarchical namespace parts as an array of strings. For example, [“bronze”, “analytics”] represents the namespace “bronze.analytics”.

table_uuid: string

Contains the UUID that persists across renames.

formatuuid
created_at?: string | null

Indicates the creation timestamp in ISO 8601 format.

formatdate-time
location?: string | null

Specifies the base S3 URI for table storage location.

metadata_location?: string | null

Contains the S3 URI to table metadata file. Null for staged tables.

updated_at?: string | null

Shows the last update timestamp in ISO 8601 format. Null if never updated.

formatdate-time
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.

table_uuids?: Array<string> | null

Contains UUIDs for each table when return_uuids is true. The order corresponds to the identifiers array.

Basin CatalogNamespacesTablesMaintenance Configs

Get table maintenance configuration
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
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"
"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"
next_eligible_at?: string | null

Earliest time when the scheduler can claim this operation. Null when disabled.

formatdate-time
interval?: string

Scheduling interval between normal table maintenance runs.

snapshot_expiration?: SnapshotExpiration { max_snapshot_age, min_snapshots_to_keep, state, next_eligible_at }
max_snapshot_age: string

Specifies the maximum age for snapshots.

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"
next_eligible_at?: string | null

Earliest time when the scheduler can claim this operation. Null when disabled.

formatdate-time
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"
"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"
next_eligible_at?: string | null

Earliest time when the scheduler can claim this operation. Null when disabled.

formatdate-time
interval?: string

Scheduling interval between normal table maintenance runs.

snapshot_expiration?: SnapshotExpiration { max_snapshot_age, min_snapshots_to_keep, state, next_eligible_at }
max_snapshot_age: string

Specifies the maximum age for snapshots.

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"
next_eligible_at?: string | null

Earliest time when the scheduler can claim this operation. Null when disabled.

formatdate-time