Index | Hanzo Docs

Package index is fast full-text search over your own data, typos forgiven.

17 commands · API reference →

Command	Calls	What it does
`hanzo index health`	`GET /v1/index/health`	Reports whether the search plane can serve.
`hanzo index indexes documents get <uid> <id>`	`GET /v1/index/indexes/{uid}/documents/{id}`	Reads one document by its primary key.
`hanzo index indexes documents rm <uid> <id>`	`DELETE /v1/index/indexes/{uid}/documents/{id}`	Deletes one document by its primary key.
`hanzo index indexes documents delete-batch <uid>`	`POST /v1/index/indexes/{uid}/documents/delete-batch`	Delete many documents by primary key in one call
`hanzo index indexes documents list <uid>`	`GET /v1/index/indexes/{uid}/documents`	Pages through the documents in an index.
`hanzo index indexes documents create <uid>`	`POST /v1/index/indexes/{uid}/documents`	Add or replace documents in an index
`hanzo index indexes documents replace <uid>`	`PUT /v1/index/indexes/{uid}/documents`	Add or update documents in an index
`hanzo index indexes search <uid>`	`POST /v1/index/indexes/{uid}/search`	Searches an index, forgiving typos.
`hanzo index indexes settings get <uid>`	`GET /v1/index/indexes/{uid}/settings`	Reads an index's filterable attributes.
`hanzo index indexes settings patch <uid>`	`PATCH /v1/index/indexes/{uid}/settings`	Sets which attributes an index can be filtered on.
`hanzo index indexes get <uid>`	`GET /v1/index/indexes/{uid}`	Reads one index's definition.
`hanzo index indexes rm <uid>`	`DELETE /v1/index/indexes/{uid}`	Deletes an index and everything in it.
`hanzo index indexes list`	`GET /v1/index/indexes`	Lists the indexes your org holds.
`hanzo index indexes create`	`POST /v1/index/indexes`	Creates an index.
`hanzo index stats`	`GET /v1/index/stats`	Counts the documents in each of your indexes.
`hanzo index tasks get 1`	`GET /v1/index/tasks/{uid}`	Checks a write task, which has already finished.
`hanzo index version`	`GET /v1/index/version`	Identifies the search implementation answering.