Path parameters

• name string Required

  The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned.

Query parameters

• h string | array[string]

  List of columns to appear in the response. Supports simple wildcards.

• s string | array[string]

  List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

• local boolean

  If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

• master_timeout string

  The period to wait for a connection to the master node.

Responses

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

  • name string Required

  • version string | null Required

    One of:

    string-1 string string-2 string | null
  • alias_count string Required
  • mapping_count string Required
  • settings_count string Required
  • metadata_count string Required
  • included_in string Required

Query parameters

• h string | array[string]

  List of columns to appear in the response. Supports simple wildcards.

• s string | array[string]

  List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

Responses

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

  • epoch number | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    _types:UnitSeconds number _spec_utils:StringifiedEpochTimeUnitSeconds string

    Time unit for seconds
  • timestamp string

    Time of day, expressed as HH:MM:SS

  • count string

    the document count

Query parameters

• allow_no_match boolean

  Specifies what to do when the request:

  • Contains wildcard expressions and there are no jobs that match.
  • Contains the _all string or no identifiers and there are no matches.
  • Contains wildcard expressions and there are only partial matches.

  If true, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.

• bytes string

  The unit used to display byte values.

  Values are b, kb, mb, gb, tb, or pb.

• h string | array[string]

  Comma-separated list of column names to display.

• s string | array[string]

  Comma-separated list of column names or column aliases used to sort the response.

• time string

  The unit used to display time values.

  Values are nanos, micros, ms, s, m, h, or d.

