Skip to main content

Pagination

project.iterate_by chooses how apibackuper walks the API.

page

Page number + page size. Template: examples/templates/page-based.yaml.

project:
iterate_by: page

params:
page_number_param: page
page_size_param: per_page
page_size_limit: 100
start_page: 1

skip

Offset / limit. Template: examples/templates/skip-offset.yaml.

project:
iterate_by: skip

params:
count_skip_param: offset
page_size_param: limit
page_size_limit: 200

range

Inclusive numeric range using count_from_param and count_to_param.

Other params

FieldPurpose
query_modequery, params, or mixed
force_flat_paramsFlatten nested parameters
change_key_paramRequest parameter for change-key filtering
update_since_paramRequest parameter for update-since filtering

If keys are unknown, try apibackuper detect.