Skip to main content

List Iceberg table backups​

Retrieves a list of Iceberg table backups.

Query Parameters
  • limit int64

    Limits the size of the response on each page to the specified number of items.

  • start string

    Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e., ?start=1).

  • sort string

    Returns the list of backups in the order specified. Set sort to the name of the sort field by which to sort in ascending order. To sort the list in reverse order, prefix the field name with a minus sign (-). Only one field may be sorted at a time.

    The following table lists the supported sort fields for this resource:

    Sort FieldDescription
    start_timestampSorts the backups in ascending timestamp order (oldest first). For example, ?sort=start_timestamp
    If a sort order is not specified, the individual rules are sorted by "start_timestamp" in descending timestamp order (newest first).
  • filter string

    Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:

    FieldFilter ConditionDescription
    table_id$eqFilter Iceberg table backups whose table ID equal the specified string. For example, ?filter={"table_id":{"$eq":"2df41fa2-4dce-11f0-897f-fe8ca1fdf168"}}
    start_timestamp$lte, $gt, $ltFilter Iceberg table backups whose start timestamp is "less than or equal to", "greater than" or "less than" a given timestamp. For example, ?filter={"start_timestamp":{"$lte":"1985-04-12T23:20:50Z"}}
    type$inFilter Iceberg table backups whose catalog_type is "iceberg_snapshot" or "iceberg_metadata". If not specified, return all types of record as a result. For example, ?filter={"type":{"$in":["iceberg_snapshot","iceberg_metadata"]}}
    metadata_record_id$eqFilter Iceberg table backups whose metadata record ID is equal to the specified string. If this parameter is specified, the API returns the snapshot records associated with that metadata record. For example, ?filter={"metadata_record_id":{"$eq":"3adf156e-6eb1-11f0-866b-5ef2964f5202_2025-08-02T07:20:00Z"}}
    backup_region$eqFilter Iceberg table backups whose backup region is equal to the specified string. For example, ?filter={"backup_region":{"$eq":"us-west-2"}}
    For more information about filtering, refer to the Filtering section of this guide.
Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • items object[]

    A collection of requested items.

  • account_native_id string

    The AWS-assigned ID of the account associated with this database at the time of backup.

  • aws_region string

    The AWS region associated with this environment.

  • backup_aws_region string

    The region in which this backup is stored. For policies that keep backups in-region, this value will be the same as the source region of the asset backed up. For out of region policies, this region will the one specified in the policy.

  • expiration_timestamp string

    The timestamp of when this backup expires. Represented in RFC-3339 format.

  • id string

    The Clumio-assigned ID of the backup.

  • newly_added_snapshots int32

    The total count of the newly added snapshots in this backup.

  • schema string

    The schema of the Iceberg table captured in this backup.

  • snapshot_created_at string

    The timestamp of when the Iceberg snapshot was created. Represented in RFC-3339 format.

  • snapshot_id string

    The ID of the Iceberg snapshot associated with this backup.

  • start_timestamp string

    The timestamp of when this backup started. Represented in RFC-3339 format.

  • summary object
  • added_records string

    The number of records added in this snapshot.

  • operation string

    The operation that produced this snapshot. For example, "append" or "overwrite".

  • total_files_size string

    The total size of the data files in this snapshot. Measured in bytes.

  • total_records string

    The total number of records in the Iceberg table at this snapshot.

  • table_id string

    The Clumio-assigned ID of the Iceberg table.

  • table_name string

    The name of the Iceberg table.

  • type string

    The record type of this backup. This field is always set to "iceberg_snapshot" or "iceberg_metadata".

  • current_count int64

    The number of items listed on the current page.

  • filter_applied string

    The filter used in the request. The filter includes both manually-specified and system-generated filters.

  • limit int64

    The maximum number of items displayed per page in the response.

  • start string

    The page number used to get this response. Pages are indexed starting from 1 (i.e., "start": "1").

  • total_count int64

    The total number of items, summed across all pages.

  • total_pages_count int64

    The total number of pages of results.

Loading...