<!--
{
  "availability" : [

  ],
  "documentType" : "symbol",
  "framework" : "CKToolJS",
  "identifier" : "/documentation/CKToolJS/PromisesApi",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "CKTool JS"
    ],
    "preciseIdentifier" : "cl/PromisesApi"
  },
  "title" : "PromisesApi"
}
-->

# PromisesApi

A class that exposes promise-based functions for interacting with the API.

```
interface PromisesApi
```

## Overview

You use an instance of `PromisesApi` to interact with the API. Methods on this class return promises that complete with a response object.

## Topics

### Record Management

[`CancellablePromise acceptRecord(
	AcceptRecordParams params
);`](/documentation/CKToolJS/PromisesApi/acceptRecord)

Accepts a share on behalf of the current user.

[`CancellablePromise createRecord(
	CreateRecordParams params
);`](/documentation/CKToolJS/PromisesApi/createRecord)

Creates a new record.

[`CancellablePromise deleteRecord(
	DeleteRecordParams params
);`](/documentation/CKToolJS/PromisesApi/deleteRecord)

Deletes a single record.

[`CancellablePromise deleteRecordsByQuery(
	DeleteRecordsByQueryParams params
);`](/documentation/CKToolJS/PromisesApi/deleteRecordsByQuery)

Deletes records matching the provided query.

[`CancellablePromise getRecord(
	GetRecordParams params
);`](/documentation/CKToolJS/PromisesApi/getRecord)

Returns a record’s details.

[`CancellablePromise lookupRecords(
	LookupRecordsParams params
);`](/documentation/CKToolJS/PromisesApi/lookupRecords)

Fetches multiple records by record name.

[`CancellablePromise queryRecordChanges(
	QueryRecordChangesParams params
);`](/documentation/CKToolJS/PromisesApi/queryRecordChanges)

Returns records that changed since a specified sync token or since a zone was created.

[`CancellablePromise queryRecords(
	QueryRecordsParams params
);`](/documentation/CKToolJS/PromisesApi/queryRecords)

Returns a collection of records matching the provided query.

[`CancellablePromise resolveRecord(
	ResolveRecordParams params
);`](/documentation/CKToolJS/PromisesApi/resolveRecord)

Fetches information about records given their shortGuid properties.

[`CancellablePromise updateRecord(
	UpdateRecordParams params
);`](/documentation/CKToolJS/PromisesApi/updateRecord)

Updates an existing record.

### Zone Management

[`CancellablePromise createZone(
	CreateZoneParams params
);`](/documentation/CKToolJS/PromisesApi/createZone)

Creates a new zone.

[`CancellablePromise deleteZone(
	DeleteZoneParams params
);`](/documentation/CKToolJS/PromisesApi/deleteZone)

Deletes a zone.

[`CancellablePromise getZone(
	GetZoneParams params
);`](/documentation/CKToolJS/PromisesApi/getZone)

Returns details for a zone.

[`CancellablePromise getZones(
	GetZonesParams params
);`](/documentation/CKToolJS/PromisesApi/getZones)

Returns a collection of zones.

### Database Management

[`CancellablePromise exportSchema(
	ExportSchemaParams params
);`](/documentation/CKToolJS/PromisesApi/exportSchema)

Downloads the container’s schema.

[`CancellablePromise getContainers(
	GetContainersParams params
);`](/documentation/CKToolJS/PromisesApi/getContainers)

Fetches containers for a team.

[`CancellablePromise importSchema(
	ImportSchemaParams params
);`](/documentation/CKToolJS/PromisesApi/importSchema)

Uploads a file that defines the new schema for the container.

[`CancellablePromise resetConfigToProduction(
	ResetConfigToProductionParams params
);`](/documentation/CKToolJS/PromisesApi/resetConfigToProduction)

Resets the container configuration to production.

[`CancellablePromise resetToProduction(
	ResetToProductionParams params
);`](/documentation/CKToolJS/PromisesApi/resetToProduction)

Resets the schema of the environment to production.

[`CancellablePromise validateSchema(
	ValidateSchemaParams params
);`](/documentation/CKToolJS/PromisesApi/validateSchema)

Validates the uploaded schema file for the container.

### Database Field Values, Structures and Enumerations

[Field Values](/documentation/CKToolJS/field-values)

[Database Structures and Enumerations](/documentation/CKToolJS/database-structures-and-enumerations)

### Asset Creation

[`CancellablePromise createAssetUploadUrl(
	CreateAssetUploadUrlParams params
);`](/documentation/CKToolJS/PromisesApi/createAssetUploadUrl)

Creates a new URL for uploading assets.

### User and Team

[`CancellablePromise getSessionUser(
	GetSessionUserParams params
);`](/documentation/CKToolJS/PromisesApi/getSessionUser)

Returns details for the user in current session.

[`CancellablePromise getTeams();`](/documentation/CKToolJS/PromisesApi/getTeams)

Fetches a list of teams the current user is in.

[`dictionary Team {
	string teamId;
	string teamName;
	string? teamType;
};`](/documentation/CKToolJS/Team)

Details of a developer team.

[`dictionary TeamsResponse {
	Team[] teams;
	string? recentTeamId;
};`](/documentation/CKToolJS/TeamsResponse)

Response object for a list of teams.

### Initialization

[`new defaultOptions(
	PromisesApiOptions defaultOptions
);`](/documentation/CKToolJS/PromisesApi/PromisesApi)

Creates a `PromisesApi` object.

[`dictionary PromisesApiOptions {
	Configuration configuration;
	Security? security;
};`](/documentation/CKToolJS/PromisesApiOptions)

A dictionary of options for promises API classes.

[`dictionary Security {
	string? CloudKitAPITokenAuth;
	string? CloudKitWebAuthTokenAuth;
	string? ManagementTokenAuth;
	string? UserTokenAuth;
};`](/documentation/CKToolJS/Security)

A dictionary of your authorization tokens.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)