Core
API v2.x
2

0x00: core #

Subdomain: 0x0000: fatal #

id / code class / status message description
core.fatal.unexpected_error
0x00000001
InternalError
(500)
Caught an unexpected error: %s. Caught an unexpected error. Please contact your support.
core.fatal.service_unavailable
0x00000002
ExternalServiceError
(500)
Service unavailable: %s. An external service is unavailable
core.fatal.service_timeout
0x00000003
InternalError
(500)
[FATAL] Service "%s": initialization timeout Service initialization timeout
core.fatal.unreadable_log_dir
0x00000004
InternalError
(500)
Cannot read log directory '%s' : %s. Cannot read the content of the log directory
core.fatal.assertion_failed
0x00000005
InternalError
(500)
Runtime assertion failed: %s A runtime assertion has failed. Please contact support.

Subdomain: 0x0001: realtime #

id / code class / status message description
core.realtime.room_not_found
0x00010001
NotFoundError
(404)
The room "%s" doesn't exist The provided room identifier doesn't exist
core.realtime.invalid_rooms
0x00010002
BadRequestError
(400)
The "rooms" attribute must be an array. The provided "rooms" argument is invalid
core.realtime.invalid_state
0x00010003
Deprecated since 2.0.0
BadRequestError
(400)
Invalid value for the "state" parameter (allowed: "all", "done", "pending"). An invalid value has been provided to the "state" argument
core.realtime.invalid_scope
0x00010004
BadRequestError
(400)
Invalid value for the "scope" parameter (allowed: "all", "in", "out", "none"). An invalid value has been provided to the "scope" argument
core.realtime.invalid_users
0x00010005
BadRequestError
(400)
Invalid value for the "users" parameter (allowed: "all", "in", "out", "none"). An invalid value has been provided to the "users" argument
core.realtime.too_many_terms
0x00010006
Deprecated since 2.12.3
SizeLimitError
(413)
Unable to subscribe: maximum number of terms exceeded (max %s, received %s). The number of filter terms exceeds the configured server limit
core.realtime.too_many_rooms
0x00010007
SizeLimitError
(413)
Unable to subscribe: maximum number of unique rooms reached. The configured number of unique rooms has been reached
core.realtime.not_subscribed
0x00010008
PreconditionError
(412)
User "%s" has not subscribed to "%s". Tried to manage a room while not having subscribed to it

Subdomain: 0x0002: vault #

id / code class / status message description
core.vault.cannot_decrypt
0x00020001
InternalError
(500)
Cannot decrypt secrets: %s. Decryption of a vault file failed
core.vault.key_not_found
0x00020002
InternalError
(500)
Cannot find vault key. Aborting. A vault file has been provided without a vault key

Subdomain: 0x0003: configuration #

id / code class / status message description
core.configuration.invalid_type
0x00030001
InternalError
(500)
Invalid type for the configuration parameter "%s" (expected: %s) Wrong configuration parameter type
core.configuration.out_of_range
0x00030002
InternalError
(500)
The configuration value set for "%s" is outside the allowed range (allowed: %s) A configuration value exceeds the allowed range
core.configuration.cannot_parse
0x00030003
InternalError
(500)
Unable to read kuzzlerc configuration file: %s The kuzzlerc configuration file is badly formatted.
core.configuration.incompatible
0x00030004
InternalError
(500)
Incompatible configuration: %s The kuzzlerc configuration file has incompatible configurations

Subdomain: 0x0004: sandbox #

Deprecated since 2.0.0
id / code class / status message description
core.sandbox.process_already_running
0x00040001
InternalError
(500)
A process is already running for this sandbox A process is already running for this sandbox
core.sandbox.timeout
0x00040002
GatewayTimeoutError
(504)
Timeout. The sandbox did not respond within %sms. Sandbox execution timed out

Subdomain: 0x0005: debugger #

id / code class / status message description
core.debugger.not_enabled
0x00050001
PreconditionError
(412)
Debugger is not enabled The debugger is not enabled
core.debugger.monitor_already_running
0x00050002
PreconditionError
(412)
The monitoring of "%s" is already running The monitor is already running
core.debugger.monitor_not_running
0x00050003
PreconditionError
(412)
The monitoring of "%s" is not running The monitor is not running
core.debugger.native_debug_protocol_usage_denied
0x00050004
PreconditionError
(412)
Usage of the native debug protocol is not allowed Usage of the native debug protocol is not allowed
core.debugger.method_not_found
0x00050005
PreconditionError
(412)
Debugger method "%s" not found. Debugger method not found