Responses

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

  • id string
  • state string

    Values are closing, closed, opened, failed, or opening.

  • opened_time string

    For open jobs only, the amount of time the job has been opened.

  • assignment_explanation string

    For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.

  • data.processed_records string

    The number of input documents that have been processed by the anomaly detection job. This value includes documents with missing fields, since they are nonetheless analyzed. If you use datafeeds and have aggregations in your search query, the processed_record_count is the number of aggregation results processed, not the number of Elasticsearch documents.

  • data.processed_fields string

    The total number of fields in all the documents that have been processed by the anomaly detection job. Only fields that are specified in the detector configuration object contribute to this count. The timestamp is not included in this count.

  • data.input_bytes number | string

    One of:

    _types:ByteSize number _types:ByteSize string
  • data.input_records string

    The number of input documents posted to the anomaly detection job.

  • data.input_fields string

    The total number of fields in input documents posted to the anomaly detection job. This count includes fields that are not used in the analysis. However, be aware that if you are using a datafeed, it extracts only the required fields from the documents it retrieves before posting them to the job.

  • data.invalid_dates string

    The number of input documents with either a missing date field or a date that could not be parsed.

  • data.missing_fields string

    The number of input documents that are missing a field that the anomaly detection job is configured to analyze. Input documents with missing fields are still processed because it is possible that not all fields are missing. If you are using datafeeds or posting data to the job in JSON format, a high missing_field_count is often not an indication of data issues. It is not necessarily a cause for concern.

  • data.out_of_order_timestamps string

    The number of input documents that have a timestamp chronologically preceding the start of the current anomaly detection bucket offset by the latency window. This information is applicable only when you provide data to the anomaly detection job by using the post data API. These out of order documents are discarded, since jobs require time series data to be in ascending chronological order.

  • data.empty_buckets string

    The number of buckets which did not contain any data. If your data contains many empty buckets, consider increasing your bucket_span or using functions that are tolerant to gaps in data such as mean, non_null_sum or non_zero_count.

  • data.sparse_buckets string

    The number of buckets that contained few data points compared to the expected number of data points. If your data contains many sparse buckets, consider using a longer bucket_span.

  • data.buckets string

    The total number of buckets processed.

  • data.earliest_record string

    The timestamp of the earliest chronologically input document.

  • data.latest_record string

    The timestamp of the latest chronologically input document.

  • data.last string

    The timestamp at which data was last analyzed, according to server time.

  • data.last_empty_bucket string

    The timestamp of the last bucket that did not contain any data.

  • data.last_sparse_bucket string

    The timestamp of the last bucket that was considered sparse.

  • model.bytes number | string

    One of:

    _types:ByteSize number _types:ByteSize string
  • model.memory_status string

    Values are ok, soft_limit, or hard_limit.

  • model.bytes_exceeded number | string

    One of:

    _types:ByteSize number _types:ByteSize string
  • model.memory_limit string

    The upper limit for model memory usage, checked on increasing values.

  • model.by_fields string

    The number of by field values that were analyzed by the models. This value is cumulative for all detectors in the job.

  • model.over_fields string

    The number of over field values that were analyzed by the models. This value is cumulative for all detectors in the job.

  • model.partition_fields string

    The number of partition field values that were analyzed by the models. This value is cumulative for all detectors in the job.

  • model.bucket_allocation_failures string

    The number of buckets for which new entities in incoming data were not processed due to insufficient model memory. This situation is also signified by a hard_limit: memory_status property value.

  • model.categorization_status string

    Values are ok or warn.

  • model.categorized_doc_count string

    The number of documents that have had a field categorized.

  • model.total_category_count string

    The number of categories created by categorization.

  • model.frequent_category_count string

    The number of categories that match more than 1% of categorized documents.

  • model.rare_category_count string

    The number of categories that match just one categorized document.

  • model.dead_category_count string

    The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category. Dead categories are a side effect of the way categorization has no prior training.

  • model.failed_category_count string

    The number of times that categorization wanted to create a new category but couldn’t because the job had hit its model_memory_limit. This count does not track which specific categories failed to be created. Therefore you cannot use this value to determine the number of unique categories that were missed.

  • model.log_time string

    The timestamp when the model stats were gathered, according to server time.

  • model.timestamp string

    The timestamp of the last record when the model stats were gathered.

  • forecasts.total string

    The number of individual forecasts currently available for the job. A value of one or more indicates that forecasts exist.

  • forecasts.memory.min string

    The minimum memory usage in bytes for forecasts related to the anomaly detection job.

  • forecasts.memory.max string

    The maximum memory usage in bytes for forecasts related to the anomaly detection job.

  • forecasts.memory.avg string

    The average memory usage in bytes for forecasts related to the anomaly detection job.

  • forecasts.memory.total string

    The total memory usage in bytes for forecasts related to the anomaly detection job.

  • forecasts.records.min string

    The minimum number of model_forecast documents written for forecasts related to the anomaly detection job.

  • forecasts.records.max string

    The maximum number of model_forecast documents written for forecasts related to the anomaly detection job.

  • forecasts.records.avg string

    The average number of model_forecast documents written for forecasts related to the anomaly detection job.

  • forecasts.records.total string

    The total number of model_forecast documents written for forecasts related to the anomaly detection job.

  • forecasts.time.min string

    The minimum runtime in milliseconds for forecasts related to the anomaly detection job.

  • forecasts.time.max string

    The maximum runtime in milliseconds for forecasts related to the anomaly detection job.

  • forecasts.time.avg string

    The average runtime in milliseconds for forecasts related to the anomaly detection job.

  • forecasts.time.total string

    The total runtime in milliseconds for forecasts related to the anomaly detection job.

  • node.id string
  • node.name string

    The name of the assigned node.

  • node.ephemeral_id string
  • node.address string

    The network address of the assigned node.

  • buckets.count string

    The number of bucket results produced by the job.

  • buckets.time.total string

    The sum of all bucket processing times, in milliseconds.

  • buckets.time.min string

    The minimum of all bucket processing times, in milliseconds.

  • buckets.time.max string

    The maximum of all bucket processing times, in milliseconds.

  • buckets.time.exp_avg string

    The exponential moving average of all bucket processing times, in milliseconds.

  • buckets.time.exp_avg_hour string

    The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds.

Query parameters

• allow_no_match boolean

  Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If true, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If 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.

