index/get FormID 20301
Retrieve the full details of a named index: field mappings, index settings, aliases, document count, and storage size. Routes to the error port if the index does not exist.
When to Use
- Existence check before create: Before running
index/create, check whether the index already exists — use the success/error port split as a branch. Success means it exists; error (404) means it is safe to create. - Mapping inspection: Retrieve the current field mappings to validate that a required field is present and correctly typed before starting a bulk indexing job.
- Settings audit: Verify shard count, replica count, refresh interval, or custom analyzer configuration as part of an environment health-check workflow.
- Capacity monitoring: Read the document count and store size to detect index growth, trigger rotation, or generate a capacity report.
Configuration
Connection
| Field | Required | Description |
|---|---|---|
Host | Required | Elasticsearch cluster URL, e.g. https://localhost:9200. |
Username | Optional | Elasticsearch username (required if security is enabled). |
Password | Optional | Password for the specified username. |
IgnoreSSL | Optional | Default false. Skip TLS validation. Development use only. |
Operation
| Field | Required | Description |
|---|---|---|
IndexName | Required | The name of the index to retrieve. Must be an exact match — wildcards are not supported. |
Validation Errors
| Error Code | Cause |
|---|---|
VAL_MISSING_INDEX_NAME | IndexName is empty. |
Output
Success Port
Returns the Elasticsearch index details object. The response mirrors the structure returned by the Elasticsearch Get Index API:
| Field | Type | Description |
|---|---|---|
mappings | object | All field mappings for the index — field names, types, and analyzer configuration. |
settings | object | Index settings including shard count, replica count, refresh interval, and custom analysis configuration. |
aliases | object | All aliases pointing to this index. Empty object if no aliases are configured. |
stats | object | Index statistics including docs.count (total documents), docs.deleted, and store.size_in_bytes. |
Error Port
Fires when the index does not exist (404), authentication fails, or a network error occurs. Use the error port as the "index does not exist" branch in existence-check patterns.
{{ $output.checkIndex.stats.docs.count }}. Access a specific field type with {{ $output.checkIndex.mappings.properties.fieldName.type }}.
Examples
Existence Check — Provision if Missing
{
"resource": "index",
"operation": "get",
"IndexName": "products"
}Connect the success port to a "skip creation" branch. Connect the error port to an index/create node to create the index on first run. This pattern makes provisioning workflows idempotent.
Capacity Report
{
"resource": "index",
"operation": "get",
"IndexName": "{{ $json.indexName }}"
}After this node succeeds, use {{ $output.getIndex.stats.docs.count }} and {{ $output.getIndex.stats.store.size_in_bytes }} to build a capacity alert or dashboard payload.
Mapping Verification Before Bulk Insert
{
"resource": "index",
"operation": "get",
"IndexName": "orders"
}Downstream, use an if node to check: {{ $output.checkOrders.mappings.properties.customerId.type === 'keyword' }}. If the type is wrong, route to an error notification instead of proceeding with the bulk insert.