Portal Community

When to Use

Configuration

Connection

FieldRequiredDescription
HostRequiredElasticsearch cluster URL, e.g. https://localhost:9200.
UsernameOptionalElasticsearch username (required if security is enabled).
PasswordOptionalPassword for the specified username.
IgnoreSSLOptionalDefault false. Skip TLS validation. Development use only.

Operation

FieldRequiredDescription
LimitOptionalMaximum number of indices to return. Default 50. Ignored when ReturnAll is true.
ReturnAllOptionalDefault false. When true, returns every accessible index regardless of count. Use for complete cluster inventories and retention workflows.

Output

Success Port

Returns the list of indices. Each entry in the result corresponds to one index and includes:

FieldTypeDescription
indexstringIndex name.
healthstringCluster health for this index: green, yellow, or red.
statusstringopen or close.
docs.countintegerNumber of indexed documents.
docs.deletedintegerNumber of documents pending deletion (not yet merged away).
store.sizestringHuman-readable store size (e.g. 12.3mb).

Error Port

Fires on authentication failure, connection error, or if the configured user has no accessible indices. The error output contains errorCode and message fields.

The result is returned as a data object from the node. Iterate over the index list downstream using a loop node, or filter by name prefix in a code/transform node to isolate a specific index pattern.

Examples

List All Indices (Default Limit)

{
  "resource": "index",
  "operation": "getMany"
}

Returns up to 50 indices. Useful for quick cluster inspections or admin UI population.

Full Cluster Inventory

{
  "resource": "index",
  "operation": "getMany",
  "ReturnAll": true
}

Returns every index accessible to the configured user. Pass the result to a loop node and filter by index name prefix to identify old time-series indices for cleanup.

Health Monitoring Workflow

{
  "resource": "index",
  "operation": "getMany",
  "ReturnAll": true
}

After this node, use a filter/transform node to extract entries where health === "red". If any red indices exist, route to a Slack or email alert node with the list of unhealthy indices. Schedule this workflow to run every 15 minutes.