---
title: CloudKit
framework: CloudKit JS
role: symbol
role_heading: Class
platforms: [cloudkit js 1.0+]
path: cloudkitjs/cloudkit
---

# CloudKit

Use the CloudKit namespace to configure CloudKit JS, and to access app containers and global constants.

## Declaration

```data
interface CloudKit
```

## Overview

Overview Set up CloudKit JS by passing container and authentication information to the configure method. Also, specify whether to use the development or production environment. You’ll need the container ID and API token to configure CloudKit JS. (Use CloudKit Dashboard to create an API token, as described in Accessing CloudKit Using an API Token.) Some operations require users to enter their Apple ID credentials. Apple presents the sign-in dialog, but you can customize the position and theme of the sign-in and sign-out buttons. After configuring CloudKit JS, use the container methods to get the app’s container objects (CloudKit.Container), and from the container objects, get the database objects (CloudKit.Database).

## Topics

### Configuring CloudKit JS

- [configure](cloudkitjs/cloudkit/configure.md)

### Accessing Containers

- [getDefaultContainer](cloudkitjs/cloudkit/getdefaultcontainer.md)
- [getContainer](cloudkitjs/cloudkit/getcontainer.md)
- [getAllContainers](cloudkitjs/cloudkit/getallcontainers.md)

### Constants

- [CloudKit Build Version and Status](cloudkitjs/cloudkit-build-version-and-status.md)
- [Environments](cloudkitjs/environments.md)

### Enumerations

- [CloudKit.AppleIDButtonTheme](cloudkitjs/cloudkit.appleidbuttontheme.md)
- [CloudKit.DatabaseScope](cloudkitjs/cloudkit.databasescope.md)
- [CloudKit.QueryFilterComparator](cloudkitjs/cloudkit.queryfiltercomparator.md)
- [CloudKit.ReferenceAction](cloudkitjs/cloudkit.referenceaction.md)
- [CloudKit.ShareParticipantAcceptanceStatus](cloudkitjs/cloudkit.shareparticipantacceptancestatus.md)
- [CloudKit.ShareParticipantPermission](cloudkitjs/cloudkit.shareparticipantpermission.md)
- [CloudKit.ShareParticipantType](cloudkitjs/cloudkit.shareparticipanttype.md)
- [CloudKit.SubscriptionType](cloudkitjs/cloudkit.subscriptiontype.md)

### Properties

- [CKError](cloudkitjs/cloudkit/ckerror.md)
- [DatabaseScope](cloudkitjs/cloudkit/databasescope.md)
- [Promise](cloudkitjs/cloudkit/promise.md)
- [QueryFilterComparator](cloudkitjs/cloudkit/queryfiltercomparator.md)
- [ReferenceAction](cloudkitjs/cloudkit/referenceaction.md)
- [ShareParticipantAcceptanceStatus](cloudkitjs/cloudkit/shareparticipantacceptancestatus.md)
- [ShareParticipantPermission](cloudkitjs/cloudkit/shareparticipantpermission.md)
- [ShareParticipantType](cloudkitjs/cloudkit/shareparticipanttype.md)
- [ShareRecordType](cloudkitjs/cloudkit/sharerecordtype.md)
- [SubscriptionType](cloudkitjs/cloudkit/subscriptiontype.md)

### Classes

