# Update a transform

**POST /_transform/{transform_id}/_update**

Updates certain properties of a transform.

All updated properties except `description` do not take effect until after the transform starts the next checkpoint,
thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata`
privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When
Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the
time of update and runs with those privileges.

## Required authorization

* Index privileges: `read`,`index`,`view_index_metadata`
* Cluster privileges: `manage_transform`



## Servers
- http://api.example.com: http://api.example.com ()


## Authentication methods
- Api key auth
- Basic auth
- Bearer auth


## Parameters

### Path parameters
- **transform_id** (string)
  Identifier for the transform.

### Query parameters
- **defer_validation** (boolean)
  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)
  Period to wait for a response. If no response is received before the
  timeout expires, the request fails and returns an error.

### Body: application/json (object)

- **dest** (object)
  The destination for the transform.
- **description** (string)
  Free text description of the transform.
- **frequency** (string)
  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.
- **_meta** (object)
  Defines optional transform metadata.
- **source** (object)
  The source of the data for the transform.
- **settings** (object)
  Defines optional transform settings.
- **sync** (object)
  Defines the properties transforms require to run continuously.
- **retention_policy** (object | string | null)
  Defines a retention policy for the transform. Data that meets the defined
  criteria is deleted from the destination index.


## Responses
### 200


#### Body: application/json (object)
- **authorization** (object)

- **create_time** (number)

- **description** (string)

- **dest** (object)

- **frequency** (string)

- **id** (string)

- **latest** (object)

- **pivot** (object)

- **retention_policy** (object)

- **settings** (object)

- **source** (object)

- **sync** (object)

- **version** (string)

- **_meta** (object)



[Powered by Bump.sh](https://bump.sh)