• h string | array[string]

  Comma-separated list of column names to display.

• s string | array[string]

  Comma-separated list of column names or column aliases used to sort the response.

• time string

  The unit used to display time values.

  Values are nanos, micros, ms, s, m, h, or d.

• size number

  The maximum number of transforms to obtain.

Responses

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

  • id string
  • state string

    The status of the transform. Returned values include: aborting: The transform is aborting. failed: The transform failed. For more information about the failure, check thereasonfield. indexing: The transform is actively processing data and creating new documents. started: The transform is running but not actively indexing data. stopped: The transform is stopped. stopping`: The transform is stopping.

  • checkpoint string

    The sequence number for the checkpoint.

  • documents_processed string

    The number of documents that have been processed from the source index of the transform.

  • checkpoint_progress string | null

    The progress of the next checkpoint that is currently in progress.

    One of:

    string-1 string string-2 string | null

  • last_search_time string | null

    The timestamp of the last search in the source indices. This field is shown only if the transform is running.

    One of:

    string-1 string string-2 string | null

  • changes_last_detection_time string | null

    The timestamp when changes were last detected in the source indices.

    One of:

    string-1 string string-2 string | null
  • create_time string

    The time the transform was created.

  • version string
  • source_index string

    The source indices for the transform.

  • dest_index string

    The destination index for the transform.

  • pipeline string

    The unique identifier for the ingest pipeline.

  • description string

    The description of the transform.

  • transform_type string

    The type of transform: batch or continuous.

  • frequency string

    The interval between checks for changes in the source indices when the transform is running continuously.

  • max_page_search_size string

    The initial page size that is used for the composite aggregation for each checkpoint.

  • docs_per_second string

    The number of input documents per second.

  • reason string

    If a transform has a failed state, these details describe the reason for failure.

  • search_total string

    The total number of search operations on the source index for the transform.

  • search_failure string

    The total number of search failures.

  • search_time string

    The total amount of search time, in milliseconds.

  • index_total string

    The total number of index operations done by the transform.

  • index_failure string

    The total number of indexing failures.

  • index_time string

    The total time spent indexing documents, in milliseconds.

  • documents_indexed string

    The number of documents that have been indexed into the destination index for the transform.

  • delete_time string

    The total time spent deleting documents, in milliseconds.

  • documents_deleted string

    The number of documents deleted from the destination index due to the retention policy for the transform.

  • trigger_count string

    The number of times the transform has been triggered by the scheduler. For example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the frequency property.

  • pages_processed string

    The number of search or bulk index operations processed. Documents are processed in batches instead of individually.

  • processing_time string

    The total time spent processing results, in milliseconds.

  • checkpoint_duration_time_exp_avg string

    The exponential moving average of the duration of the checkpoint, in milliseconds.

  • indexed_documents_exp_avg string

    The exponential moving average of the number of new documents that have been indexed.

  • processed_documents_exp_avg string

    The exponential moving average of the number of documents that have been processed.

Query parameters

• from number

  Starting offset (default: 0)

• size number

  Specifies a max number of results to get

• index_name string | array[string]

  A comma-separated list of connector index names to fetch connector documents for

• connector_name string | array[string]

  A comma-separated list of connector names to fetch connector documents for

• service_type string | array[string]

  A comma-separated list of connector service types to fetch connector documents for

• include_deleted boolean

  A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.

• query string

  A wildcard query string that filters connectors with matching name, description or index name

Responses

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

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

    • api_key_id string
    • api_key_secret_id string
    • configuration object Required
      Hide configuration attribute Show configuration attribute object

      • * object Additional properties
        Hide * attributes Show * attributes object

        • category string

        • default_value number | string | boolean | null Required

          A scalar value.

          One of:

          _types:ScalarValue number _types:ScalarValue number _types:ScalarValue string _types:ScalarValue boolean _types:ScalarValue string | null
        • depends_on array[object] Required
        • display string Required

          Values are textbox, textarea, numeric, toggle, or dropdown.

        • label string Required
        • options array[object] Required
        • order number
        • placeholder string
        • required boolean Required
        • sensitive boolean Required

        • tooltip string | null

          One of:

          string-1 string string-2 string | null
        • type string

          Values are str, int, list, or bool.

        • ui_restrictions array[string]
        • validations array[object]
        • value object Required
    • custom_scheduling object Required
      Hide custom_scheduling attribute Show custom_scheduling attribute object

      • * object Additional properties
        Hide * attributes Show * attributes object

        • configuration_overrides object Required
          Hide configuration_overrides attributes Show configuration_overrides attributes object

          • max_crawl_depth number
          • sitemap_discovery_disabled boolean
          • domain_allowlist array[string]
          • sitemap_urls array[string]
          • seed_urls array[string]
        • enabled boolean Required
        • interval string Required
        • last_synced string
        • name string Required
    • deleted boolean Required
    • description string

    • error string | null

      One of:

      string-1 string string-2 string | null
    • features object
      Hide features attributes Show features attributes object

      • document_level_security object
        Hide document_level_security attribute Show document_level_security attribute object

        • enabled boolean Required
      • incremental_sync object
        Hide incremental_sync attribute Show incremental_sync attribute object

        • enabled boolean Required
      • native_connector_api_keys object
        Hide native_connector_api_keys attribute Show native_connector_api_keys attribute object

        • enabled boolean Required
      • sync_rules object
        Hide sync_rules attributes Show sync_rules attributes object

        • advanced object
          Hide advanced attribute Show advanced attribute object

          • enabled boolean Required
        • basic object
          Hide basic attribute Show basic attribute object

          • enabled boolean Required
    • filtering array[object] Required
      Hide filtering attributes Show filtering attributes object

      • active object Required
        Hide active attributes Show active attributes object

        • advanced_snippet object Required
        • rules array[object] Required
        • validation object Required
      • domain string
      • draft object Required
        Hide draft attributes Show draft attributes object

        • advanced_snippet object Required
        • rules array[object] Required
        • validation object Required
    • id string

    • index_name string | null

      One of:

      _types:IndexName string string-2 string | null
    • is_native boolean Required
    • language string
    • last_access_control_sync_error string

    • last_access_control_sync_scheduled_at string | number

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:

      _types:DateTime string _types:UnitMillis number

      Time unit for milliseconds

    • last_access_control_sync_status string

      Values are canceling, canceled, completed, error, in_progress, pending, or suspended.

    • last_deleted_document_count number

    • last_incremental_sync_scheduled_at string | number

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:

      _types:DateTime string _types:UnitMillis number

      Time unit for milliseconds

    • last_indexed_document_count number

    • last_seen string | number

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:

      _types:DateTime string _types:UnitMillis number

      Time unit for milliseconds

    • last_sync_error string

    • last_sync_scheduled_at string | number

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:

      _types:DateTime string _types:UnitMillis number

      Time unit for milliseconds

    • last_sync_status string

      Values are canceling, canceled, completed, error, in_progress, pending, or suspended.

    • last_synced string | number

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:

      _types:DateTime string _types:UnitMillis number

      Time unit for milliseconds

    • name string
    • pipeline object
      Hide pipeline attributes Show pipeline attributes object

      • extract_binary_content boolean Required
      • name string Required
      • reduce_whitespace boolean Required
      • run_ml_inference boolean Required
    • scheduling object Required
      Hide scheduling attributes Show scheduling attributes object

      • access_control object
        Hide access_control attributes Show access_control attributes object

        • enabled boolean Required
        • interval string Required

          The interval is expressed using the crontab syntax

      • full object
        Hide full attributes Show full attributes object

        • enabled boolean Required
        • interval string Required

          The interval is expressed using the crontab syntax

      • incremental object
        Hide incremental attributes Show incremental attributes object

        • enabled boolean Required
        • interval string Required

          The interval is expressed using the crontab syntax

    • service_type string
    • status string Required

      Values are created, needs_configuration, configured, connected, or error.

    • sync_cursor object
    • sync_now boolean Required

Responses

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

  • result string Required

    Values are created, updated, deleted, not_found, or noop.

  • id string Required

Path parameters

• connector_id string Required

  The unique identifier of the connector to be updated

Responses

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

  • result string Required

    Values are created, updated, deleted, not_found, or noop.

Path parameters

• name string | array[string] Required

  Comma-separated list of data stream names used to limit the request. Wildcard (*) expressions are supported. If omitted, all data streams are returned.

Query parameters

• expand_wildcards string | array[string]

  Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

• include_defaults boolean

  If true, returns all relevant default configurations for the index template.

• master_timeout string

  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

  Whether the maximum timestamp for each data stream should be calculated and returned.

Responses

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

  • data_streams array[object] Required
    Hide data_streams attributes Show data_streams attributes object

    • _meta object
      Hide _meta attribute Show _meta attribute object

      • * object Additional properties
    • allow_custom_routing boolean

      If true, the data stream allows custom routing on write request.

    • failure_store object
      Hide failure_store attributes Show failure_store attributes object

      • enabled boolean Required
      • indices array[object] Required
        Hide indices attributes Show indices attributes object

        • index_name string Required
        • index_uuid string Required
        • ilm_policy string
        • managed_by string

          Values are Index Lifecycle Management, Data stream lifecycle, or Unmanaged.

        • prefer_ilm boolean

          Indicates if ILM should take precedence over DSL in case both are configured to manage this index.

        • index_mode string

          Values are standard, time_series, logsdb, or lookup.

      • rollover_on_write boolean Required
    • generation number Required

      Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1.

    • hidden boolean Required

      If true, the data stream is hidden.

    • ilm_policy string
    • next_generation_managed_by string Required

      Values are Index Lifecycle Management, Data stream lifecycle, or Unmanaged.

    • prefer_ilm boolean Required

      Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.

    • indices array[object] Required

      Array of objects containing information about the data stream’s backing indices. The last item in this array contains information about the stream’s current write index.

      Hide indices attributes Show indices attributes object

      • index_name string Required
      • index_uuid string Required
      • ilm_policy string
      • managed_by string

        Values are Index Lifecycle Management, Data stream lifecycle, or Unmanaged.

      • prefer_ilm boolean

        Indicates if ILM should take precedence over DSL in case both are configured to manage this index.

      • index_mode string

        Values are standard, time_series, logsdb, or lookup.

    • lifecycle object
      Hide lifecycle attributes Show lifecycle attributes object

      • data_retention 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.

      • downsampling object
        Hide downsampling attribute Show downsampling attribute object

        • rounds array[object] Required

          The list of downsampling rounds to execute as part of this downsampling configuration

      • enabled boolean

        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.

      • rollover object
        Hide rollover attributes Show rollover attributes object

        • min_age 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.

        • max_age string
        • min_docs number
        • max_docs number
        • min_size
        • max_size
        • min_primary_shard_size
        • max_primary_shard_size
        • min_primary_shard_docs number
        • max_primary_shard_docs number
    • name string Required
    • replicated boolean

      If true, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings.

    • rollover_on_write boolean Required

      If true, the next write to this data stream will trigger a rollover first and the document will be indexed in the new backing index. If the rollover fails the indexing request will fail too.

    • status string Required

      Values are green, GREEN, yellow, YELLOW, red, or RED.

    • system boolean

      If true, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction.

    • template string Required
    • timestamp_field object Required
      Hide timestamp_field attribute Show timestamp_field attribute object

      • name string Required

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

    • index_mode string

      Values are standard, time_series, logsdb, or lookup.

Path parameters

• name string Required

  Name of the index alias to convert to a data stream.

Query parameters

• master_timeout string

  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

  Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Responses

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

  • acknowledged boolean Required

    For a successful response, this value is always true. On failure, an exception is returned instead.

Query parameters

• include_source_on_error boolean

  True or false if to include the document source in the error message in case of parsing errors.

• list_executed_pipelines boolean

  If true, the response will include the ingest pipelines that were run for each index or create.

• pipeline string

  The pipeline identifier to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to _none turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter.

• refresh string

  If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If wait_for, wait for a refresh to make this operation visible to search. If false, do nothing with refreshes. Valid values: true, false, wait_for.

  Values are true, false, or wait_for.

• routing string

  A custom value that is used to route operations to a specific shard.

• _source boolean | string | array[string]

  Indicates whether to return the _source field (true or false) or contains a list of fields to return.

• _source_excludes string | array[string]

  A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. If the _source parameter is false, this parameter is ignored.

• _source_includes string | array[string]

  A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.

• timeout string

  The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards. The default is 1m (one minute), which guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.

• wait_for_active_shards number | string

  The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). The default is 1, which waits for each primary shard to be active.

• require_alias boolean

  If true, the request's actions must target an index alias.

• require_data_stream boolean

  If true, the request's actions must target a data stream (existing or to be created).

Responses

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

  • errors boolean Required

    If true, one or more of the operations in the bulk request did not complete successfully.

  • items array[object] Required

    The result of each operation in the bulk request, in the order they were submitted.

    Hide items attribute Show items attribute object

    • * object Additional properties
      Hide * attributes Show * attributes object

      • _id string | null

        The document ID associated with the operation.

        One of:

        string-1 string string-2 string | null
      • _index string Required

        The name of the index associated with the operation. If the operation targeted a data stream, this is the backing index into which the document was written.

      • status number Required

        The HTTP status code returned for the operation.

      • failure_store string

        Values are not_applicable_or_unknown, used, not_enabled, or failed.

      • error object
        Hide error attributes Show error attributes object

        • type string Required

          The type of error

        • reason string

          A human-readable explanation of the error, in English.

        • stack_trace string

          The server stack trace. Present only if the error_trace=true parameter was sent with the request.

        • caused_by object
        • root_cause array[object]
        • suppressed array[object]
      • _primary_term number

        The primary term assigned to the document for the operation. This property is returned only for successful operations.

      • result string

        The result of the operation. Successful values are created, deleted, and updated.

      • _seq_no number
      • _shards object
        Hide _shards attributes Show _shards attributes object

        • failed number Required
        • successful number Required
        • total number Required
        • failures array[object]
        • skipped number
      • _version number
      • forced_refresh boolean
      • get object
        Hide get attributes Show get attributes object

        • fields object
          Hide fields attribute Show fields attribute object

          • * object Additional properties
        • found boolean Required
        • _seq_no number
        • _primary_term number
        • _routing string
        • _source object
          Hide _source attribute Show _source attribute object

          • * object Additional properties
  • took number Required

    The length of time, in milliseconds, it took to process the bulk request.

  • ingest_took number

Path parameters

• index string Required

  The name of the data stream, index, or index alias to perform bulk actions on.

Query parameters

• include_source_on_error boolean

  True or false if to include the document source in the error message in case of parsing errors.

• list_executed_pipelines boolean

  If true, the response will include the ingest pipelines that were run for each index or create.

• pipeline string

  The pipeline identifier to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to _none turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter.

• refresh string

  If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If wait_for, wait for a refresh to make this operation visible to search. If false, do nothing with refreshes. Valid values: true, false, wait_for.

  Values are true, false, or wait_for.

• routing string

  A custom value that is used to route operations to a specific shard.

• _source boolean | string | array[string]

  Indicates whether to return the _source field (true or false) or contains a list of fields to return.

• _source_excludes string | array[string]

  A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. If the _source parameter is false, this parameter is ignored.

• _source_includes string | array[string]

  A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.

• timeout string

  The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards. The default is 1m (one minute), which guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.

• wait_for_active_shards number | string

  The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). The default is 1, which waits for each primary shard to be active.

• require_alias boolean

  If true, the request's actions must target an index alias.

• require_data_stream boolean

  If true, the request's actions must target a data stream (existing or to be created).

Responses

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

  • errors boolean Required

    If true, one or more of the operations in the bulk request did not complete successfully.

  • items array[object] Required

    The result of each operation in the bulk request, in the order they were submitted.

    Hide items attribute Show items attribute object

    • * object Additional properties
      Hide * attributes Show * attributes object

      • _id string | null

        The document ID associated with the operation.

        One of:

        string-1 string string-2 string | null
      • _index string Required

        The name of the index associated with the operation. If the operation targeted a data stream, this is the backing index into which the document was written.

      • status number Required

        The HTTP status code returned for the operation.

      • failure_store string

        Values are not_applicable_or_unknown, used, not_enabled, or failed.

      • error object
        Hide error attributes Show error attributes object

        • type string Required

          The type of error

        • reason string

          A human-readable explanation of the error, in English.

        • stack_trace string

          The server stack trace. Present only if the error_trace=true parameter was sent with the request.

        • caused_by object
        • root_cause array[object]
        • suppressed array[object]
      • _primary_term number

        The primary term assigned to the document for the operation. This property is returned only for successful operations.

      • result string

        The result of the operation. Successful values are created, deleted, and updated.

      • _seq_no number
      • _shards object
        Hide _shards attributes Show _shards attributes object

        • failed number Required
        • successful number Required
        • total number Required
        • failures array[object]
        • skipped number
      • _version number
      • forced_refresh boolean
      • get object
        Hide get attributes Show get attributes object

        • fields object
          Hide fields attribute Show fields attribute object

          • * object Additional properties
        • found boolean Required
        • _seq_no number
        • _primary_term number
        • _routing string
        • _source object
          Hide _source attribute Show _source attribute object

          • * object Additional properties
  • took number Required

    The length of time, in milliseconds, it took to process the bulk request.

  • ingest_took number

Path parameters

• index string Required

  The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (*) pattern of an index template with a data_stream definition, this request creates the data stream. If the target doesn't exist and doesn’t match a data stream template, this request creates the index.

• id string Required

  A unique identifier for the document. To automatically generate a document ID, use the POST /<target>/_doc/ request format.

Query parameters

• if_primary_term number

  Only perform the operation if the document has this primary term.

• if_seq_no number

  Only perform the operation if the document has this sequence number.

• include_source_on_error boolean

  True or false if to include the document source in the error message in case of parsing errors.

• op_type string

  Set to create to only index the document if it does not already exist (put if absent). If a document with the specified _id already exists, the indexing operation will fail. The behavior is the same as using the <index>/_create endpoint. If a document ID is specified, this paramater defaults to index. Otherwise, it defaults to create. If the request targets a data stream, an op_type of create is required.

  Values are index or create.

• pipeline string

  The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to _none turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter.

• refresh string

  If true, Elasticsearch refreshes the affected shards to make this operation visible to search. If wait_for, it waits for a refresh to make this operation visible to search. If false, it does nothing with refreshes.

  Values are true, false, or wait_for.

• require_alias boolean

  If true, the destination must be an index alias.

• require_data_stream boolean

  If true, the request's actions must target a data stream (existing or to be created).

• routing string

  A custom value that is used to route operations to a specific shard.

• timeout string

  The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. Elasticsearch waits for at least the specified timeout period before failing. The actual wait time could be longer, particularly when multiple waits occur.

  This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur.

• version number

  The explicit version number for concurrency control. It must be a non-negative long number.

• version_type string

  The version type.

  Values are internal, external, external_gte, or force.

• wait_for_active_shards number | string

  The number of shard copies that must be active before proceeding with the operation. You can set it to all or any positive integer up to the total number of shards in the index (number_of_replicas+1). The default value of 1 means it waits for each primary shard to be active.