Index APIs¶

The Index API is used to manage individual indices.

Get Index API¶

The Get Index API allows to retrieve information about the index. The most basic usage is the following:

GET /rest/<INDEX_NAME>

The Create Index API is used to manually create an index in Cockatrice. The most basic usage is the following:

PUT /rest/<INDEX_NAME>?sync=<SYNC>
---
schema:
  id:
    field_type: id
    args:
      unique: true
      stored: true
...

<INDEX_NAME>: The index name.
<SYNC>: Specifies whether to execute the command synchronously or asynchronously. If True is specified, command will execute synchronously. Default is False, command will execute asynchronously.
Request Body: YAML formatted schema definition.

The Delete Index API allows to delete an existing index. The most basic usage is the following:

DELETE /rest/<INDEX_NAME>?sync=<SYNC>

<INDEX_NAME>: The index name.
<SYNC>: Specifies whether to execute the command synchronously or asynchronously. If True is specified, command will execute synchronously. Default is False, command will execute asynchronously.