Path parameters

• name string Required

  The name of the analytics collection to be deleted

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.

Responses

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

  • * object Additional properties
    Hide * attribute Show * attribute object

    • event_data_stream object Required
      Hide event_data_stream attribute Show event_data_stream attribute object

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

• expand_wildcards string | array[string]

  The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden.

  Values are all, open, closed, hidden, or none.

• master_timeout string

  The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to -1.

  Values are -1 or 0.

Responses

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

  • alias string

    alias name

  • index string
  • filter string

    filter

  • routing.index string

    index routing

  • routing.search string

    search routing

  • is_write_index string

    write index

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:

    UnitSeconds number StringifiedEpochTimeUnitSeconds string

    Time unit for seconds
  • timestamp string

    Time of day, expressed as HH:MM:SS

  • count string

    the document count

Responses

• 200 application/json

Path parameters

• id string Required

  The ID of the data frame analytics to fetch

Query parameters

• allow_no_match boolean

  Whether to ignore if a wildcard expression matches no configs. (This includes _all string or when no configs have been specified)

• bytes string

  The unit in which 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.

  Values are assignment_explanation, ae, create_time, ct, createTime, description, d, dest_index, di, destIndex, failure_reason, fr, failureReason, id, model_memory_limit, mml, modelMemoryLimit, node.address, na, nodeAddress, node.ephemeral_id, ne, nodeEphemeralId, node.id, ni, nodeId, node.name, nn, nodeName, progress, p, source_index, si, sourceIndex, state, s, type, t, version, or v.

• s string | array[string]

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

  Values are assignment_explanation, ae, create_time, ct, createTime, description, d, dest_index, di, destIndex, failure_reason, fr, failureReason, id, model_memory_limit, mml, modelMemoryLimit, node.address, na, nodeAddress, node.ephemeral_id, ne, nodeEphemeralId, node.id, ni, nodeId, node.name, nn, nodeName, progress, p, source_index, si, sourceIndex, state, s, type, t, version, or v.

• time string

  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
  • type string

    The type of analysis that the job performs.

  • create_time string

    The time when the job was created.

  • version string
  • source_index string
  • dest_index string
  • description string

    A description of the job.

  • model_memory_limit string

    The approximate maximum amount of memory resources that are permitted for the job.

  • state string

    The current status of the job.

  • failure_reason string

    Messages about the reason why the job failed.

  • progress string

    The progress report for the job by phase.

  • assignment_explanation string

    Messages related to the selection of a node.

  • node.id string
  • node.name string
  • node.ephemeral_id string
  • node.address string

    The network address of the assigned node.

Query parameters

• allow_no_match boolean

  Specifies what to do when the request:

  • Contains wildcard expressions and there are no datafeeds 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 datafeeds 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.

• h string | array[string]

  Comma-separated list of column names to display.

  Values are ae, assignment_explanation, bc, buckets.count, bucketsCount, id, na, node.address, nodeAddress, ne, node.ephemeral_id, nodeEphemeralId, ni, node.id, nodeId, nn, node.name, nodeName, sba, search.bucket_avg, searchBucketAvg, sc, search.count, searchCount, seah, search.exp_avg_hour, searchExpAvgHour, st, search.time, searchTime, s, or state.

• s string | array[string]

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

  Values are ae, assignment_explanation, bc, buckets.count, bucketsCount, id, na, node.address, nodeAddress, ne, node.ephemeral_id, nodeEphemeralId, ni, node.id, nodeId, nn, node.name, nodeName, sba, search.bucket_avg, searchBucketAvg, sc, search.count, searchCount, seah, search.exp_avg_hour, searchExpAvgHour, st, search.time, searchTime, s, or state.

• 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

    The datafeed identifier.

  • state string

    Values are started, stopped, starting, or stopping.

  • assignment_explanation string

    For started datafeeds only, contains messages relating to the selection of a node.

  • buckets.count string

    The number of buckets processed.

  • search.count string

    The number of searches run by the datafeed.

  • search.time string

    The total time the datafeed spent searching, in milliseconds.

  • search.bucket_avg string

    The average search time per bucket, in milliseconds.

  • search.exp_avg_hour string

    The exponential average search time per hour, in milliseconds.

  • node.id string

    The unique identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.

  • node.name string

    The name of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.

  • node.ephemeral_id string

    The ephemeral identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.

  • node.address string

    The network address of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.

Path parameters

