About CloudKit Web Services

You use the CloudKit native framework to take your app’s existing data and store it in the cloud so that the user can access it on multiple devices. Then you can use CloudKit web services or CloudKit JS to provide a web interface for users to access the same data as your app. To use CloudKit web services, you must have the schema for your databases already created. CloudKit web services provides an HTTP interface to fetch, create, update, and delete records, zones, and subscriptions. You also have access to discoverable users and contacts.

To access the web services using JavaScript, read CloudKit JavaScript Reference.

What’s New in CloudKit Web Services

Added new endpoints:

• records/resolve: Fetches information about records using GUIDs, described in Fetching Record Information (records/resolve).

• records/accept: Accepts a share on behalf of the current user, described in Accepting Share Records (records/accept).

• changes/database: Fetches changed zones in a database, described in Fetching Database Changes (changes/database).

• changes/zone: Fetches changed records in the specified zones, described in Fetching Record Zone Changes (changes/zone).

• users/caller: Fetches information about the current user, described in Fetching Current User (users/current).

• GET users/discover: Fetches all user identities in the current user’s address book, described in Discovering All User Identities (GET users/discover).

• POST users/discover: Fetches all users in the specified array, described in Discovering User Identities (POST users/discover).

Updated endpoints to support sharing records:

• records/changes: Added shared as database value, described in Fetching Record Changes (records/changes).

• records/modify: Added shared as database value, described in Modifying Records (records/modify).

• records/lookup: Added shared as database value, described in Fetching Records by Record Name (records/lookup).

• records/query: Added shared as database value, described in Fetching Records Using a Query (records/query).

Deprecated endpoints:

• zones/changes: Use Fetching Record Zone Changes (changes/zone) instead.

• users/current: Use Fetching Current User Identity (users/caller) instead.

• users/lookup/contacts: Use Discovering All User Identities (GET users/discover) instead.

• users/lookup/id: Use Discovering User Identities (users/discover) instead.

• users/lookup/email: Use Discovering User Identities (users/discover) instead.

At a Glance

To compose the URLs and learn about about parameters, read:

• Composing Web Service Requests

To fetch, create, and update records, read:

• Modifying Records (records/modify)

• Fetching Records Using a Query (records/query)

• Fetching Records by Record Name (records/lookup)

• Fetching Record Changes (records/changes)

To upload and reuse assets, read:

• Uploading Assets (assets/upload)

• Referencing Existing Assets (assets/rereference)

To fetch and modify zones, read:

• Fetching Zones (zones/list)

• Fetching Zones by Identifier (zones/lookup)

• Modifying Zones (zones/modify)

• Fetching Zone Changes (zones/changes)

To fetch users and contacts, read:

• Fetching Current User (users/current)

• Fetching Contacts (lookup/contacts)

• Fetching Users by Email (lookup/email)

• Fetching Users by Record Name (lookup/id)

To fetch and modify subscriptions, read:

• Fetching Subscriptions (subscriptions/list)

• Fetching Subscriptions by Identifier (subscriptions/lookup)

• Modifying Subscriptions (subscriptions/modify)

To create and register tokens, read:

• Creating APNs Tokens (tokens/create)

• Registering Tokens (tokens/register)