Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

​
Summary

List all index blocks in the document.
  • Operation ID: index.list
  • API member path: editor.doc.index.list(...)
  • Mutates document: no
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

​
Expected result

Returns an IndexListResult containing discovered index blocks with address and domain data.

​
Input fields

FieldTypeRequiredDescription
limitintegerno
offsetintegerno

​
Example request

{
  "limit": 50,
  "offset": 0
}

​
Output fields

No fields.

​
Example response

{}

​
Pre-apply throws

  • CAPABILITY_UNAVAILABLE
  • INVALID_INPUT

​
Non-applied failure codes

  • None

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "limit": {
      "minimum": 1,
      "type": "integer"
    },
    "offset": {
      "minimum": 0,
      "type": "integer"
    }
  },
  "type": "object"
}

{
  "type": "object"
}