Get transforms Added in 7.5.0
Retrieves configuration information for transforms.
Path parameters
-
Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using
_all
, by specifying*
as the<transform_id>
, or by omitting the<transform_id>
.
Query parameters
-
allow_no_match boolean
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 this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.
-
from number
Skips the specified number of transforms.
-
size number
Specifies the maximum number of transforms to obtain.
-
exclude_generated boolean
Excludes fields that were automatically added when creating the transform. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.
GET /_transform/{transform_id}
curl \
-X GET http://api.example.com/_transform/{transform_id}
Response examples (200)
{
"count": 42.0,
"transforms": [
{
"authorization": {
"api_key": {
"id": "string",
"name": "string"
},
"roles": [
"string"
],
"service_account": "string"
},
"": 42.0,
"description": "string",
"dest": {
"index": "string",
"op_type": "index",
"pipeline": "string",
"routing": "string",
"version_type": "internal"
},
"frequency": "string",
"id": "string",
"latest": {
"sort": "string",
"unique_key": [
"string"
]
},
"pivot": {
"aggregations": {},
"group_by": {
"additionalProperty1": {},
"additionalProperty2": {}
}
},
"retention_policy": {
"time": {
"field": "string",
"max_age": "string"
}
},
"settings": {
"align_checkpoints": true,
"dates_as_epoch_millis": true,
"deduce_mappings": true,
"docs_per_second": 42.0,
"max_page_search_size": 42.0,
"unattended": true
},
"source": {
"index": "string",
"runtime_mappings": {
"additionalProperty1": {
"fields": {},
"fetch_fields": [
{}
],
"format": "string",
"input_field": "string",
"target_field": "string",
"target_index": "string",
"script": {},
"type": "boolean"
},
"additionalProperty2": {
"fields": {},
"fetch_fields": [
{}
],
"format": "string",
"input_field": "string",
"target_field": "string",
"target_index": "string",
"script": {},
"type": "boolean"
}
},
"query": {}
},
"sync": {
"time": {
"delay": "string",
"field": "string"
}
},
"version": "string",
"_meta": {
"additionalProperty1": {},
"additionalProperty2": {}
}
}
]
}