List bulk update history objects

POST /api/scan/v0/history/bulk/updates

Request

curl --request POST \
  --url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/history/bulk/updates' \
  --header 'Content-Type: application/json' \
  --data '{"start_record_time":"2026-01-01T00:00:00Z","end_record_time":"2026-01-01T00:00:00Z","next_page_token":"string","page_size":0}'

200 response

{
  "object_refs": [
    {}
  ],
  "next_page_token": "string"
}

Scan API

List bulk update history objects

OpenAPISince 0.5.18

Under Development, do not use in production yet Get download URLs and metadata for update history objects available for bulk download, between two record times. Note that the returned objects may include also updates outside of the requested record time range (since only full objects are served from storage), but guaranteed to include all updates in the requested range.

Protocol Details

Operation IDlistBulkUpdateHistoryObjects

Published0.7.4

SpecificationDownload OpenAPI

Inputs

Request body

application/json

start_record_time · string · required

OpenAPI type: string (date-time).

The returned objects must include all updates with record time greater than start_record_time (but may also include updates before it).

end_record_time · string · required

OpenAPI type: string (date-time).

The returned objects must include all updates with record time at most end_record_time (but may also include updates after it).

next_page_token · string

The pagination token returned from a previous call to this endpoint with the same arguments.

page_size · number · required

OpenAPI type: integer (int32).

The maximum number of objects returned for this request.

Outputs

200

application/json

object_refs · BulkStorageObjectRef[] · required

The list of references to the bulk storage objects containing the updates.

next_page_token · string

When requesting the next page of results, pass this as after to the next ListBulkUpdateHistoryObjectsRequest invocation. Will be absent when there are no more pages.

400

application/json

error · string · required

404

application/json

error · string · required

501

application/json

error · string · required

History

Introduced0.5.18

Request

curl --request POST \
  --url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/history/bulk/updates' \
  --header 'Content-Type: application/json' \
  --data '{"start_record_time":"2026-01-01T00:00:00Z","end_record_time":"2026-01-01T00:00:00Z","next_page_token":"string","page_size":0}'

200 response

{
  "object_refs": [
    {}
  ],
  "next_page_token": "string"
}