Core
API v2.x
2

create #

Creates a new index in Kuzzle.

Index names must meet the following criteria:

  • Lowercase only
  • Cannot include one of the following characters: \\, /, *, ?, ", <, >, |, (space character), ,, #, :, %, &, .
  • Cannot be longer than 126 bytes (note it is bytes, so multi-byte characters will count towards the 126 limit faster)

Query Syntax #

HTTP #

Copied to clipboard!
URL: http://kuzzle:7512/<index>/_create
Method: POST

Other protocols #

Copied to clipboard!
{
  "index": "<index>",
  "controller": "index",
  "action": "create"
}

Arguments #

  • index: index name to create

Response #

Returns a confirmation that the index is being created:

Copied to clipboard!
{
  "status": 200,
  "error": null,
  "index": "<index>",
  "action": "create",
  "controller": "index",
  "requestId": "<unique request identifier>"
}

Possible errors #