Documentation Archive

Developer

CloudKit Web Services Reference

On This Page

Registering Tokens (tokens/register)

You can register a token with a specified Apple Push Notification services (APNs) environment.

Path

POST [path]/database/[version]/[container]/[environment]/tokens/register

Parameters

path

The URL to the CloudKit web service, which is https://api.apple-cloudkit.com.

version

The protocol version—currently, 1.

container

A unique identifier for the app’s container. The container ID begins with iCloud..

environment

The version of the app’s container. Pass development to use the environment that is not accessible by apps available on the store. Pass production to use the environment that is accessible by development apps and apps available on the store.

Request

The POST request is a JSON dictionary containing the following keys:

Key

Description

apnsEnvironment

A string that specifies the APNs environment. To use the production environment, set this key to "production". To use the development environment, set this key to "development". This key is required.

apnsToken

A token you use to register to receive push notifications from other containers. This key is required.

Related Framework API

This request is similar to using the registerForRemoteNotifications method in the UIApplication class. In the native API, the token is handled for you by the CloudKit daemon.