Get transform information

GET /_cat/transforms/{transform_id}
GET /_cat/transforms

Get configuration and usage information about transforms.

CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.

Required authorization

Cluster privileges: monitor_transform

Path Parameters

transform_id string Id optional

A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms.

Leave it out to use /_cat/transforms.

Query Parameters

allow_no_match boolean · default: true

Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If true, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If false, the request returns a 404 status code when there are no matches or only partial matches.

from number · default: 0

Skips the specified number of transforms.

h

CatTransformColumns · default: changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state

Comma-separated list of column names to display.

Supported values include:

changes_last_detection_time (or cldt): The timestamp when changes were last detected in the source indices.
checkpoint (or cp): The sequence number for the checkpoint.
checkpoint_duration_time_exp_avg (or cdtea, checkpointTimeExpAvg): Exponential moving average of the duration of the checkpoint, in milliseconds.
checkpoint_progress (or c, checkpointProgress): The progress of the next checkpoint that is currently in progress.
create_time (or ct, createTime): The time the transform was created.
delete_time (or dtime): The amount of time spent deleting, in milliseconds.
description (or d): The description of the transform.
dest_index (or di, destIndex): The destination index for the transform. The mappings of the destination index are deduced based on the source fields when possible. If alternate mappings are required, use the Create index API prior to starting the transform.
documents_deleted (or docd): The number of documents that have been deleted from the destination index due to the retention policy for this transform.
documents_indexed (or doci): The number of documents that have been indexed into the destination index for the transform.
docs_per_second (or dps): Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a wait time between search requests. The default value is null, which disables throttling.
documents_processed (or docp): The number of documents that have been processed from the source index of the transform.
frequency (or f): The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is 1s and the maximum is 1h. The default value is 1m.
id: Identifier for the transform.
index_failure (or if): The number of indexing failures.
index_time (or itime): The amount of time spent indexing, in milliseconds.
index_total (or it): The number of index operations.
indexed_documents_exp_avg (or idea): Exponential moving average of the number of new documents that have been indexed.
last_search_time (or lst, lastSearchTime): The timestamp of the last search in the source indices. This field is only shown if the transform is running.
max_page_search_size (or mpsz): Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is 10 and the maximum is 65,536. The default value is 500.
pages_processed (or pp): The number of search or bulk index operations processed. Documents are processed in batches instead of individually.
pipeline (or p): The unique identifier for an ingest pipeline.
processed_documents_exp_avg (or pdea): Exponential moving average of the number of documents that have been processed.
processing_time (or pt): The amount of time spent processing results, in milliseconds.
reason (or r): If a transform has a failed state, this property provides details about the reason for the failure.
search_failure (or sf): The number of search failures.
search_time (or stime): The amount of time spent searching, in milliseconds.
search_total (or st): The number of search operations on the source index for the transform.
source_index (or si, sourceIndex): The source indices for the transform. It can be a single index, an index pattern (for example, "my-index-*"), an array of indices (for example, ["my-index-000001", "my-index-000002"]), or an array of index patterns (for example, ["my-index-*", "my-other-index-*"]. For remote indices use the syntax "remote_name:index_name". If any indices are in remote clusters then the master node and at least one transform node must have the remote_cluster_client node role.
state (or s): The status of the transform, which can be one of the following values:

aborting: The transform is aborting.
failed: The transform failed. For more information about the failure, check the reason field.
indexing: The transform is actively processing data and creating new documents.
started: The transform is running but not actively indexing data.
stopped: The transform is stopped.
stopping: The transform is stopping.
- transform_type (or tt): Indicates the type of transform: batch or continuous.
- trigger_count (or tc): The number of times the transform has been triggered by the scheduler. For example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the frequency property.
- version (or v): The version of Elasticsearch that existed on the node when the transform was created.

s union CatTransformColumns

Comma-separated list of column names or column aliases used to sort the response.

Supported values include:

changes_last_detection_time (or cldt): The timestamp when changes were last detected in the source indices.
checkpoint (or cp): The sequence number for the checkpoint.
checkpoint_duration_time_exp_avg (or cdtea, checkpointTimeExpAvg): Exponential moving average of the duration of the checkpoint, in milliseconds.
checkpoint_progress (or c, checkpointProgress): The progress of the next checkpoint that is currently in progress.
create_time (or ct, createTime): The time the transform was created.
delete_time (or dtime): The amount of time spent deleting, in milliseconds.
description (or d): The description of the transform.
dest_index (or di, destIndex): The destination index for the transform. The mappings of the destination index are deduced based on the source fields when possible. If alternate mappings are required, use the Create index API prior to starting the transform.
documents_deleted (or docd): The number of documents that have been deleted from the destination index due to the retention policy for this transform.
documents_indexed (or doci): The number of documents that have been indexed into the destination index for the transform.
docs_per_second (or dps): Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a wait time between search requests. The default value is null, which disables throttling.
documents_processed (or docp): The number of documents that have been processed from the source index of the transform.
frequency (or f): The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is 1s and the maximum is 1h. The default value is 1m.
id: Identifier for the transform.
index_failure (or if): The number of indexing failures.
index_time (or itime): The amount of time spent indexing, in milliseconds.
index_total (or it): The number of index operations.
indexed_documents_exp_avg (or idea): Exponential moving average of the number of new documents that have been indexed.
last_search_time (or lst, lastSearchTime): The timestamp of the last search in the source indices. This field is only shown if the transform is running.
max_page_search_size (or mpsz): Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is 10 and the maximum is 65,536. The default value is 500.
pages_processed (or pp): The number of search or bulk index operations processed. Documents are processed in batches instead of individually.
pipeline (or p): The unique identifier for an ingest pipeline.
processed_documents_exp_avg (or pdea): Exponential moving average of the number of documents that have been processed.
processing_time (or pt): The amount of time spent processing results, in milliseconds.
reason (or r): If a transform has a failed state, this property provides details about the reason for the failure.
search_failure (or sf): The number of search failures.
search_time (or stime): The amount of time spent searching, in milliseconds.
search_total (or st): The number of search operations on the source index for the transform.
source_index (or si, sourceIndex): The source indices for the transform. It can be a single index, an index pattern (for example, "my-index-*"), an array of indices (for example, ["my-index-000001", "my-index-000002"]), or an array of index patterns (for example, ["my-index-*", "my-other-index-*"]. For remote indices use the syntax "remote_name:index_name". If any indices are in remote clusters then the master node and at least one transform node must have the remote_cluster_client node role.
state (or s): The status of the transform, which can be one of the following values:

aborting: The transform is aborting.
failed: The transform failed. For more information about the failure, check the reason field.
indexing: The transform is actively processing data and creating new documents.
started: The transform is running but not actively indexing data.
stopped: The transform is stopped.
stopping: The transform is stopping.
- transform_type (or tt): Indicates the type of transform: batch or continuous.
- trigger_count (or tc): The number of times the transform has been triggered by the scheduler. For example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the frequency property.
- version (or v): The version of Elasticsearch that existed on the node when the transform was created.

One of: CatTransformColumn or CatTransformColumn[]

size number · default: 100

The maximum number of transforms to obtain.

Response

application/json

Response Type: [] TransformsRecord

id string Id: The transform identifier.
state string: The status of the transform. Returned values include: aborting: The transform is aborting. failed: The transform failed. For more information about the failure, check the reasonfield.indexing: The transform is actively processing data and creating new documents. started: The transform is running but not actively indexing data. stopped: The transform is stopped. stopping`: The transform is stopping.
checkpoint string: The sequence number for the checkpoint.
documents_processed string: The number of documents that have been processed from the source index of the transform.
checkpoint_progress union string nullable: The progress of the next checkpoint that is currently in progress.; One of: string
last_search_time union string nullable: The timestamp of the last search in the source indices. This field is shown only if the transform is running.; One of: string
changes_last_detection_time union string nullable: The timestamp when changes were last detected in the source indices.; One of: string
create_time string: The time the transform was created.
version string: The version of Elasticsearch that existed on the node when the transform was created.
source_index string: The source indices for the transform.
dest_index string: The destination index for the transform.
pipeline string: The unique identifier for the ingest pipeline.
description string: The description of the transform.
transform_type string: The type of transform: batch or continuous.
frequency string: The interval between checks for changes in the source indices when the transform is running continuously.
max_page_search_size string: The initial page size that is used for the composite aggregation for each checkpoint.
docs_per_second string: The number of input documents per second.
reason string: If a transform has a failed state, these details describe the reason for failure.
search_total string: The total number of search operations on the source index for the transform.
search_failure string: The total number of search failures.
search_time string: The total amount of search time, in milliseconds.
index_total string: The total number of index operations done by the transform.
index_failure string: The total number of indexing failures.
index_time string: The total time spent indexing documents, in milliseconds.
documents_indexed string: The number of documents that have been indexed into the destination index for the transform.
delete_time string: The total time spent deleting documents, in milliseconds.
documents_deleted string: The number of documents deleted from the destination index due to the retention policy for the transform.
trigger_count string: The number of times the transform has been triggered by the scheduler. For example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the frequency property.
pages_processed string: The number of search or bulk index operations processed. Documents are processed in batches instead of individually.
processing_time string: The total time spent processing results, in milliseconds.
checkpoint_duration_time_exp_avg string: The exponential moving average of the duration of the checkpoint, in milliseconds.
indexed_documents_exp_avg string: The exponential moving average of the number of new documents that have been indexed.
processed_documents_exp_avg string: The exponential moving average of the number of documents that have been processed.

Examples

A successful response from GET /_cat/transforms?v=true&format=json.

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET /_cat/transforms?v=true&format=json

JavaScript Elasticsearch JavaScript Client

const response = await client.cat.transforms({
  v: "true",
  format: "json",
});

Python Elasticsearch Python Client

resp = client.cat.transforms(
    v=True,
    format="json",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_cat/transforms?v=true&format=json" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.cat().transforms();

PHP Elasticsearch PHP Client

$resp = $client->cat()->transforms([
    "v" => "true",
    "format" => "json",
]);

Ruby Elasticsearch Ruby Client

response = client.cat.transforms(
  v: "true",
  format: "json"
)

Response

[
  {
    "id" : "ecommerce_transform",
    "state" : "started",
    "checkpoint" : "1",
    "documents_processed" : "705",
    "checkpoint_progress" : "100.00",
    "changes_last_detection_time" : null
  }
]

Required authorization

Path Parameters

Query Parameters { allow_no_match , from , h , s , size , }

Response

Query Parameters