• transform_id string Required

  A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms.

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.

  Values are changes_last_detection_time, cldt, checkpoint, cp, checkpoint_duration_time_exp_avg, cdtea, checkpointTimeExpAvg, checkpoint_progress, c, checkpointProgress, create_time, ct, createTime, delete_time, dtime, description, d, dest_index, di, destIndex, documents_deleted, docd, documents_indexed, doci, docs_per_second, dps, documents_processed, docp, frequency, f, id, index_failure, if, index_time, itime, index_total, it, indexed_documents_exp_avg, idea, last_search_time, lst, lastSearchTime, max_page_search_size, mpsz, pages_processed, pp, pipeline, p, processed_documents_exp_avg, pdea, processing_time, pt, reason, r, search_failure, sf, search_time, stime, search_total, st, source_index, si, sourceIndex, state, s, transform_type, tt, trigger_count, tc, version, or v.

• s string | array[string]

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

  Values are changes_last_detection_time, cldt, checkpoint, cp, checkpoint_duration_time_exp_avg, cdtea, checkpointTimeExpAvg, checkpoint_progress, c, checkpointProgress, create_time, ct, createTime, delete_time, dtime, description, d, dest_index, di, destIndex, documents_deleted, docd, documents_indexed, doci, docs_per_second, dps, documents_processed, docp, frequency, f, id, index_failure, if, index_time, itime, index_total, it, indexed_documents_exp_avg, idea, last_search_time, lst, lastSearchTime, max_page_search_size, mpsz, pages_processed, pp, pipeline, p, processed_documents_exp_avg, pdea, processing_time, pt, reason, r, search_failure, sf, search_time, stime, search_total, st, source_index, si, sourceIndex, state, s, transform_type, tt, trigger_count, tc, version, or v.

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

Path parameters

• connector_id string Required

  The unique identifier of the connector to be checked in

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

• connector_sync_job_id string Required

  The unique identifier of the connector sync job

Responses

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

  • cancelation_requested_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:

    DateTime string UnitMillis number

    Time unit for milliseconds

  • canceled_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:

    DateTime string UnitMillis number

    Time unit for milliseconds

  • completed_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:

    DateTime string UnitMillis number

    Time unit for milliseconds

  • connector object Required
    Hide connector attributes Show connector attributes object

    • 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:

          ScalarValue number ScalarValue number ScalarValue string ScalarValue boolean ScalarValue string | null
        • depends_on array[object] Required
          Hide depends_on attributes Show depends_on attributes object

          • field string Required
          • value
        • display string Required

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

        • label string Required
        • options array[object] Required
          Hide options attributes Show options attributes object

          • label string Required
          • value
        • 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]
          One of:

          LessThanValidation object GreaterThanValidation object ListTypeValidation object IncludedInValidation object RegexValidation object
        • value object Required
    • filtering object Required
      Hide filtering attributes Show filtering attributes object

      • advanced_snippet object Required
        Hide advanced_snippet attributes Show advanced_snippet attributes object

        • created_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:

          DateTime string UnitMillis number

          Time unit for milliseconds

        • updated_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:

          DateTime string UnitMillis number

          Time unit for milliseconds

        • value object Required
      • rules array[object] Required
        Hide rules attributes Show rules attributes object

        • created_at string
        • field string Required

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

        • id string Required
        • order number Required
        • policy string Required

          Values are exclude or include.

        • rule string Required

          Values are contains, ends_with, equals, regex, starts_with, >, or <.

        • updated_at string
        • value string Required
      • validation object Required
        Hide validation attributes Show validation attributes object

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

          • ids array[string] Required
          • messages array[string] Required
        • state string Required

          Values are edited, invalid, or valid.

    • id string Required
    • index_name string Required
    • language 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
    • service_type string Required
    • sync_cursor object

  • created_at string | number Required

    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:

    DateTime string UnitMillis number

    Time unit for milliseconds

  • deleted_document_count number Required
  • error string
  • id string Required
  • indexed_document_count number Required
  • indexed_document_volume number Required
  • job_type string Required

    Values are full, incremental, or access_control.

  • 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:

    DateTime string UnitMillis number

    Time unit for milliseconds

  • metadata object Required
    Hide metadata attribute Show metadata attribute object

    • * object Additional properties

  • started_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:

    DateTime string UnitMillis number

    Time unit for milliseconds

  • status string Required

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

  • total_document_count number Required
  • trigger_method string Required

    Values are on_demand or scheduled.

  • worker_hostname string

Responses

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

  • 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

• 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

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

  Values are all, open, closed, hidden, or none.

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

  Values are -1 or 0.

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

    • settings object Required Additional properties
      Index settings
    • status string Required

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

    • system boolean Generally available

      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 | array[string] Required

  Comma-separated list of data streams to delete. Wildcard (*) expressions are supported.

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.

  Values are -1 or 0.

• expand_wildcards string | array[string]

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

  Values are all, open, closed, hidden, or none.

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.

  Values are -1 or 0.

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

  Values are all or index-setting.

• 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 | null

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

          One of:

          string-1 string string-2 string | null
        • 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