Zones

Fetch Record Zone Changes

Get the records that changed within one or more record zones relative to each zone's sync token. Intended for custom zones. Each entry in the response zones array is either a per-zone success result or a per-zone error.

post/database/{version}/{container}/{environment}/{database}/changes/zone

Path parameters

versionstring required

Protocol version

containerstring required

Container ID (begins with "iCloud.")

environment'development' | 'production' required

Container environment

database'public' | 'private' | 'shared' required

Database scope

Request body

reverseboolean

Whether the changes are returned in reverse order.

desiredKeysstring[]

Record field names limiting the fields returned per changed record. Omit to fetch all fields.

numberAsStringsboolean

Whether number fields should be represented as strings. Defaults to false.

resultsLimitinteger

The maximum number of records to fetch. Defaults to the maximum allowed in a request.

desiredRecordTypesstring[]

Record-type names limiting the change feed to specific record types. Omit to fetch changes from all record types.

Response

Record zone changes retrieved successfully