Core
API v2.x
2
Kuzzle Backend v2
Kuzzle IoT v4
Kuzzle IoT v3
Kuzzle Backend v2
Kuzzle PaaS
Kuzzle AI Agent
Guide
API
Framework
SDKs
Plugins
Modules
Search
Ctrl
K
Discover Kuzzle
Kuzzle Backend v2
Kuzzle IoT v4
Kuzzle IoT v3
Kuzzle Backend v2
Kuzzle PaaS
Kuzzle AI Agent
Guide
API
Framework
SDKs
Plugins
Modules
API v2.x
Javascript v7.x
Golang v3.x
Java v3.x
C# v2.x
Dart v2.x
Dart Null Safety v3.x
Jvm v1.x
Payloads
Request
Response
Notifications
Error
Errors
Error Types
API Error Codes
0x00: core
0x01: services
0x02: api
0x03: network
0x04: plugin
0x05: validation
0x06: protocol
0x07: security
0x08: cluster
Controllers
admin
dump
loadFixtures
loadMappings
loadSecurities
resetCache
resetDatabase
resetSecurity
shutdown
auth
checkRights
checkToken
createApiKey
createMyCredentials
createToken
credentialsExist
deleteApiKey
deleteMyCredentials
getCurrentUser
getMyCredentials
getMyRights
getStrategies
login
logout
refreshToken
searchApiKeys
updateMyCredentials
updateSelf
validateMyCredentials
bulk
deleteByQuery
import
mWrite
updateByQuery
write
cluster
status
collection
create
delete
deleteSpecifications
exists
getMapping
getSettings
getSpecifications
list
refresh
scrollSpecifications
searchSpecifications
truncate
update
updateMapping
updateSpecifications
validateSpecifications
debug
addListener
disable
enable
nodeVersion
post
removeListener
document
count
create
createOrReplace
delete
deleteByQuery
deleteFields
exists
export
get
mCreate
mCreateOrReplace
mDelete
mExists
mGet
mReplace
mUpdate
mUpsert
replace
scroll
search
update
updateByQuery
upsert
validate
index
create
delete
exists
list
mDelete
stats
memoryStorage
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
join
list
publish
subscribe
unsubscribe
validate
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
restrictDefaultRights
revokeTokens
scrollProfiles
scrollUsers
searchApiKeys
searchProfiles
searchRoles
searchUsers
searchUsersByCredentials
updateCredentials
updateProfile
updateProfileMapping
updateRole
updateRoleMapping
updateUser
updateUserMapping
upsertUser
validateCredentials
server
adminExists
capabilities
getAllStats
getConfig
getLastStats
getStats
healthCheck
info
metrics
now
openapi
publicApi
Protocols
HTTP
WebSocket
MQTT
Koncorde Filters Syntax
Clauses
Operators
Geo-Space
API v2.x
Javascript v7.x
Golang v3.x
Java v3.x
C# v2.x
Dart v2.x
Dart Null Safety v3.x
Jvm v1.x
Redirecting...
