Kuzzle v1
Kuzzle v2

Use
Extend
- Write Plugins
- Write Protocols

Kuzzle Documentation

Write Protocols

Getting Started

Browser (Vanilla)

React

React with Redux

VueJS

Essentials

Realtime notifications

Extends the SDK

Core Classes

BaseController

Kuzzle

KuzzleError

KuzzleEventEmitter

addOnceListener

prependListener

prependOnceListener

removeAllListeners

Profile

Role

SearchResult

User

Protocols

Http

SocketIO

WebSocket

Controllers

auth

createMyCredentials

credentialsExist

deleteMyCredentials

getMyCredentials

updateMyCredentials

validateMyCredentials

bulk

collection

deleteSpecifications

getSpecifications

searchSpecifications

updateSpecifications

validateSpecifications

document

createOrReplace

mCreateOrReplace

index

refreshInternal

ms

georadiusbymember

zremrangebyrank

zremrangebyscore

zrevrangebyscore

realtime

security

createCredentials

createFirstAdmin

createOrReplaceProfile

createOrReplaceRole

createRestrictedUser

deleteCredentials

getAllCredentialFields

getCredentialFields

getCredentialsById

getProfileMapping

getProfileRights

mDeleteProfiles

updateCredentials

updateProfileMapping

updateRoleMapping

updateUserMapping

validateCredentials

server

Select an SDK

API 2.x
Javascript 7.x
C# 2.x
Java 3.x
Dart 2.x

once

Alias for addOnceListener.

Github

Contribute to Kuzzle projects
Stack Overflow

Ask a question
Discord

Chat with the community and Kuzzle developers
Youtube

Check out our tutorial videos

©2020 - Kuzzle.io

Apache 2.0 License