Document apiReferenceDocument index

index.entries.list

List all XE (index entry) fields in the document.

read-onlyidempotent
doc.index.entries.list(…)

Expected result

Returns an IndexEntryListResult containing discovered index entries with address and domain data.

Inputs

entryTypestring
limitinteger
offsetinteger

Result

Output fields

No fields.

Failures

Pre-apply throws

  • CAPABILITY_UNAVAILABLE
  • INVALID_INPUT

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas