Core
API v2.x
2

0x01: services #

Subdomain: 0x0101: storage #

id / codeclass / statusmessagedescription
services.storage.unknown_index
0x01010001
PreconditionError
(412)
The index "%s" does not exist.The provided data index does not exist
services.storage.unknown_collection
0x01010002
PreconditionError
(412)
The collection "%s":"%s" does not exist.The provided data collection does not exist
services.storage.get_limit_exceeded
0x01010003
SizeLimitError
(413)
The number of documents returned by this request exceeds the configured server limit.The number of documents returned by this request exceeds the configured server limit
services.storage.write_limit_exceeded
0x01010004
SizeLimitError
(413)
The number of documents edited by this request exceeds the configured server limit.The number of documents edited by this request exceeds the configured server limit
services.storage.import_failed
0x01010005
PartialError
(206)
Failed to import some or all documents.Failed to import some or all documents
services.storage.no_multi_indexes
0x01010006
BadRequestError
(400)
Cannot be run on multiple indexes.Cannot be run on multiple indexes
services.storage.no_multi_collections
0x01010007
BadRequestError
(400)
Cannot be run on multiple collections.Cannot be run on multiple collections
services.storage.incomplete_delete
0x01010009
PartialError
(206)
Couldn't delete all the requested documents: %sCouldn't delete all the requested documents
services.storage.not_found
0x0101000b
NotFoundError
(404)
Document "%s" not found in "%s":"%s".Document not found
services.storage.bootstrap_timeout
0x0101000c
InternalError
(500)
%s: bootstrap failed - lock wait timeout exceeded.Bootstrap of a storage instance failed because it has been locked for too much time
services.storage.version_mismatch
0x0101000d
InternalError
(500)
Your elasticsearch version is %s: this version is not compatible with this version of KuzzleThe version of the target Elasticsearch is not compatible with this version of Kuzzle
services.storage.unknown_scroll_id
0x0101000e
NotFoundError
(404)
Non-existing or expired scroll identifier.The scroll identifier does not exist or has expired
services.storage.search_as_an_id
0x0101000f
BadRequestError
(400)
_search is not a valid document identifierUsed "_search" as a document identifier, which conflicts with the _search HTTP route
services.storage.unknown_index_collection
0x01010010
PreconditionError
(412)
The provided index and/or collection doesn't exist.The provided index and/or collection doesn't exist
services.storage.document_already_exists
0x01010011
BadRequestError
(400)
Document already exists.A document with the same identifier already exists
services.storage.missing_argument
0x01010012
BadRequestError
(400)
Required argument "%s" is missing or is emptyA required argument is missing or is empty
services.storage.invalid_argument
0x01010013
BadRequestError
(400)
Argument "%s" is invalid (expected: %s)Invalid argument provided
services.storage.index_protected
0x01010014
Deprecated since 2.5.0
BadRequestError
(400)
Index '%s' is protected, use the appropriated routes instead.The content of a protected index cannot be modified with generic API routes
services.storage.invalid_mapping
0x01010015
BadRequestError
(400)
Invalid mapping property "mappings.%s".%sThe provided mapping is invalid
services.storage.collection_reserved
0x01010016
BadRequestError
(400)
Invalid collection name. "%s" is reserved for internal usage.Collections cannot be named "_kuzzle_keep" because it is reserved for internal use.
services.storage.no_routing
0x01010017
BadRequestError
(400)
The "_routing" keyword is forbidden.The "_routing" keyword is forbidden
services.storage.not_connected
0x01010018
ExternalServiceError
(500)
Elasticsearch service is not connected.Unable to connect to the storage instance
services.storage.too_many_operations
0x01010019
ExternalServiceError
(500)
"%s" threads buffer exceeded. Too many operations received at once.Too many operations received
services.storage.cannot_change_mapping
0x0101001a
BadRequestError
(400)
Field "%s" already has a mapping, and it cannot be changedCannot change the mapping of a field (once set, a field mapping cannot be changed)
services.storage.duplicate_field_mapping
0x0101001b
BadRequestError
(400)
Cannot set mapping for field "%s" on collection "%s" because this field name is already used in another collection, with a different type.A same field cannot have different mappings within the same index (fields are shared to all of an index collections)
services.storage.unexpected_properties
0x0101001c
BadRequestError
(400)
Property "%s" is not supported for field "%s".Unexpected properties found
services.storage.invalid_mapping_type
0x0101001d
BadRequestError
(400)
Field "%s": the data type "%s" doesn't existUnrecognized mapping data type
services.storage.wrong_mapping_property
0x0101001e
BadRequestError
(400)
Cannot parse mapping property "%s"A mapping property cannot be parsed
services.storage.invalid_mapping_argument
0x0101001f
BadRequestError
(400)
Field "%s": invalid mapping property "%s".Invalid mapping property
services.storage.too_many_changes
0x01010020
ExternalServiceError
(500)
Unable to modify document "%s": cluster sync failed (too many simultaneous changes applied)Too many changes occured on the same resource in a small amount of time. Try with the "retryOnConflict" option
services.storage.unexpected_bad_request
0x01010021
BadRequestError
(400)
%sEmbeds an unexpected bad request error from Elasticsearch
services.storage.unexpected_not_found
0x01010022
NotFoundError
(404)
%sEmbeds an unexpected notfound error from Elasticsearch
services.storage.unexpected_error
0x01010023
ExternalServiceError
(500)
%sEmbeds an unexpected error from Elasticsearch
services.storage.no_mapping_found
0x01010025
NotFoundError
(404)
No mapping found for index "%s".Attempted to read a non-existent mapping
services.storage.index_already_exists
0x01010026
PreconditionError
(412)
A %s index named "%s" already existsAttempted to create an already existing index
services.storage.forbidden_character
0x01010027
Deprecated since 2.0.1
BadRequestError
(400)
An index or a collection name cannot contain the character "%s"An index or a collection name contains a forbidden character
services.storage.invalid_search_query
0x01010028
BadRequestError
(400)
The argument "%s" is not allowed at this level of a search query.A forbidden argument has been provided in the search query
services.storage.invalid_index_name
0x01010029
BadRequestError
(400)
The index name "%s" is invalidA provided index name is invalid
services.storage.invalid_collection_name
0x0101002a
BadRequestError
(400)
The collection name "%s" is invalidA provided collection name is invalid
services.storage.strict_mapping_rejection
0x0101002b
BadRequestError
(400)
Cannot create document. Field "%s" is not present in collection "%s:%s" strict mappingDocument rejected because it contains a field that is not declared in the strict mapping.
services.storage.scroll_duration_too_great
0x0101002c
BadRequestError
(400)
Scroll duration "%s" is too great.The scroll duration exceed the configured maxium value. (See config.services.storageEngine.maxScrollDuration)
services.storage.unknown_query_keyword
0x0101002d
BadRequestError
(400)
The keyword "%s" is not part of Elasticsearch Query DSL. Are you trying to use a Koncorde query?An unknown keyword has been provided in the search query
services.storage.incomplete_update
0x0101002e
MultipleErrorsError
(400)
%s documents were successfully updated before an error occuredCouldn't update all the requested documents
services.storage.invalid_query_keyword
0x0101002f
BadRequestError
(400)
The "%s" keyword is not allowed in this query.A forbidden keyword has been provided in the query
services.storage.multiple_indice_alias
0x01010030
PreconditionError
(412)
An %s is not allowed to be associated with multiple %s. This is probably not linked to this request but rather the consequence of previous actions on ElasticSearch.The unique association between an indice and its alias has not been respected
services.storage.invalid_multi_index_collection_usage
0x01010031
BadRequestError
(400)
Searches on multiple collections should be achieved with the "targets" argument who contains list of indexes and collections to search within.Searches on multiple collections should be achieved with the "targets" argument who contains list of indexes and collections to search within.
services.storage.invalid_target_format
0x01010032
BadRequestError
(400)
The %s ("%s") contains invalid characters ",+*" or is equal to "_all" which is forbiddenWhen a target index or collections contains invalid characters used for multi index search or "_all"
services.storage.wrong_es_static_settings_for_collection_recreation
0x01010033
BadRequestError
(400)
Attempt to recreate an existing collection %s of index %s of scope %s with non matching static setting : %s at %s while existing one is at %sThe ES static settings specified at the creation of an existing collection does not match existing settings

Subdomain: 0x0103: cache #

id / codeclass / statusmessagedescription
services.cache.database_not_found
0x01030001
NotFoundError
(404)
Cache database "%s" not found.Unknown cache database name
services.cache.read_failed
0x01030002
InternalError
(500)
Cache read fail: %sAn attempt to read from the cache failed
services.cache.not_connected
0x01030003
ServiceUnavailableError
(503)
Unable to connect to the cache server.Unable to connect to the cache server
services.cache.write_failed
0x01030004
InternalError
(500)
Cache write fail: %sAn attempt to write to the cache failed

Subdomain: 0x0104: statistics #

id / codeclass / statusmessagedescription
services.statistics.not_available
0x01040001
InternalError
(500)
Statistics module is not available.The statistics module is not enabled. See "config.stats.enabled".

Subdomain: 0x0105: koncorde #

id / codeclass / statusmessagedescription
services.koncorde.elastic_translation_error
0x01050001
BadRequestError
(400)
An error occured while translating a Koncorde filter to an Elasticsearch query: %sAn error occured while translating a Koncorde filter to an Elasticsearch query