> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# elasticsearch-ingest
> Elasticsearch Ingest
**Server path:** `/elasticsearch-ingest` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| [`elasticsearch_ingest_delete_geoip_database`](#elasticsearch_ingest_delete_geoip_database) | Delete GeoIP database configurations |
| [`elasticsearch_ingest_delete_ip_location_database`](#elasticsearch_ingest_delete_ip_location_database) | Delete IP geolocation database configurations |
| [`elasticsearch_ingest_delete_pipeline`](#elasticsearch_ingest_delete_pipeline) | Delete pipelines |
| [`elasticsearch_ingest_geo_ip_stats`](#elasticsearch_ingest_geo_ip_stats) | Get GeoIP statistics |
| [`elasticsearch_ingest_get_geoip_database`](#elasticsearch_ingest_get_geoip_database) | Get GeoIP database configurations |
| [`elasticsearch_ingest_get_ip_location_database`](#elasticsearch_ingest_get_ip_location_database) | Get IP geolocation database configurations |
| [`elasticsearch_ingest_get_pipeline`](#elasticsearch_ingest_get_pipeline) | Get pipelines |
| [`elasticsearch_ingest_indices_create_data_stream`](#elasticsearch_ingest_indices_create_data_stream) | Create a data stream |
| [`elasticsearch_ingest_indices_data_streams_stats`](#elasticsearch_ingest_indices_data_streams_stats) | Get data stream stats |
| [`elasticsearch_ingest_indices_delete_data_stream`](#elasticsearch_ingest_indices_delete_data_stream) | Delete data streams |
| [`elasticsearch_ingest_indices_delete_data_stream_options`](#elasticsearch_ingest_indices_delete_data_stream_options) | Delete data stream options |
| [`elasticsearch_ingest_indices_downsample`](#elasticsearch_ingest_indices_downsample) | Downsample an index |
| [`elasticsearch_ingest_indices_explain_data_lifecycle`](#elasticsearch_ingest_indices_explain_data_lifecycle) | Get the status for a data stream lifecycle |
| [`elasticsearch_ingest_indices_get_data_lifecycle`](#elasticsearch_ingest_indices_get_data_lifecycle) | Get data stream lifecycles |
| [`elasticsearch_ingest_indices_get_data_lifecycle_stats`](#elasticsearch_ingest_indices_get_data_lifecycle_stats) | Get data stream lifecycle stats |
| [`elasticsearch_ingest_indices_get_data_stream`](#elasticsearch_ingest_indices_get_data_stream) | Get data streams |
| [`elasticsearch_ingest_indices_get_data_stream_mappings`](#elasticsearch_ingest_indices_get_data_stream_mappings) | Get data stream mappings |
| [`elasticsearch_ingest_indices_get_data_stream_options`](#elasticsearch_ingest_indices_get_data_stream_options) | Get data stream options |
| [`elasticsearch_ingest_indices_get_data_stream_settings`](#elasticsearch_ingest_indices_get_data_stream_settings) | Get data stream settings |
| [`elasticsearch_ingest_indices_migrate_to_data_stream`](#elasticsearch_ingest_indices_migrate_to_data_stream) | Convert an index alias to a data stream |
| [`elasticsearch_ingest_indices_modify_data_stream`](#elasticsearch_ingest_indices_modify_data_stream) | Update data streams |
| [`elasticsearch_ingest_indices_promote_data_stream`](#elasticsearch_ingest_indices_promote_data_stream) | Promote a data stream |
| [`elasticsearch_ingest_indices_put_data_lifecycle`](#elasticsearch_ingest_indices_put_data_lifecycle) | Update data stream lifecycles |
| [`elasticsearch_ingest_indices_put_data_stream_mappings`](#elasticsearch_ingest_indices_put_data_stream_mappings) | Update data stream mappings |
| [`elasticsearch_ingest_indices_put_data_stream_options`](#elasticsearch_ingest_indices_put_data_stream_options) | Update data stream options |
| [`elasticsearch_ingest_indices_put_data_stream_settings`](#elasticsearch_ingest_indices_put_data_stream_settings) | Update data stream settings |
| [`elasticsearch_ingest_processor_grok`](#elasticsearch_ingest_processor_grok) | Run a grok processor |
| [`elasticsearch_ingest_put_geoip_database`](#elasticsearch_ingest_put_geoip_database) | Create or update a GeoIP database configuration |
| [`elasticsearch_ingest_put_ip_location_database`](#elasticsearch_ingest_put_ip_location_database) | Create or update an IP geolocation database configuration |
| [`elasticsearch_ingest_put_pipeline`](#elasticsearch_ingest_put_pipeline) | Create or update a pipeline |
| [`elasticsearch_ingest_simulate`](#elasticsearch_ingest_simulate) | Simulate a pipeline |
| [`elasticsearch_ingest_simulate_ingest`](#elasticsearch_ingest_simulate_ingest) | Simulate data ingestion |
| [`elasticsearch_ingest_transform_delete_transform`](#elasticsearch_ingest_transform_delete_transform) | Delete a transform |
| [`elasticsearch_ingest_transform_get_node_stats`](#elasticsearch_ingest_transform_get_node_stats) | Get node stats |
| [`elasticsearch_ingest_transform_get_transform`](#elasticsearch_ingest_transform_get_transform) | Get transforms |
| [`elasticsearch_ingest_transform_get_transform_stats`](#elasticsearch_ingest_transform_get_transform_stats) | Get transform stats |
| [`elasticsearch_ingest_transform_preview_transform`](#elasticsearch_ingest_transform_preview_transform) | Preview a transform |
| [`elasticsearch_ingest_transform_put_transform`](#elasticsearch_ingest_transform_put_transform) | Create a transform |
| [`elasticsearch_ingest_transform_reset_transform`](#elasticsearch_ingest_transform_reset_transform) | Reset a transform |
| [`elasticsearch_ingest_transform_schedule_now_transform`](#elasticsearch_ingest_transform_schedule_now_transform) | Schedule a transform to start now |
| [`elasticsearch_ingest_transform_set_upgrade_mode`](#elasticsearch_ingest_transform_set_upgrade_mode) | Set upgrade\_mode for transform indices |
| [`elasticsearch_ingest_transform_start_transform`](#elasticsearch_ingest_transform_start_transform) | Start a transform |
| [`elasticsearch_ingest_transform_stop_transform`](#elasticsearch_ingest_transform_stop_transform) | Stop transforms |
| [`elasticsearch_ingest_transform_update_transform`](#elasticsearch_ingest_transform_update_transform) | Update a transform |
| [`elasticsearch_ingest_transform_upgrade_transforms`](#elasticsearch_ingest_transform_upgrade_transforms) | Upgrade all transforms |
***
## elasticsearch\_ingest\_delete\_geoip\_database
Delete GeoIP database configurations
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | string\[] | Yes | — | A comma-separated list of geoip database configurations to delete |
| `master_timeout` | string | No | — | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
| `timeout` | string | No | — | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of geoip database configurations to delete"
},
"master_timeout": {
"type": "string",
"description": "The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
},
"timeout": {
"type": "string",
"description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## elasticsearch\_ingest\_delete\_ip\_location\_database
Delete IP geolocation database configurations
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | string\[] | Yes | — | A comma-separated list of IP location database configurations. |
| `master_timeout` | string | No | — | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. A value of `-1` indicates that the request should never time out. |
| `timeout` | string | No | — | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. A value of `-1` indicates that the request should never time out. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of IP location database configurations."
},
"master_timeout": {
"type": "string",
"description": "The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. A value of `-1` indicates that the request should never time out."
},
"timeout": {
"type": "string",
"description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. A value of `-1` indicates that the request should never time out."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## elasticsearch\_ingest\_delete\_pipeline
Delete pipelines
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`. |
| `master_timeout` | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
| `timeout` | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`."
},
"master_timeout": {
"type": "string",
"description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
},
"timeout": {
"type": "string",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## elasticsearch\_ingest\_geo\_ip\_stats
Get GeoIP statistics
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## elasticsearch\_ingest\_get\_geoip\_database
Get GeoIP database configurations
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string\[] | Yes | — | A comma-separated list of database configuration IDs to retrieve. Wildcard (`*`) expressions are supported. To get all database configurations, omit this parameter or use `*`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of database configuration IDs to retrieve. Wildcard (`*`) expressions are supported. To get all database configurations, omit this parameter or use `*`."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## elasticsearch\_ingest\_get\_ip\_location\_database
Get IP geolocation database configurations
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string\[] | Yes | — | Comma-separated list of database configuration IDs to retrieve. Wildcard (`*`) expressions are supported. To get all database configurations, omit this parameter or use `*`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma-separated list of database configuration IDs to retrieve. Wildcard (`*`) expressions are supported. To get all database configurations, omit this parameter or use `*`."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## elasticsearch\_ingest\_get\_pipeline
Get pipelines
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`. |
| `master_timeout` | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
| `summary` | boolean | No | — | Return pipelines without their definitions |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`."
},
"master_timeout": {
"type": "string",
"description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
},
"summary": {
"type": "boolean",
"description": "Return pipelines without their definitions"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## elasticsearch\_ingest\_indices\_create\_data\_stream
Create a data stream
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string | Yes | — | Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `\|`, `,`, `#`, `:`, or a space character; Cannot start with `-`, `_`, `+`, or `.ds-`; Cannot be `.` or `..`; Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster. |
| `master_timeout` | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
| `timeout` | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include `\\`, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character; Cannot start with `-`, `_`, `+`, or `.ds-`; Cannot be `.` or `..`; Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster."
},
"master_timeout": {
"type": "string",
"description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
},
"timeout": {
"type": "string",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## elasticsearch\_ingest\_indices\_data\_streams\_stats
Get data stream stats
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string\[] | Yes | — | Comma-separated list of data streams used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams in a cluster, omit this parameter or use `*`. |
| `expand_wildcards` | string\[] | No | — | Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma-separated list of data streams used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams in a cluster, omit this parameter or use `*`."
},
"expand_wildcards": {
"type": "array",
"items": {
"type": "string",
"enum": [
"all",
"open",
"closed",
"hidden",
"none"
]
},
"description": "Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## elasticsearch\_ingest\_indices\_delete\_data\_stream
Delete data streams
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string\[] | Yes | — | Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported. |
| `master_timeout` | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
| `expand_wildcards` | string\[] | No | — | Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`. Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported."
},
"master_timeout": {
"type": "string",
"description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
},
"expand_wildcards": {
"type": "array",
"items": {
"type": "string",
"enum": [
"all",
"open",
"closed",
"hidden",
"none"
]
},
"description": "Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`. Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## elasticsearch\_ingest\_indices\_delete\_data\_stream\_options
Delete data stream options
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `name` | string\[] | Yes | — | A comma-separated list of data streams of which the data stream options will be deleted. Use `*` to get all data streams |
| `expand_wildcards` | string\[] | No | — | Whether wildcard expressions should get expanded to open or closed indices Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted. |
| `master_timeout` | string | No | — | The period to wait for a connection to the master node. |
| `timeout` | string | No | — | The period to wait for a response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of data streams of which the data stream options will be deleted. Use `*` to get all data streams"
},
"expand_wildcards": {
"type": "array",
"items": {
"type": "string",
"enum": [
"all",
"open",
"closed",
"hidden",
"none"
]
},
"description": "Whether wildcard expressions should get expanded to open or closed indices Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted."
},
"master_timeout": {
"type": "string",
"description": "The period to wait for a connection to the master node."
},
"timeout": {
"type": "string",
"description": "The period to wait for a response."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## elasticsearch\_ingest\_indices\_downsample
Downsample an index
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------ |
| `index` | string | Yes | — | Name of the time series index to downsample. |
| `target_index` | string | Yes | — | Name of the index to create. |
| `fixed_interval` | object | Yes | — | The interval at which to aggregate the original time series index. |
| `sampling_method` | object | No | — | The sampling method used to reduce the documents; it can be either `aggregate` or `last_value`. Defaults to `aggregate`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"index": {
"type": "string",
"description": "Name of the time series index to downsample."
},
"target_index": {
"type": "string",
"description": "Name of the index to create."
},
"fixed_interval": {
"description": "The interval at which to aggregate the original time series index."
},
"sampling_method": {
"description": "The sampling method used to reduce the documents; it can be either `aggregate` or `last_value`. Defaults to `aggregate`."
}
},
"required": [
"PCID",
"index",
"target_index",
"fixed_interval"
]
}
```
***
## elasticsearch\_ingest\_indices\_explain\_data\_lifecycle
Get the status for a data stream lifecycle
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------- |
| `index` | string\[] | Yes | — | Comma-separated list of index names to explain |
| `include_defaults` | boolean | No | — | Indicates if the API should return the default values the system uses for the index's lifecycle |
| `master_timeout` | string | No | — | The period to wait for a connection to the master node. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"index": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma-separated list of index names to explain"
},
"include_defaults": {
"type": "boolean",
"description": "Indicates if the API should return the default values the system uses for the index's lifecycle"
},
"master_timeout": {
"type": "string",
"description": "The period to wait for a connection to the master node."
}
},
"required": [
"PCID",
"index"
]
}
```
***
## elasticsearch\_ingest\_indices\_get\_data\_lifecycle
Get data stream lifecycles
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string\[] | Yes | — | Comma-separated list of data streams to limit the request. Supports wildcards (`*`). To target all data streams, omit this parameter or use `*` or `_all`. |
| `expand_wildcards` | string\[] | No | — | Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted. |
| `include_defaults` | boolean | No | — | If `true`, return all default settings in the response. |
| `master_timeout` | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma-separated list of data streams to limit the request. Supports wildcards (`*`). To target all data streams, omit this parameter or use `*` or `_all`."
},
"expand_wildcards": {
"type": "array",
"items": {
"type": "string",
"enum": [
"all",
"open",
"closed",
"hidden",
"none"
]
},
"description": "Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted."
},
"include_defaults": {
"type": "boolean",
"description": "If `true`, return all default settings in the response."
},
"master_timeout": {
"type": "string",
"description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## elasticsearch\_ingest\_indices\_get\_data\_lifecycle\_stats
Get data stream lifecycle stats
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## elasticsearch\_ingest\_indices\_get\_data\_stream
Get data streams
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string\[] | Yes | — | Comma-separated list of data stream names used to limit the request. Wildcard (`*`) expressions are supported. If omitted, all data streams are returned. |
| `expand_wildcards` | string\[] | No | — | Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted. |
| `include_defaults` | boolean | No | — | If true, returns all relevant default configurations for the index template. |
| `master_timeout` | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
| `verbose` | boolean | No | — | Whether the maximum timestamp for each data stream should be calculated and returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma-separated list of data stream names used to limit the request. Wildcard (`*`) expressions are supported. If omitted, all data streams are returned."
},
"expand_wildcards": {
"type": "array",
"items": {
"type": "string",
"enum": [
"all",
"open",
"closed",
"hidden",
"none"
]
},
"description": "Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted."
},
"include_defaults": {
"type": "boolean",
"description": "If true, returns all relevant default configurations for the index template."
},
"master_timeout": {
"type": "string",
"description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
},
"verbose": {
"type": "boolean",
"description": "Whether the maximum timestamp for each data stream should be calculated and returned."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## elasticsearch\_ingest\_indices\_get\_data\_stream\_mappings
Get data stream mappings
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `name` | string\[] | Yes | — | A comma-separated list of data streams or data stream patterns. Supports wildcards (`*`). |
| `master_timeout` | string | No | — | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of data streams or data stream patterns. Supports wildcards (`*`)."
},
"master_timeout": {
"type": "string",
"description": "The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## elasticsearch\_ingest\_indices\_get\_data\_stream\_options
Get data stream options
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string\[] | Yes | — | Comma-separated list of data streams to limit the request. Supports wildcards (`*`). To target all data streams, omit this parameter or use `*` or `_all`. |
| `expand_wildcards` | string\[] | No | — | Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted. |
| `master_timeout` | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma-separated list of data streams to limit the request. Supports wildcards (`*`). To target all data streams, omit this parameter or use `*` or `_all`."
},
"expand_wildcards": {
"type": "array",
"items": {
"type": "string",
"enum": [
"all",
"open",
"closed",
"hidden",
"none"
]
},
"description": "Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted."
},
"master_timeout": {
"type": "string",
"description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## elasticsearch\_ingest\_indices\_get\_data\_stream\_settings
Get data stream settings
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `name` | string\[] | Yes | — | A comma-separated list of data streams or data stream patterns. Supports wildcards (`*`). |
| `master_timeout` | string | No | — | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of data streams or data stream patterns. Supports wildcards (`*`)."
},
"master_timeout": {
"type": "string",
"description": "The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## elasticsearch\_ingest\_indices\_migrate\_to\_data\_stream
Convert an index alias to a data stream
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string | Yes | — | Name of the index alias to convert to a data stream. |
| `master_timeout` | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
| `timeout` | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Name of the index alias to convert to a data stream."
},
"master_timeout": {
"type": "string",
"description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
},
"timeout": {
"type": "string",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## elasticsearch\_ingest\_indices\_modify\_data\_stream
Update data streams
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ------------------- |
| `actions` | object\[] | Yes | — | Actions to perform. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"add_backing_index": {
"description": "Adds an existing index as a backing index for a data stream. The index is hidden as part of this operation. WARNING: Adding indices with the `add_backing_index` action can potentially result in improper data stream behavior. This should be considered an expert level API."
},
"remove_backing_index": {
"description": "Removes a backing index from a data stream. The index is unhidden as part of this operation. A data stream’s write index cannot be removed."
}
}
},
"description": "Actions to perform."
}
},
"required": [
"PCID",
"actions"
]
}
```
***
## elasticsearch\_ingest\_indices\_promote\_data\_stream
Promote a data stream
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string | Yes | — | The name of the data stream to promote |
| `master_timeout` | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "The name of the data stream to promote"
},
"master_timeout": {
"type": "string",
"description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## elasticsearch\_ingest\_indices\_put\_data\_lifecycle
Update data stream lifecycles
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string\[] | Yes | — | Comma-separated list of data streams used to limit the request. Supports wildcards (`*`). To target all data streams use `*` or `_all`. |
| `expand_wildcards` | string\[] | No | — | Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted. |
| `master_timeout` | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
| `timeout` | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
| `data_retention` | object | No | — | If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely. |
| `downsampling` | object\[] | No | — | The downsampling configuration to execute for the managed backing index after rollover. |
| `downsampling_method` | object | No | — | The method used to downsample the data. There are two options `aggregate` and `last_value`. It requires `downsampling` to be defined. Defaults to `aggregate`. |
| `enabled` | boolean | No | — | If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle that's disabled (enabled: `false`) will have no effect on the data stream. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma-separated list of data streams used to limit the request. Supports wildcards (`*`). To target all data streams use `*` or `_all`."
},
"expand_wildcards": {
"type": "array",
"items": {
"type": "string",
"enum": [
"all",
"open",
"closed",
"hidden",
"none"
]
},
"description": "Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted."
},
"master_timeout": {
"type": "string",
"description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
},
"timeout": {
"type": "string",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
},
"data_retention": {
"description": "If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely."
},
"downsampling": {
"type": "array",
"items": {
"type": "object",
"properties": {
"after": {
"description": "The duration since rollover when this downsampling round should execute"
},
"fixed_interval": {
"description": "The downsample interval."
}
},
"required": [
"after",
"fixed_interval"
]
},
"description": "The downsampling configuration to execute for the managed backing index after rollover."
},
"downsampling_method": {
"description": "The method used to downsample the data. There are two options `aggregate` and `last_value`. It requires `downsampling` to be defined. Defaults to `aggregate`."
},
"enabled": {
"type": "boolean",
"description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle that's disabled (enabled: `false`) will have no effect on the data stream."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## elasticsearch\_ingest\_indices\_put\_data\_stream\_mappings
Update data stream mappings
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string\[] | Yes | — | A comma-separated list of data streams or data stream patterns. |
| `dry_run` | boolean | No | — | If `true`, the request does not actually change the mappings on any data streams. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied. |
| `master_timeout` | string | No | — | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
| `timeout` | string | No | — | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
| `_data_stream_timestamp` | object | No | — | Data Stream Timestamp |
| `_field_names` | object | No | — | Field Names |
| `_meta` | object | No | — | The meta value |
| `_routing` | object | No | — | The routing value |
| `_size` | object | No | — | The size value |
| `_source` | object | No | — | The source value |
| `all_field` | object | No | — | All Field |
| `date_detection` | boolean | No | — | Date Detection |
| `dynamic` | object | No | — | The dynamic value |
| `dynamic_date_formats` | string\[] | No | — | Dynamic Date Formats |
| `dynamic_templates` | object\[] | No | — | Dynamic Templates |
| `enabled` | boolean | No | — | The enabled value |
| `index_field` | object | No | — | Index Field |
| `numeric_detection` | boolean | No | — | Numeric Detection |
| `properties` | object | No | — | The properties value |
| `runtime` | object | No | — | The runtime value |
| `subobjects` | object | No | — | The subobjects value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of data streams or data stream patterns."
},
"dry_run": {
"type": "boolean",
"description": "If `true`, the request does not actually change the mappings on any data streams. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied."
},
"master_timeout": {
"type": "string",
"description": "The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
},
"timeout": {
"type": "string",
"description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
},
"_data_stream_timestamp": {
"description": "Data Stream Timestamp"
},
"_field_names": {
"description": "Field Names"
},
"_meta": {
"description": "The meta value"
},
"_routing": {
"description": "The routing value"
},
"_size": {
"description": "The size value"
},
"_source": {
"description": "The source value"
},
"all_field": {
"description": "All Field"
},
"date_detection": {
"type": "boolean",
"description": "Date Detection"
},
"dynamic": {
"description": "The dynamic value"
},
"dynamic_date_formats": {
"type": "array",
"items": {
"type": "string"
},
"description": "Dynamic Date Formats"
},
"dynamic_templates": {
"type": "array",
"items": {
"type": "object"
},
"description": "Dynamic Templates"
},
"enabled": {
"type": "boolean",
"description": "The enabled value"
},
"index_field": {
"description": "Index Field"
},
"numeric_detection": {
"type": "boolean",
"description": "Numeric Detection"
},
"properties": {
"type": "object",
"description": "The properties value"
},
"runtime": {
"type": "object",
"description": "The runtime value"
},
"subobjects": {
"description": "The subobjects value"
}
},
"required": [
"PCID",
"name"
]
}
```
***
## elasticsearch\_ingest\_indices\_put\_data\_stream\_options
Update data stream options
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string\[] | Yes | — | Comma-separated list of data streams used to limit the request. Supports wildcards (`*`). To target all data streams use `*` or `_all`. |
| `expand_wildcards` | string\[] | No | — | Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted. |
| `master_timeout` | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
| `timeout` | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
| `failure_store` | object | No | — | If defined, it will update the failure store configuration of every data stream resolved by the name expression. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma-separated list of data streams used to limit the request. Supports wildcards (`*`). To target all data streams use `*` or `_all`."
},
"expand_wildcards": {
"type": "array",
"items": {
"type": "string",
"enum": [
"all",
"open",
"closed",
"hidden",
"none"
]
},
"description": "Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Supported values include: - `all`: Match any data stream or index, including hidden ones. - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed. - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`. - `none`: Wildcard expressions are not accepted."
},
"master_timeout": {
"type": "string",
"description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
},
"timeout": {
"type": "string",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
},
"failure_store": {
"description": "If defined, it will update the failure store configuration of every data stream resolved by the name expression."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## elasticsearch\_ingest\_indices\_put\_data\_stream\_settings
Update data stream settings
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string\[] | Yes | — | A comma-separated list of data streams or data stream patterns. |
| `dry_run` | boolean | No | — | If `true`, the request does not actually change the settings on any data streams or indices. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied. |
| `master_timeout` | string | No | — | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
| `timeout` | string | No | — | The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
| `body` | object | Yes | — | Request body |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of data streams or data stream patterns."
},
"dry_run": {
"type": "boolean",
"description": "If `true`, the request does not actually change the settings on any data streams or indices. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied."
},
"master_timeout": {
"type": "string",
"description": "The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
},
"timeout": {
"type": "string",
"description": "The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
},
"body": {
"type": "object",
"description": "Request body"
}
},
"required": [
"PCID",
"name",
"body"
]
}
```
***
## elasticsearch\_ingest\_processor\_grok
Run a grok processor
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## elasticsearch\_ingest\_put\_geoip\_database
Create or update a GeoIP database configuration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | ID of the database configuration to create or update. |
| `master_timeout` | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
| `timeout` | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
| `maxmind` | object | Yes | — | The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading. At present, the only supported provider is maxmind, and the maxmind provider requires that an account\_id (string) is configured. |
| `name` | object | Yes | — | The provider-assigned name of the IP geolocation database to download. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "ID of the database configuration to create or update."
},
"master_timeout": {
"type": "string",
"description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
},
"timeout": {
"type": "string",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
},
"maxmind": {
"description": "The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading. At present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured."
},
"name": {
"description": "The provider-assigned name of the IP geolocation database to download."
}
},
"required": [
"PCID",
"id",
"maxmind",
"name"
]
}
```
***
## elasticsearch\_ingest\_put\_ip\_location\_database
Create or update an IP geolocation database configuration
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The database configuration identifier. |
| `master_timeout` | string | No | — | The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. A value of `-1` indicates that the request should never time out. |
| `timeout` | string | No | — | The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged. A value of `-1` indicates that the request should never time out. |
| `ipinfo` | object | No | — | The ipinfo value |
| `maxmind` | object | No | — | The maxmind value |
| `name` | object | Yes | — | The provider-assigned name of the IP geolocation database to download. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The database configuration identifier."
},
"master_timeout": {
"type": "string",
"description": "The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. A value of `-1` indicates that the request should never time out."
},
"timeout": {
"type": "string",
"description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged. A value of `-1` indicates that the request should never time out."
},
"ipinfo": {
"description": "The ipinfo value"
},
"maxmind": {
"description": "The maxmind value"
},
"name": {
"description": "The provider-assigned name of the IP geolocation database to download."
}
},
"required": [
"PCID",
"id",
"name"
]
}
```
***
## elasticsearch\_ingest\_put\_pipeline
Create or update a pipeline
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | ID of the ingest pipeline to create or update. |
| `master_timeout` | string | No | — | Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. |
| `timeout` | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
| `if_version` | number | No | — | Required version for optimistic concurrency control for pipeline updates |
| `_meta` | object | No | — | Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. |
| `deprecated` | boolean | No | — | Marks this ingest pipeline as deprecated. When a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning. |
| `description` | string | No | — | Description of the ingest pipeline. |
| `field_access_pattern` | object | No | — | Controls how processors in this pipeline should read and write data on a document's source. |
| `on_failure` | object\[] | No | — | Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. |
| `processors` | object\[] | No | — | Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. |
| `version` | object | No | — | Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "ID of the ingest pipeline to create or update."
},
"master_timeout": {
"type": "string",
"description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error."
},
"timeout": {
"type": "string",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
},
"if_version": {
"type": "number",
"description": "Required version for optimistic concurrency control for pipeline updates"
},
"_meta": {
"description": "Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch."
},
"deprecated": {
"type": "boolean",
"description": "Marks this ingest pipeline as deprecated. When a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning."
},
"description": {
"type": "string",
"description": "Description of the ingest pipeline."
},
"field_access_pattern": {
"description": "Controls how processors in this pipeline should read and write data on a document's source."
},
"on_failure": {
"type": "array",
"items": {
"type": "object",
"properties": {
"append": {
"description": "Appends one or more values to an existing array if the field already exists and it is an array. Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar. Creates an array containing the provided values if the field doesn’t exist. Accepts a single value or an array of values."
},
"attachment": {
"description": "The attachment processor lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika."
},
"bytes": {
"description": "Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `1024`). If the field is an array of strings, all members of the array will be converted. Supported human readable units are \"b\", \"kb\", \"mb\", \"gb\", \"tb\", \"pb\" case insensitive. An error will occur if the field is not a supported format or resultant value exceeds 2^63."
},
"cef": {
"description": "Converts a CEF message into a structured format."
},
"circle": {
"description": "Converts circle definitions of shapes to regular polygons which approximate them."
},
"community_id": {
"description": "Computes the Community ID for network flow data as defined in the Community ID Specification. You can use a community ID to correlate network events related to a single flow."
},
"convert": {
"description": "Converts a field in the currently ingested document to a different type, such as converting a string to an integer. If the field value is an array, all members will be converted."
},
"csv": {
"description": "Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped."
},
"date": {
"description": "Parses dates from fields, and then uses the date or timestamp as the timestamp for the document."
},
"date_index_name": {
"description": "The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support."
},
"dissect": {
"description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern."
},
"dot_expander": {
"description": "Expands a field with dots into an object field. This processor allows fields with dots in the name to be accessible by other processors in the pipeline. Otherwise these fields can’t be accessed by any processor."
},
"drop": {
"description": "Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition."
},
"enrich": {
"description": "The `enrich` processor can enrich documents with data from another index."
},
"fail": {
"description": "Raises an exception. This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester."
},
"fingerprint": {
"description": "Computes a hash of the document’s content. You can use this hash for content fingerprinting."
},
"foreach": {
"description": "Runs an ingest processor on each element of an array or object."
},
"ip_location": {
"description": "Currently an undocumented alias for GeoIP Processor."
},
"geo_grid": {
"description": "Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape. This is useful if there is a need to interact with the tile shapes as spatially indexable fields."
},
"geoip": {
"description": "The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address."
},
"grok": {
"description": "Extracts structured fields out of a single text field within a document. You choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused."
},
"gsub": {
"description": "Converts a string field by applying a regular expression and a replacement. If the field is an array of string, all members of the array will be converted. If any non-string values are encountered, the processor will throw an exception."
},
"html_strip": {
"description": "Removes HTML tags from the field. If the field is an array of strings, HTML tags will be removed from all members of the array."
},
"inference": {
"description": "Uses a pre-trained data frame analytics model or a model deployed for natural language processing tasks to infer against the data that is being ingested in the pipeline."
},
"join": {
"description": "Joins each element of an array into a single string using a separator character between each element. Throws an error when the field is not an array."
},
"json": {
"description": "Parses a string containing JSON data into a structured object, string, or other value."
},
"kv": {
"description": "This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety."
},
"lowercase": {
"description": "Converts a string to its lowercase equivalent. If the field is an array of strings, all members of the array will be converted."
},
"network_direction": {
"description": "Calculates the network direction given a source IP address, destination IP address, and a list of internal networks."
},
"pipeline": {
"description": "Executes another pipeline."
},
"redact": {
"description": "The Redact processor uses the Grok rules engine to obscure text in the input document matching the given Grok patterns. The processor can be used to obscure Personal Identifying Information (PII) by configuring it to detect known patterns such as email or IP addresses. Text that matches a Grok pattern is replaced with a configurable string such as `` where an email address is matched or simply replace all matches with the text `` if preferred."
},
"registered_domain": {
"description": "Extracts the registered domain (also known as the effective top-level domain or eTLD), sub-domain, and top-level domain from a fully qualified domain name (FQDN). Uses the registered domains defined in the Mozilla Public Suffix List."
},
"remove": {
"description": "Removes existing fields. If one field doesn’t exist, an exception will be thrown."
},
"rename": {
"description": "Renames an existing field. If the field doesn’t exist or the new name is already used, an exception will be thrown."
},
"reroute": {
"description": "Routes a document to another target index or data stream. When setting the `destination` option, the target is explicitly specified and the dataset and namespace options can’t be set. When the `destination` option is not set, this processor is in a data stream mode. Note that in this mode, the reroute processor can only be used on data streams that follow the data stream naming scheme."
},
"script": {
"description": "Runs an inline or stored script on incoming documents. The script runs in the `ingest` context."
},
"set": {
"description": "Adds a field with the specified value. If the field already exists, its value will be replaced with the provided one."
},
"set_security_user": {
"description": "Sets user-related details (such as `username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm` and `authentication_type`) from the current authenticated user to the current document by pre-processing the ingest."
},
"sort": {
"description": "Sorts the elements of an array ascending or descending. Homogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically. Throws an error when the field is not an array."
},
"split": {
"description": "Splits a field into an array using a separator character. Only works on string fields."
},
"terminate": {
"description": "Terminates the current ingest pipeline, causing no further processors to be run. This will normally be executed conditionally, using the `if` option."
},
"trim": {
"description": "Trims whitespace from a field. If the field is an array of strings, all members of the array will be trimmed. This only works on leading and trailing whitespace."
},
"uppercase": {
"description": "Converts a string to its uppercase equivalent. If the field is an array of strings, all members of the array will be converted."
},
"urldecode": {
"description": "URL-decodes a string. If the field is an array of strings, all members of the array will be decoded."
},
"uri_parts": {
"description": "Parses a Uniform Resource Identifier (URI) string and extracts its components as an object. This URI object includes properties for the URI’s domain, path, fragment, port, query, scheme, user info, username, and password."
},
"user_agent": {
"description": "The `user_agent` processor extracts details from the user agent string a browser sends with its web requests. This processor adds this information by default under the `user_agent` field."
}
}
},
"description": "Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors."
},
"processors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"append": {
"description": "Appends one or more values to an existing array if the field already exists and it is an array. Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar. Creates an array containing the provided values if the field doesn’t exist. Accepts a single value or an array of values."
},
"attachment": {
"description": "The attachment processor lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika."
},
"bytes": {
"description": "Converts a human readable byte value (for example `1kb`) to its value in bytes (for example `1024`). If the field is an array of strings, all members of the array will be converted. Supported human readable units are \"b\", \"kb\", \"mb\", \"gb\", \"tb\", \"pb\" case insensitive. An error will occur if the field is not a supported format or resultant value exceeds 2^63."
},
"cef": {
"description": "Converts a CEF message into a structured format."
},
"circle": {
"description": "Converts circle definitions of shapes to regular polygons which approximate them."
},
"community_id": {
"description": "Computes the Community ID for network flow data as defined in the Community ID Specification. You can use a community ID to correlate network events related to a single flow."
},
"convert": {
"description": "Converts a field in the currently ingested document to a different type, such as converting a string to an integer. If the field value is an array, all members will be converted."
},
"csv": {
"description": "Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped."
},
"date": {
"description": "Parses dates from fields, and then uses the date or timestamp as the timestamp for the document."
},
"date_index_name": {
"description": "The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support."
},
"dissect": {
"description": "Extracts structured fields out of a single text field by matching the text field against a delimiter-based pattern."
},
"dot_expander": {
"description": "Expands a field with dots into an object field. This processor allows fields with dots in the name to be accessible by other processors in the pipeline. Otherwise these fields can’t be accessed by any processor."
},
"drop": {
"description": "Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition."
},
"enrich": {
"description": "The `enrich` processor can enrich documents with data from another index."
},
"fail": {
"description": "Raises an exception. This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester."
},
"fingerprint": {
"description": "Computes a hash of the document’s content. You can use this hash for content fingerprinting."
},
"foreach": {
"description": "Runs an ingest processor on each element of an array or object."
},
"ip_location": {
"description": "Currently an undocumented alias for GeoIP Processor."
},
"geo_grid": {
"description": "Converts geo-grid definitions of grid tiles or cells to regular bounding boxes or polygons which describe their shape. This is useful if there is a need to interact with the tile shapes as spatially indexable fields."
},
"geoip": {
"description": "The `geoip` processor adds information about the geographical location of an IPv4 or IPv6 address."
},
"grok": {
"description": "Extracts structured fields out of a single text field within a document. You choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused."
},
"gsub": {
"description": "Converts a string field by applying a regular expression and a replacement. If the field is an array of string, all members of the array will be converted. If any non-string values are encountered, the processor will throw an exception."
},
"html_strip": {
"description": "Removes HTML tags from the field. If the field is an array of strings, HTML tags will be removed from all members of the array."
},
"inference": {
"description": "Uses a pre-trained data frame analytics model or a model deployed for natural language processing tasks to infer against the data that is being ingested in the pipeline."
},
"join": {
"description": "Joins each element of an array into a single string using a separator character between each element. Throws an error when the field is not an array."
},
"json": {
"description": "Parses a string containing JSON data into a structured object, string, or other value."
},
"kv": {
"description": "This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety."
},
"lowercase": {
"description": "Converts a string to its lowercase equivalent. If the field is an array of strings, all members of the array will be converted."
},
"network_direction": {
"description": "Calculates the network direction given a source IP address, destination IP address, and a list of internal networks."
},
"pipeline": {
"description": "Executes another pipeline."
},
"redact": {
"description": "The Redact processor uses the Grok rules engine to obscure text in the input document matching the given Grok patterns. The processor can be used to obscure Personal Identifying Information (PII) by configuring it to detect known patterns such as email or IP addresses. Text that matches a Grok pattern is replaced with a configurable string such as `` where an email address is matched or simply replace all matches with the text `` if preferred."
},
"registered_domain": {
"description": "Extracts the registered domain (also known as the effective top-level domain or eTLD), sub-domain, and top-level domain from a fully qualified domain name (FQDN). Uses the registered domains defined in the Mozilla Public Suffix List."
},
"remove": {
"description": "Removes existing fields. If one field doesn’t exist, an exception will be thrown."
},
"rename": {
"description": "Renames an existing field. If the field doesn’t exist or the new name is already used, an exception will be thrown."
},
"reroute": {
"description": "Routes a document to another target index or data stream. When setting the `destination` option, the target is explicitly specified and the dataset and namespace options can’t be set. When the `destination` option is not set, this processor is in a data stream mode. Note that in this mode, the reroute processor can only be used on data streams that follow the data stream naming scheme."
},
"script": {
"description": "Runs an inline or stored script on incoming documents. The script runs in the `ingest` context."
},
"set": {
"description": "Adds a field with the specified value. If the field already exists, its value will be replaced with the provided one."
},
"set_security_user": {
"description": "Sets user-related details (such as `username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm` and `authentication_type`) from the current authenticated user to the current document by pre-processing the ingest."
},
"sort": {
"description": "Sorts the elements of an array ascending or descending. Homogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically. Throws an error when the field is not an array."
},
"split": {
"description": "Splits a field into an array using a separator character. Only works on string fields."
},
"terminate": {
"description": "Terminates the current ingest pipeline, causing no further processors to be run. This will normally be executed conditionally, using the `if` option."
},
"trim": {
"description": "Trims whitespace from a field. If the field is an array of strings, all members of the array will be trimmed. This only works on leading and trailing whitespace."
},
"uppercase": {
"description": "Converts a string to its uppercase equivalent. If the field is an array of strings, all members of the array will be converted."
},
"urldecode": {
"description": "URL-decodes a string. If the field is an array of strings, all members of the array will be decoded."
},
"uri_parts": {
"description": "Parses a Uniform Resource Identifier (URI) string and extracts its components as an object. This URI object includes properties for the URI’s domain, path, fragment, port, query, scheme, user info, username, and password."
},
"user_agent": {
"description": "The `user_agent` processor extracts details from the user agent string a browser sends with its web requests. This processor adds this information by default under the `user_agent` field."
}
}
},
"description": "Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified."
},
"version": {
"description": "Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## elasticsearch\_ingest\_simulate
Simulate a pipeline
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The pipeline to test. If you don't specify a `pipeline` in the request body, this parameter is required. |
| `verbose` | boolean | No | — | If `true`, the response includes output data for each processor in the executed pipeline. |
| `docs` | object\[] | Yes | — | Sample documents to test in the pipeline. |
| `pipeline` | object | No | — | The pipeline to test. If you don't specify the `pipeline` request path parameter, this parameter is required. If you specify both this and the request path parameter, the API only uses the request path parameter. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The pipeline to test. If you don't specify a `pipeline` in the request body, this parameter is required."
},
"verbose": {
"type": "boolean",
"description": "If `true`, the response includes output data for each processor in the executed pipeline."
},
"docs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_id": {
"description": "Unique identifier for the document. This ID must be unique within the `_index`."
},
"_index": {
"description": "Name of the index containing the document."
},
"_source": {
"type": "object",
"description": "JSON body for the document."
}
},
"required": [
"_source"
]
},
"description": "Sample documents to test in the pipeline."
},
"pipeline": {
"description": "The pipeline to test. If you don't specify the `pipeline` request path parameter, this parameter is required. If you specify both this and the request path parameter, the API only uses the request path parameter."
}
},
"required": [
"PCID",
"id",
"docs"
]
}
```
***
## elasticsearch\_ingest\_simulate\_ingest
Simulate data ingestion
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `index` | string | Yes | — | The index to simulate ingesting into. This value can be overridden by specifying an index on each document. If you specify this parameter in the request path, it is used for any documents that do not explicitly specify an index argument. |
| `pipeline` | string | No | — | The pipeline to use as the default pipeline. This value can be used to override the default pipeline of the index. |
| `merge_type` | string | No | — | The mapping merge type if mapping overrides are being provided in mapping\_addition. The allowed values are one of index or template. The index option merges mappings the way they would be merged into an existing index. The template option merges mappings the way they would be merged into a template. |
| `component_template_substitutions` | object | No | — | A map of component template names to substitute component template definition objects. |
| `docs` | object\[] | Yes | — | Sample documents to test in the pipeline. |
| `index_template_substitutions` | object | No | — | A map of index template names to substitute index template definition objects. |
| `mapping_addition` | object | No | — | Mapping Addition |
| `pipeline_substitutions` | object | No | — | Pipelines to test. If you don’t specify the `pipeline` request path parameter, this parameter is required. If you specify both this and the request path parameter, the API only uses the request path parameter. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"index": {
"type": "string",
"description": "The index to simulate ingesting into. This value can be overridden by specifying an index on each document. If you specify this parameter in the request path, it is used for any documents that do not explicitly specify an index argument."
},
"pipeline": {
"type": "string",
"description": "The pipeline to use as the default pipeline. This value can be used to override the default pipeline of the index."
},
"merge_type": {
"type": "string",
"description": "The mapping merge type if mapping overrides are being provided in mapping_addition. The allowed values are one of index or template. The index option merges mappings the way they would be merged into an existing index. The template option merges mappings the way they would be merged into a template.",
"enum": [
"index",
"template"
]
},
"component_template_substitutions": {
"type": "object",
"description": "A map of component template names to substitute component template definition objects."
},
"docs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_id": {
"description": "Unique identifier for the document. This ID must be unique within the `_index`."
},
"_index": {
"description": "Name of the index containing the document."
},
"_source": {
"type": "object",
"description": "JSON body for the document."
}
},
"required": [
"_source"
]
},
"description": "Sample documents to test in the pipeline."
},
"index_template_substitutions": {
"type": "object",
"description": "A map of index template names to substitute index template definition objects."
},
"mapping_addition": {
"description": "Mapping Addition"
},
"pipeline_substitutions": {
"type": "object",
"description": "Pipelines to test. If you don’t specify the `pipeline` request path parameter, this parameter is required. If you specify both this and the request path parameter, the API only uses the request path parameter."
}
},
"required": [
"PCID",
"index",
"docs"
]
}
```
***
## elasticsearch\_ingest\_transform\_delete\_transform
Delete a transform
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `transform_id` | string | Yes | — | Identifier for the transform. |
| `force` | boolean | No | — | If this value is false, the transform must be stopped before it can be deleted. If true, the transform is deleted regardless of its current state. |
| `delete_dest_index` | boolean | No | — | If this value is true, the destination index is deleted together with the transform. If false, the destination index will not be deleted |
| `timeout` | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"transform_id": {
"type": "string",
"description": "Identifier for the transform."
},
"force": {
"type": "boolean",
"description": "If this value is false, the transform must be stopped before it can be deleted. If true, the transform is deleted regardless of its current state."
},
"delete_dest_index": {
"type": "boolean",
"description": "If this value is true, the destination index is deleted together with the transform. If false, the destination index will not be deleted"
},
"timeout": {
"type": "string",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
}
},
"required": [
"PCID",
"transform_id"
]
}
```
***
## elasticsearch\_ingest\_transform\_get\_node\_stats
Get node stats
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## elasticsearch\_ingest\_transform\_get\_transform
Get transforms
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `transform_id` | string\[] | Yes | — | 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>`. |
| `allow_no_match` | boolean | No | — | Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the \_all string or no identifiers and there are no matches. 3. 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 | No | — | Skips the specified number of transforms. |
| `size` | number | No | — | Specifies the maximum number of transforms to obtain. |
| `exclude_generated` | boolean | No | — | 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"transform_id": {
"type": "array",
"items": {
"type": "string"
},
"description": "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 ``, or by omitting the ``."
},
"allow_no_match": {
"type": "boolean",
"description": "Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the _all string or no identifiers and there are no matches. 3. 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": {
"type": "number",
"description": "Skips the specified number of transforms."
},
"size": {
"type": "number",
"description": "Specifies the maximum number of transforms to obtain."
},
"exclude_generated": {
"type": "boolean",
"description": "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."
}
},
"required": [
"PCID",
"transform_id"
]
}
```
***
## elasticsearch\_ingest\_transform\_get\_transform\_stats
Get transform stats
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `transform_id` | string\[] | Yes | — | 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>`. |
| `allow_no_match` | boolean | No | — | Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the \_all string or no identifiers and there are no matches. 3. 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 | No | — | Skips the specified number of transforms. |
| `size` | number | No | — | Specifies the maximum number of transforms to obtain. |
| `timeout` | string | No | — | Controls the time to wait for the stats |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"transform_id": {
"type": "array",
"items": {
"type": "string"
},
"description": "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 ``, or by omitting the ``."
},
"allow_no_match": {
"type": "boolean",
"description": "Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the _all string or no identifiers and there are no matches. 3. 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": {
"type": "number",
"description": "Skips the specified number of transforms."
},
"size": {
"type": "number",
"description": "Specifies the maximum number of transforms to obtain."
},
"timeout": {
"type": "string",
"description": "Controls the time to wait for the stats"
}
},
"required": [
"PCID",
"transform_id"
]
}
```
***
## elasticsearch\_ingest\_transform\_preview\_transform
Preview a transform
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `transform_id` | string | Yes | — | Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform configuration details in the request body. |
| `timeout` | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
| `description` | string | No | — | Free text description of the transform. |
| `dest` | object | No | — | The destination for the transform. |
| `frequency` | object | No | — | 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. |
| `latest` | object | No | — | The latest method transforms the data by finding the latest document for each unique key. |
| `pivot` | object | No | — | The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields and the aggregation to reduce the data. |
| `retention_policy` | object | No | — | Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index. |
| `settings` | object | No | — | Defines optional transform settings. |
| `source` | object | No | — | The source of the data for the transform. |
| `sync` | object | No | — | Defines the properties transforms require to run continuously. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"transform_id": {
"type": "string",
"description": "Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform configuration details in the request body."
},
"timeout": {
"type": "string",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
},
"description": {
"type": "string",
"description": "Free text description of the transform."
},
"dest": {
"description": "The destination for the transform."
},
"frequency": {
"description": "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."
},
"latest": {
"description": "The latest method transforms the data by finding the latest document for each unique key."
},
"pivot": {
"description": "The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields and the aggregation to reduce the data."
},
"retention_policy": {
"description": "Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index."
},
"settings": {
"description": "Defines optional transform settings."
},
"source": {
"description": "The source of the data for the transform."
},
"sync": {
"description": "Defines the properties transforms require to run continuously."
}
},
"required": [
"PCID",
"transform_id"
]
}
```
***
## elasticsearch\_ingest\_transform\_put\_transform
Create a transform
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `transform_id` | string | Yes | — | Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. |
| `defer_validation` | boolean | No | — | When the transform is created, a series of validations occur to ensure its success. For example, there is a check for the existence of the source indices and a check that the destination index is not part of the source index pattern. You can use this parameter to skip the checks, for example when the source index does not exist until after the transform is created. The validations are always run when you start the transform, however, with the exception of privilege checks. |
| `timeout` | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
| `_meta` | object | No | — | Defines optional transform metadata. |
| `description` | string | No | — | Free text description of the transform. |
| `dest` | object | Yes | — | The destination for the transform. |
| `frequency` | object | No | — | 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`. |
| `latest` | object | No | — | The latest method transforms the data by finding the latest document for each unique key. |
| `pivot` | object | No | — | The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields and the aggregation to reduce the data. |
| `retention_policy` | object | No | — | Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index. |
| `settings` | object | No | — | Defines optional transform settings. |
| `source` | object | Yes | — | The source of the data for the transform. |
| `sync` | object | No | — | Defines the properties transforms require to run continuously. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"transform_id": {
"type": "string",
"description": "Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters."
},
"defer_validation": {
"type": "boolean",
"description": "When the transform is created, a series of validations occur to ensure its success. For example, there is a check for the existence of the source indices and a check that the destination index is not part of the source index pattern. You can use this parameter to skip the checks, for example when the source index does not exist until after the transform is created. The validations are always run when you start the transform, however, with the exception of privilege checks."
},
"timeout": {
"type": "string",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
},
"_meta": {
"description": "Defines optional transform metadata."
},
"description": {
"type": "string",
"description": "Free text description of the transform."
},
"dest": {
"description": "The destination for the transform."
},
"frequency": {
"description": "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`."
},
"latest": {
"description": "The latest method transforms the data by finding the latest document for each unique key."
},
"pivot": {
"description": "The pivot method transforms the data by aggregating and grouping it. These objects define the group by fields and the aggregation to reduce the data."
},
"retention_policy": {
"description": "Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index."
},
"settings": {
"description": "Defines optional transform settings."
},
"source": {
"description": "The source of the data for the transform."
},
"sync": {
"description": "Defines the properties transforms require to run continuously."
}
},
"required": [
"PCID",
"transform_id",
"dest",
"source"
]
}
```
***
## elasticsearch\_ingest\_transform\_reset\_transform
Reset a transform
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `transform_id` | string | Yes | — | Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. |
| `force` | boolean | No | — | If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform must be stopped before it can be reset. |
| `timeout` | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"transform_id": {
"type": "string",
"description": "Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters."
},
"force": {
"type": "boolean",
"description": "If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform must be stopped before it can be reset."
},
"timeout": {
"type": "string",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
}
},
"required": [
"PCID",
"transform_id"
]
}
```
***
## elasticsearch\_ingest\_transform\_schedule\_now\_transform
Schedule a transform to start now
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `transform_id` | string | Yes | — | Identifier for the transform. |
| `timeout` | string | No | — | Controls the time to wait for the scheduling to take place |
| `defer` | boolean | No | — | When true, defers the scheduling by the transform's configured sync delay instead of triggering immediately. The transform will process new data after the delay elapses rather than right away. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"transform_id": {
"type": "string",
"description": "Identifier for the transform."
},
"timeout": {
"type": "string",
"description": "Controls the time to wait for the scheduling to take place"
},
"defer": {
"type": "boolean",
"description": "When true, defers the scheduling by the transform's configured sync delay instead of triggering immediately. The transform will process new data after the delay elapses rather than right away."
}
},
"required": [
"PCID",
"transform_id"
]
}
```
***
## elasticsearch\_ingest\_transform\_set\_upgrade\_mode
Set upgrade\_mode for transform indices
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `enabled` | boolean | No | — | When `true`, it enables `upgrade_mode` which temporarily halts all transform tasks and prohibits new transform tasks from starting. |
| `timeout` | string | No | — | The time to wait for the request to be completed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"enabled": {
"type": "boolean",
"description": "When `true`, it enables `upgrade_mode` which temporarily halts all transform tasks and prohibits new transform tasks from starting."
},
"timeout": {
"type": "string",
"description": "The time to wait for the request to be completed."
}
},
"required": [
"PCID"
]
}
```
***
## elasticsearch\_ingest\_transform\_start\_transform
Start a transform
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `transform_id` | string | Yes | — | Identifier for the transform. |
| `timeout` | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
| `from` | string | No | — | Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"transform_id": {
"type": "string",
"description": "Identifier for the transform."
},
"timeout": {
"type": "string",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
},
"from": {
"type": "string",
"description": "Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms."
}
},
"required": [
"PCID",
"transform_id"
]
}
```
***
## elasticsearch\_ingest\_transform\_stop\_transform
Stop transforms
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `transform_id` | string | Yes | — | Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression. To stop all transforms, use `_all` or `*` as the identifier. |
| `allow_no_match` | boolean | No | — | 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 it is true, the API returns a successful acknowledgement message when there are no matches. When there are only partial matches, the API stops the appropriate transforms. If it is false, the request returns a 404 status code when there are no matches or only partial matches. |
| `force` | boolean | No | — | If it is true, the API forcefully stops the transforms. |
| `timeout` | string | No | — | Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the timeout expires, the request returns a timeout exception. However, the request continues processing and eventually moves the transform to a STOPPED state. |
| `wait_for_checkpoint` | boolean | No | — | If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false, the transform stops as soon as possible. |
| `wait_for_completion` | boolean | No | — | If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns immediately and the indexer is stopped asynchronously in the background. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"transform_id": {
"type": "string",
"description": "Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression. To stop all transforms, use `_all` or `*` as the identifier."
},
"allow_no_match": {
"type": "boolean",
"description": "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 it is true, the API returns a successful acknowledgement message when there are no matches. When there are only partial matches, the API stops the appropriate transforms. If it is false, the request returns a 404 status code when there are no matches or only partial matches."
},
"force": {
"type": "boolean",
"description": "If it is true, the API forcefully stops the transforms."
},
"timeout": {
"type": "string",
"description": "Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the timeout expires, the request returns a timeout exception. However, the request continues processing and eventually moves the transform to a STOPPED state."
},
"wait_for_checkpoint": {
"type": "boolean",
"description": "If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false, the transform stops as soon as possible."
},
"wait_for_completion": {
"type": "boolean",
"description": "If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns immediately and the indexer is stopped asynchronously in the background."
}
},
"required": [
"PCID",
"transform_id"
]
}
```
***
## elasticsearch\_ingest\_transform\_update\_transform
Update a transform
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `transform_id` | string | Yes | — | Identifier for the transform. |
| `defer_validation` | boolean | No | — | When true, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the transform is created. |
| `timeout` | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
| `_meta` | object | No | — | Defines optional transform metadata. |
| `description` | string | No | — | Free text description of the transform. |
| `dest` | object | No | — | The destination for the transform. |
| `frequency` | object | No | — | 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. |
| `retention_policy` | object | No | — | Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index. |
| `settings` | object | No | — | Defines optional transform settings. |
| `source` | object | No | — | The source of the data for the transform. |
| `sync` | object | No | — | Defines the properties transforms require to run continuously. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"transform_id": {
"type": "string",
"description": "Identifier for the transform."
},
"defer_validation": {
"type": "boolean",
"description": "When true, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the transform is created."
},
"timeout": {
"type": "string",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
},
"_meta": {
"description": "Defines optional transform metadata."
},
"description": {
"type": "string",
"description": "Free text description of the transform."
},
"dest": {
"description": "The destination for the transform."
},
"frequency": {
"description": "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."
},
"retention_policy": {
"description": "Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index."
},
"settings": {
"description": "Defines optional transform settings."
},
"source": {
"description": "The source of the data for the transform."
},
"sync": {
"description": "Defines the properties transforms require to run continuously."
}
},
"required": [
"PCID",
"transform_id"
]
}
```
***
## elasticsearch\_ingest\_transform\_upgrade\_transforms
Upgrade all transforms
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `dry_run` | boolean | No | — | When true, the request checks for updates but does not run them. |
| `timeout` | string | No | — | Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"dry_run": {
"type": "boolean",
"description": "When true, the request checks for updates but does not run them."
},
"timeout": {
"type": "string",
"description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error."
}
},
"required": [
"PCID"
]
}
```