Docs menu · Reference

Lists JSON secondary index definitions in the selected branch and space, including each index’s field path and kind.

Paginated responses use opaque cursors. Clients should pass the returned cursor back to the same command shape and must not parse cursor contents.

Examples

List secondary indexes.

CLI

$ strata json index create by_name $.name tag
$ strata json index list

Wire

{"field_path":"$.name","index_type":"tag","name":"by_name","type":"json_create_index"}
{"type":"json_list_indexes"}

Parameters

No parameters.

Plus the optional scope: branch and space (default to the session branch and the "default" space).

Returns

Page<JsonIndexDefinition, String>.

Errors

Invocation

  • CLI: strata json index list
  • Wire type: json_list_indexes

agents: this page as markdown → /docs/reference/json/index/list.md