Zones

Lookup Zones

Fetch specific zones by their IDs

post/database/{version}/{container}/{environment}/{database}/zones/lookup

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

Response

Zones retrieved successfully

Changes

Changed in 3 of the 14 revisions of this API.2832

    • added the optional property zones/items/atomic to the response with the 200 status

      response-optional-property-added

    • added the optional property zones/items/syncToken to the response with the 200 status

      response-optional-property-added

  • a17a324ec78e281See the full diff
    • added the new ACCESS_DENIED enum value to the serverErrorCode response property for the response status 400

      response-property-enum-value-added

    • added the new ACCESS_DENIED enum value to the serverErrorCode response property for the response status 401

      response-property-enum-value-added

    • added the new ATOMIC_ERROR enum value to the serverErrorCode response property for the response status 400

      response-property-enum-value-added

    • added the new ATOMIC_ERROR enum value to the serverErrorCode response property for the response status 401

      response-property-enum-value-added

    • added the new AUTHENTICATION_FAILED enum value to the serverErrorCode response property for the response status 400

      response-property-enum-value-added

    • added the new AUTHENTICATION_FAILED enum value to the serverErrorCode response property for the response status 401

      response-property-enum-value-added

    • added the new AUTHENTICATION_REQUIRED enum value to the serverErrorCode response property for the response status 400

      response-property-enum-value-added

    • added the new AUTHENTICATION_REQUIRED enum value to the serverErrorCode response property for the response status 401

      response-property-enum-value-added

    • added the new BAD_REQUEST enum value to the serverErrorCode response property for the response status 400

      response-property-enum-value-added

    • added the new BAD_REQUEST enum value to the serverErrorCode response property for the response status 401

      response-property-enum-value-added

    • added the new CONFLICT enum value to the serverErrorCode response property for the response status 400

      response-property-enum-value-added

    • added the new CONFLICT enum value to the serverErrorCode response property for the response status 401

      response-property-enum-value-added

    • added the new EXISTS enum value to the serverErrorCode response property for the response status 400

      response-property-enum-value-added

    • added the new EXISTS enum value to the serverErrorCode response property for the response status 401

      response-property-enum-value-added

    • added the new INTERNAL_ERROR enum value to the serverErrorCode response property for the response status 400

      response-property-enum-value-added

    • added the new INTERNAL_ERROR enum value to the serverErrorCode response property for the response status 401

      response-property-enum-value-added

    • added the new NOT_FOUND enum value to the serverErrorCode response property for the response status 400

      response-property-enum-value-added

    • added the new NOT_FOUND enum value to the serverErrorCode response property for the response status 401

      response-property-enum-value-added

    • added the new QUOTA_EXCEEDED enum value to the serverErrorCode response property for the response status 400

      response-property-enum-value-added

    • added the new QUOTA_EXCEEDED enum value to the serverErrorCode response property for the response status 401

      response-property-enum-value-added

    • added the new THROTTLED enum value to the serverErrorCode response property for the response status 400

      response-property-enum-value-added

    • added the new THROTTLED enum value to the serverErrorCode response property for the response status 401

      response-property-enum-value-added

    • added the new TRY_AGAIN_LATER enum value to the serverErrorCode response property for the response status 400

      response-property-enum-value-added

    • added the new TRY_AGAIN_LATER enum value to the serverErrorCode response property for the response status 401

      response-property-enum-value-added

    • added the new VALIDATING_REFERENCE_ERROR enum value to the serverErrorCode response property for the response status 400

      response-property-enum-value-added

    • added the new VALIDATING_REFERENCE_ERROR enum value to the serverErrorCode response property for the response status 401

      response-property-enum-value-added

    • added the new ZONE_NOT_FOUND enum value to the serverErrorCode response property for the response status 400

      response-property-enum-value-added

    • added the new ZONE_NOT_FOUND enum value to the serverErrorCode response property for the response status 401

      response-property-enum-value-added

    • api operation id lookupZones was added

      api-operation-id-added

    • api operation id lookupZones removed and replaced with

      api-operation-id-removed

    • removed the ACCESS_DENIED enum value from the serverErrorCode response property for the response status 400

      response-property-enum-value-removed

    • removed the ACCESS_DENIED enum value from the serverErrorCode response property for the response status 401

      response-property-enum-value-removed

    • removed the ATOMIC_ERROR enum value from the serverErrorCode response property for the response status 400

      response-property-enum-value-removed

    • removed the ATOMIC_ERROR enum value from the serverErrorCode response property for the response status 401

      response-property-enum-value-removed

    • removed the AUTHENTICATION_FAILED enum value from the serverErrorCode response property for the response status 400

      response-property-enum-value-removed

    • removed the AUTHENTICATION_FAILED enum value from the serverErrorCode response property for the response status 401

      response-property-enum-value-removed

    • removed the AUTHENTICATION_REQUIRED enum value from the serverErrorCode response property for the response status 400

      response-property-enum-value-removed

    • removed the AUTHENTICATION_REQUIRED enum value from the serverErrorCode response property for the response status 401

      response-property-enum-value-removed

    • removed the BAD_REQUEST enum value from the serverErrorCode response property for the response status 400

      response-property-enum-value-removed

    • removed the BAD_REQUEST enum value from the serverErrorCode response property for the response status 401

      response-property-enum-value-removed

    • removed the CONFLICT enum value from the serverErrorCode response property for the response status 400

      response-property-enum-value-removed

    • removed the CONFLICT enum value from the serverErrorCode response property for the response status 401

      response-property-enum-value-removed

    • removed the EXISTS enum value from the serverErrorCode response property for the response status 400

      response-property-enum-value-removed

    • removed the EXISTS enum value from the serverErrorCode response property for the response status 401

      response-property-enum-value-removed

    • removed the INTERNAL_ERROR enum value from the serverErrorCode response property for the response status 400

      response-property-enum-value-removed

    • removed the INTERNAL_ERROR enum value from the serverErrorCode response property for the response status 401

      response-property-enum-value-removed

    • removed the NOT_FOUND enum value from the serverErrorCode response property for the response status 400

      response-property-enum-value-removed

    • removed the NOT_FOUND enum value from the serverErrorCode response property for the response status 401

      response-property-enum-value-removed

    • removed the QUOTA_EXCEEDED enum value from the serverErrorCode response property for the response status 400

      response-property-enum-value-removed

    • removed the QUOTA_EXCEEDED enum value from the serverErrorCode response property for the response status 401

      response-property-enum-value-removed

    • removed the THROTTLED enum value from the serverErrorCode response property for the response status 400

      response-property-enum-value-removed

    • removed the THROTTLED enum value from the serverErrorCode response property for the response status 401

      response-property-enum-value-removed

    • removed the TRY_AGAIN_LATER enum value from the serverErrorCode response property for the response status 400

      response-property-enum-value-removed

    • removed the TRY_AGAIN_LATER enum value from the serverErrorCode response property for the response status 401

      response-property-enum-value-removed

    • removed the VALIDATING_REFERENCE_ERROR enum value from the serverErrorCode response property for the response status 400

      response-property-enum-value-removed

    • removed the VALIDATING_REFERENCE_ERROR enum value from the serverErrorCode response property for the response status 401

      response-property-enum-value-removed

    • removed the ZONE_NOT_FOUND enum value from the serverErrorCode response property for the response status 400

      response-property-enum-value-removed

    • removed the ZONE_NOT_FOUND enum value from the serverErrorCode response property for the response status 401

      response-property-enum-value-removed

    This revision also has 24 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog