Path parameters

• transform_id string | array[string] Required

  Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using _all, by specifying * as the <transform_id>, or by omitting the <transform_id>.

Query parameters

• allow_no_match boolean

  Specifies what to do when the request:

  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

  Skips the specified number of transforms.

• size number

  Specifies the maximum number of transforms to obtain.

• exclude_generated boolean

  Excludes fields that were automatically added when creating the transform. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • count number Required
  • transforms array[object] Required
    Hide transforms attributes Show transforms attributes object

    • authorization object

      Additional properties are allowed.

      Hide authorization attributes Show authorization attributes object

      • api_key object

        Additional properties are allowed.

        Hide api_key attributes Show api_key attributes object

        • id string Required

          The identifier for the API key.

        • name string Required

          The name of the API key.

      • roles array[string]

        If a user ID was used for the most recent update to the transform, its roles at the time of the update are listed in the response.

      • service_account string

        If a service account was used for the most recent update to the transform, the account name is listed in the response.

    • create_time number

      Time unit for milliseconds

    • description string

      Free text description of the transform.

    • dest object Required

      Additional properties are allowed.

      Hide dest attributes Show dest attributes object

      • index string Required
      • op_type string

        Values are index or create.

      • pipeline string

        The name of the pipeline to use.

      • routing string
      • version_type string

        Values are internal, external, external_gte, or force.

    • frequency string

      A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

    • id string Required
    • latest object

      Additional properties are allowed.

      Hide latest attributes Show latest attributes object

      • sort string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • unique_key array[string] Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • pivot object

      Additional properties are allowed.

      Hide pivot attributes Show pivot attributes object

      • aggregations object

        Defines how to aggregate the grouped data. The following aggregations are currently supported: average, bucket script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo line, max, median absolute deviation, min, missing, percentiles, rare terms, scripted metric, stats, sum, terms, top metrics, value count, weighted average.

      • group_by object

        Defines how to group the data. More than one grouping can be defined per pivot. The following groupings are currently supported: date histogram, geotile grid, histogram, terms.

        Hide group_by attribute Show group_by attribute object

        • * object Additional properties

          Additional properties are allowed.

          Hide * attributes Show * attributes object

          • date_histogram
          • geotile_grid
          • histogram
          • terms
    • retention_policy object

      Additional properties are allowed.

      Hide retention_policy attribute Show retention_policy attribute object

      • time object

        Additional properties are allowed.

        Hide time attributes Show time attributes object

        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • max_age string Required

          A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

    • settings object

      Additional properties are allowed.

      Hide settings attributes Show settings attributes object

      • align_checkpoints boolean

        Specifies whether the transform checkpoint ranges should be optimized for performance. Such optimization can align checkpoint ranges with the date histogram interval when date histogram is specified as a group source in the transform config. As a result, less document updates in the destination index will be performed thus improving overall performance.

      • dates_as_epoch_millis boolean

        Defines if dates in the ouput should be written as ISO formatted string or as millis since epoch. epoch_millis was the default for transforms created before version 7.11. For compatible output set this value to true.

      • deduce_mappings boolean

        Specifies whether the transform should deduce the destination index mappings from the transform configuration.

      • docs_per_second number

        Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a wait time between search requests. The default value is null, which disables throttling.

      • max_page_search_size number

        Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is 10 and the maximum is 65,536.

      • unattended boolean

        If true, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails. Setting the number of retries other than infinite fails in validation.

    • source object Required

      Additional properties are allowed.

      Hide source attributes Show source attributes object

      • index string | array[string] Required
      • runtime_mappings object
        Hide runtime_mappings attribute Show runtime_mappings attribute object

        • * object Additional properties

          Additional properties are allowed.

          Hide * attributes Show * attributes object

          • fields object

            For type composite

          • fetch_fields array[object]

            For type lookup

          • format string

            A custom format for date type runtime fields.

          • input_field string

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • target_field string

            Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

          • target_index string
          • script object

            Additional properties are allowed.

          • type string Required

            Values are boolean, composite, date, double, geo_point, ip, keyword, long, or lookup.

      • query object

        A query clause that retrieves a subset of data from the source index.

        Additional properties are allowed.

        Query DSL
    • sync object

      Additional properties are allowed.

      Hide sync attribute Show sync attribute object

      • time object

        Additional properties are allowed.

        Hide time attributes Show time attributes object

        • delay string

          A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • field string Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • version string
    • _meta object
      Hide _meta attribute Show _meta attribute object

      • * object Additional properties

        Additional properties are allowed.