---
title: "Update ingest stream settings"
method: PUT
path: "/api/streams/{name}/_ingest"
tags: ["streams"]
---

# Update ingest stream settings

`PUT /api/streams/{name}/_ingest`

**Spaces method and path for this operation:**

<div><span class="operation-verb put">put</span>&nbsp;<span class="operation-path">/s/{space_id}/api/streams/{name}/_ingest</span></div>

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

Upserts the ingest settings of an ingest stream definition<br/><br/>[Required authorization] Route required privileges: manage_stream.

## Path parameters

- `name` string, required

## Headers

- `kbn-xsrf` string, required

## Request body

- object
  - `ingest` union, required
    - object
      - `failure_store` union, required
        - object
          - `inherit` object, required
        - object
          - `disabled` object, required
        - object
          - `lifecycle` object, required
            - `enabled` object, required
              - …
        - object
          - `lifecycle` object, required
            - `disabled` object, required
      - `lifecycle` union, required
        - object
          - `dsl` object, required
            - `data_retention` string — A non-empty string.
            - `downsample` object[]
              - …
            - `frozen_after` string — A non-empty string.
        - object
          - `ilm` object, required
            - `policy` string, required — A non-empty string.
        - object
          - `inherit` object, required
      - `processing` object, required
        - `steps` KibanaHTTPAPIsStreamlangStep[], required
          - union
            - object — Grok processor - Extract fields from text using grok patterns
              - …
            - object — Dissect processor - Extract fields from text using a lightweight, delimiter-based parser
              - …
            - object — URI parts processor - Parse a URI into components (scheme, domain, port, path, query, fragment, ...)
              - …
            - object — Date processor - Parse dates from strings using one or more expected formats
              - …
            - object
              - …
            - object
              - …
            - object — Rename processor - Change a field name and optionally its location
              - …
            - object — Set processor - Assign a literal or copied value to a field (mutually exclusive inputs)
              - …
            - object — Append processor - Append one or more values to an existing or new array field
              - …
            - object — Remove by prefix processor - Remove a field and all nested fields matching the prefix
              - …
            - object — Remove processor - Delete one or more fields from the document
              - …
            - object
              - …
            - object — Redact processor - Mask sensitive data using Grok patterns
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object — Split processor - Split a field value into an array using a separator
              - …
            - object
              - …
            - object — Convert processor - Change the data type of a field value (integer, long, double, boolean, or string)
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object — JsonExtract processor - Extract values from JSON strings using JSONPath-like selectors
              - …
            - object
              - …
            - object — User agent processor - Extract browser, OS, and device details from a user agent string
              - …
            - object — Registered domain processor - extracts domain, registered_domain, top_level_domain, subdomain from a FQDN
              - …
            - object — Manual ingest pipeline wrapper around native Elasticsearch processors
              - …
            - KibanaHTTPAPIsStreamlangConditionBlock
              - …
        - `updated_at` unknown
      - `settings` object, required
        - `index.number_of_replicas` object
          - `value` number, required
        - `index.number_of_shards` object
          - `value` number, required
        - `index.refresh_interval` object
          - `value` union, required
            - string
            - -1
      - `wired` object, required
        - `draft` boolean
        - `fields` KibanaHTTPAPIsFieldDefinition, required — unresolved $ref
        - `routing` object[], required
          - `destination` string, required — A non-empty string.
          - `draft` boolean
          - `status` 'enabled' | 'disabled'
          - `where` union, required — The root condition object. It can be a simple filter or a combination of other conditions.
            - union — A basic filter condition, either unary or binary.
              - …
            - object — A logical AND that groups multiple conditions.
              - …
            - object — A logical OR that groups multiple conditions.
              - …
            - object — A logical NOT that negates a condition.
              - …
            - object — A condition that always evaluates to false.
              - …
            - object — A condition that always evaluates to true. Useful for catch-all scenarios, but use with caution as partitions are ordered.
              - …
    - object
      - `classic` object, required
        - `field_overrides` KibanaHTTPAPIsClassicFieldDefinition
      - `failure_store` union, required
        - object
          - `inherit` object, required
        - object
          - `disabled` object, required
        - object
          - `lifecycle` object, required
            - `enabled` object, required
              - …
        - object
          - `lifecycle` object, required
            - `disabled` object, required
      - `lifecycle` union, required
        - object
          - `dsl` object, required
            - `data_retention` string — A non-empty string.
            - `downsample` object[]
              - …
            - `frozen_after` string — A non-empty string.
        - object
          - `ilm` object, required
            - `policy` string, required — A non-empty string.
        - object
          - `inherit` object, required
      - `processing` object, required
        - `steps` KibanaHTTPAPIsStreamlangStep[], required
          - union
            - object — Grok processor - Extract fields from text using grok patterns
              - …
            - object — Dissect processor - Extract fields from text using a lightweight, delimiter-based parser
              - …
            - object — URI parts processor - Parse a URI into components (scheme, domain, port, path, query, fragment, ...)
              - …
            - object — Date processor - Parse dates from strings using one or more expected formats
              - …
            - object
              - …
            - object
              - …
            - object — Rename processor - Change a field name and optionally its location
              - …
            - object — Set processor - Assign a literal or copied value to a field (mutually exclusive inputs)
              - …
            - object — Append processor - Append one or more values to an existing or new array field
              - …
            - object — Remove by prefix processor - Remove a field and all nested fields matching the prefix
              - …
            - object — Remove processor - Delete one or more fields from the document
              - …
            - object
              - …
            - object — Redact processor - Mask sensitive data using Grok patterns
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object — Split processor - Split a field value into an array using a separator
              - …
            - object
              - …
            - object — Convert processor - Change the data type of a field value (integer, long, double, boolean, or string)
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object — JsonExtract processor - Extract values from JSON strings using JSONPath-like selectors
              - …
            - object
              - …
            - object — User agent processor - Extract browser, OS, and device details from a user agent string
              - …
            - object — Registered domain processor - extracts domain, registered_domain, top_level_domain, subdomain from a FQDN
              - …
            - object — Manual ingest pipeline wrapper around native Elasticsearch processors
              - …
            - KibanaHTTPAPIsStreamlangConditionBlock
              - …
        - `updated_at` unknown
      - `settings` object, required
        - `index.number_of_replicas` object
          - `value` number, required
        - `index.number_of_shards` object
          - `value` number, required
        - `index.refresh_interval` object
          - `value` union, required
            - string
            - -1

## Response `200`

The ingest settings were updated successfully.

---

[API](https://skmtc.net/elastic/apis/kibana-apis.md) · [All operations](https://skmtc.net/elastic/apis/kibana-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elastic/kibana-apis/revisions/deb2e8b751e7/schema)