- [CloudKit.CKError](cloudkitjs/cloudkit.ckerror.md)
- [CloudKit.Container](cloudkitjs/cloudkit.container.md)
- [CloudKit.Database](cloudkitjs/cloudkit.database.md)
- [CloudKit.DatabaseChangesResponse](cloudkitjs/cloudkit.databasechangesresponse.md)
- [CloudKit.Notification](cloudkitjs/cloudkit.notification.md)
- [CloudKit.QueryNotification](cloudkitjs/cloudkit.querynotification.md)
- [CloudKit.QueryResponse](cloudkitjs/cloudkit.queryresponse.md)
- [CloudKit.RecordInfosResponse](cloudkitjs/cloudkit.recordinfosresponse.md)
- [CloudKit.RecordsBatchBuilder](cloudkitjs/cloudkit.recordsbatchbuilder.md)
- [CloudKit.RecordsResponse](cloudkitjs/cloudkit.recordsresponse.md)
- [CloudKit.RecordZoneChangesResponse](cloudkitjs/cloudkit.recordzonechangesresponse.md)
- [CloudKit.RecordZoneNotification](cloudkitjs/cloudkit.recordzonenotification.md)
- [CloudKit.RecordZonesResponse](cloudkitjs/cloudkit.recordzonesresponse.md)
- [CloudKit.Response](cloudkitjs/cloudkit.response.md)
- [CloudKit.ShareRecordType](cloudkitjs/cloudkit.sharerecordtype.md)
- [CloudKit.SubscriptionsResponse](cloudkitjs/cloudkit.subscriptionsresponse.md)
- [CloudKit.UserIdentitiesResponse](cloudkitjs/cloudkit.useridentitiesresponse.md)

### Structures

- [CloudKit.CloudKitConfig](cloudkitjs/cloudkit.cloudkitconfig.md)
- [CloudKit.ContainerConfig](cloudkitjs/cloudkit.containerconfig.md)
- [CloudKit.NameComponents](cloudkitjs/cloudkit.namecomponents.md)
- [CloudKit.NotificationInfo](cloudkitjs/cloudkit.notificationinfo.md)
- [CloudKit.Query](cloudkitjs/cloudkit.query.md)
- [CloudKit.Record](cloudkitjs/cloudkit.record.md)
- [CloudKit.RecordField](cloudkitjs/cloudkit.recordfield.md)
- [CloudKit.RecordInfo](cloudkitjs/cloudkit.recordinfo.md)
- [CloudKit.RecordZone](cloudkitjs/cloudkit.recordzone.md)
- [CloudKit.RecordZoneChanges](cloudkitjs/cloudkit.recordzonechanges.md)
- [CloudKit.RecordZoneChangesOptions](cloudkitjs/cloudkit.recordzonechangesoptions.md)
- [CloudKit.Share](cloudkitjs/cloudkit.share.md)
- [CloudKit.ShareParticipant](cloudkitjs/cloudkit.shareparticipant.md)
- [CloudKit.SharingUIResult](cloudkitjs/cloudkit.sharinguiresult.md)
- [CloudKit.Subscription](cloudkitjs/cloudkit.subscription.md)
- [CloudKit.UserIdentity](cloudkitjs/cloudkit.useridentity.md)
- [CloudKit.UserLookupInfo](cloudkitjs/cloudkit.userlookupinfo.md)
- [CloudKit.ZoneID](cloudkitjs/cloudkit.zoneid.md)

## See Also

### Classes

- [CloudKit.CKError](cloudkitjs/cloudkit.ckerror.md)
- [CloudKit.Container](cloudkitjs/cloudkit.container.md)
- [CloudKit.Database](cloudkitjs/cloudkit.database.md)
- [CloudKit.DatabaseChangesResponse](cloudkitjs/cloudkit.databasechangesresponse.md)
- [CloudKit.Notification](cloudkitjs/cloudkit.notification.md)
- [CloudKit.QueryNotification](cloudkitjs/cloudkit.querynotification.md)
- [CloudKit.QueryResponse](cloudkitjs/cloudkit.queryresponse.md)
- [CloudKit.RecordInfosResponse](cloudkitjs/cloudkit.recordinfosresponse.md)
- [CloudKit.RecordsBatchBuilder](cloudkitjs/cloudkit.recordsbatchbuilder.md)
- [CloudKit.RecordsResponse](cloudkitjs/cloudkit.recordsresponse.md)
- [CloudKit.RecordZoneChangesResponse](cloudkitjs/cloudkit.recordzonechangesresponse.md)
- [CloudKit.RecordZoneNotification](cloudkitjs/cloudkit.recordzonenotification.md)
- [CloudKit.RecordZonesResponse](cloudkitjs/cloudkit.recordzonesresponse.md)
- [CloudKit.Response](cloudkitjs/cloudkit.response.md)
- [CloudKit.ShareRecordType](cloudkitjs/cloudkit.sharerecordtype.md)