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 EpochTimeUnitMillis 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 EpochTimeUnitMillis 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 EpochTimeUnitMillis 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 EpochTimeUnitMillis 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 EpochTimeUnitMillis 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 EpochTimeUnitMillis 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 EpochTimeUnitMillis 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 EpochTimeUnitMillis 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