Kuzzle Backend v2
Kuzzle IoT v3
Customer access
Kuzzle Backend v2
Kuzzle PaaS
Kuzzle AI Agent
Guide
API
Framework
SDKs
Plugins
Modules
Drivers
Search
Ctrl K
Discover Kuzzle
Kuzzle Backend v2
Kuzzle IoT v3
Customer access
Kuzzle Backend v2
Kuzzle PaaS
Kuzzle AI Agent
Guide
API
Framework
SDKs
Plugins
Modules
Drivers
Javascript v7.x
API v2.x
Golang v3.x
Java v3.x
C# v2.x
Dart v2.x
Dart Null Safety v3.x
Jvm v1.x
Getting Started
Node.js
Browser (Vanilla)
React
Standalone
React with Redux
Protocols
Http
WebSocket
Essentials
Error Handling
Events
Realtime notifications
Offline Tools
Extends the SDK
Realtime Application
Batch Processing
Debugging
Strong Typing
Controllers
auth
checkRights
checkToken
createApiKey
createMyCredentials
credentialsExist
deleteApiKey
deleteMyCredentials
getCurrentUser
getMyCredentials
getMyRights
getStrategies
login
logout
refreshToken
searchApiKeys
updateMyCredentials
updateSelf
validateMyCredentials
bulk
deleteByQuery
import
mWrite
updateByQuery
write
collection
create
delete
deleteSpecifications
exists
getMapping
getSpecifications
list
refresh
searchSpecifications
truncate
update
updateMapping
updateSpecifications
validateSpecifications
document
count
create
createOrReplace
delete
deleteByQuery
deleteFields
exists
get
mCreate
mCreateOrReplace
mDelete
mGet
mReplace
mUpdate
mUpsert
replace
search
update
updateByQuery
upsert
validate
index
create
delete
exists
list
mDelete
stats
ms
append
bitcount
bitop
bitpos
dbsize
decr
decrby
del
exists
expire
expireat
flushdb
geoadd
geodist
geohash
geopos
georadius
georadiusbymember
get
getbit
getrange
getset
hdel
hexists
hget
hgetall
hincrby
hincrbyfloat
hkeys
hlen
hmget
hmset
hscan
hset
hsetnx
hstrlen
hvals
incr
incrby
incrbyfloat
keys
lindex
linsert
llen
lpop
lpush
lpushx
lrange
lrem
lset
ltrim
mexecute
mget
mset
msetnx
object
persist
pexpire
pexpireat
pfadd
pfcount
pfmerge
ping
psetex
pttl
randomkey
rename
renamenx
rpop
rpoplpush
rpush
rpushx
sadd
scan
scard
sdiff
sdiffstore
set
setex
setnx
sinter
sinterstore
sismember
smembers
smove
sort
spop
srandmember
srem
sscan
strlen
sunion
sunionstore
time
touch
ttl
type
zadd
zcard
zcount
zincrby
zinterstore
zlexcount
zrange
zrangebylex
zrangebyscore
zrank
zrem
zremrangebylex
zremrangebyrank
zremrangebyscore
zrevrange
zrevrangebylex
zrevrangebyscore
zrevrank
zscan
zscore
zunionstore
realtime
count
publish
subscribe
unsubscribe
security
checkRights
createApiKey
createCredentials
createFirstAdmin
createOrReplaceProfile
createOrReplaceRole
createProfile
createRestrictedUser
createRole
createUser
deleteApiKey
deleteCredentials
deleteProfile
deleteRole
deleteUser
getAllCredentialFields
getCredentialFields
getCredentials
getCredentialsById
getProfile
getProfileMapping
getProfileRights
getRole
getRoleMapping
getUser
getUserMapping
getUserRights
getUserStrategies
hasCredentials
mDeleteProfiles
mDeleteRoles
mDeleteUsers
mGetProfiles
mGetRoles
mGetUsers
refresh
replaceUser
searchApiKeys
searchProfiles
searchRoles
searchUsers
updateCredentials
updateProfile
updateProfileMapping
updateRole
updateRoleMapping
updateUser
updateUserMapping
validateCredentials
server
adminExists
getAllStats
getConfig
getLastStats
getStats
info
now
Core Classes
BaseController
Introduction
Properties
query
Kuzzle
Introduction
Properties
constructor
authenticate
connect
disconnect
flushQueue
playQueue
query
startQueuing
stopQueuing
useController
KuzzleError
Introduction
Properties
KuzzleEventEmitter
Introduction
addListener
addOnceListener
emit
listeners
on
once
prependListener
prependOnceListener
removeAllListeners
removeListener
Profile
Introduction
Properties
getRoles
serialize
Role
Introduction
Properties
serialize
SearchResult
Properties
next
User
Introduction
Properties
getProfiles
serialize
BatchController
Introduction
constructor
dispose
Observer
Introduction
constructor
get
mGet
observe
search
stop
Javascript v7.x
API v2.x
Golang v3.x
Java v3.x
C# v2.x
Dart v2.x
Dart Null Safety v3.x
Jvm v1.x
Javascript SDK v7.x
Controllers
realtime
Realtime Controller
#
