Authentication

Path parameters

• name array[string] Required

  A list of analytics collections to limit the returned information

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

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

Path parameters

• name string | array[string] Required

  A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

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

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.

  Values are -1 or 0.

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:

    UnitSeconds number string-2 string

    Time unit for seconds
  • timestamp string

    Time of day, expressed as HH:MM:SS

  • count string

    the document count

Path parameters

• connector_id string Required

  The unique identifier of the connector

Query parameters

• include_deleted boolean

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

Responses

• 200 application/json
  Hide response attributes Show response 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:

        number-1 number number-2 number string-3 string boolean-4 boolean string-5 string | null
      • depends_on array[object] Required
        Hide depends_on attributes Show depends_on attributes object

        • field string Required

        • value number | string | boolean | null Required

          A scalar value.

          One of:

          number-1 number number-2 number string-3 string boolean-4 boolean string-5 string | null
      • 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 number | string | boolean | null Required

          A scalar value.

          One of:

          number-1 number number-2 number string-3 string boolean-4 boolean string-5 string | null
      • 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 GreaterThanValidation ListTypeValidation IncludedInValidation RegexValidation
      • 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 | 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:

        string-1 string UnitMillis number

        Time unit for milliseconds

      • 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
        Hide advanced_snippet attributes Show advanced_snippet attributes object

        • created_at string
        • updated_at string
        • value object Required
      • rules array[object] Required
        Hide rules attributes Show rules attributes object

        • created_at
        • 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
        • value string Required
      • validation object Required
        Hide validation attributes Show validation attributes object

        • errors array[object] Required
        • state string Required

          Values are edited, invalid, or valid.

    • domain string
    • draft object Required
      Hide draft attributes Show draft attributes object

      • advanced_snippet object Required
        Hide advanced_snippet attributes Show advanced_snippet attributes object

        • created_at string
        • updated_at string
        • value object Required
      • rules array[object] Required
        Hide rules attributes Show rules attributes object

        • created_at
        • 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
        • value string Required
      • validation object Required
        Hide validation attributes Show validation attributes object

        • errors array[object] Required
        • state string Required

          Values are edited, invalid, or valid.

  • id string

  • index_name string | null

    One of:

    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:

    string-1 string 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:

    string-1 string 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:

    string-1 string 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:

    string-1 string 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:

    string-1 string 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