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

• 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

        Additional properties are allowed.

        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

          Additional properties are allowed.

        • display string Required

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

        • label string Required
        • options array[object] Required

          Additional properties are allowed.

        • 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

          Additional properties are allowed.

    • custom_scheduling object Required
      Hide custom_scheduling attribute Show custom_scheduling attribute object

      • * object Additional properties

        Additional properties are allowed.

        Hide * attributes Show * attributes object

        • configuration_overrides object Required

          Additional properties are allowed.

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

    • error string | null

      One of:

      string-1 string string-2 string | null
    • features object

      Additional properties are allowed.

      Hide features attributes Show features attributes object

      • document_level_security object

        Additional properties are allowed.

        Hide document_level_security attribute Show document_level_security attribute object

        • enabled boolean Required
      • incremental_sync object

        Additional properties are allowed.

        Hide incremental_sync attribute Show incremental_sync attribute object

        • enabled boolean Required
      • native_connector_api_keys object

        Additional properties are allowed.

        Hide native_connector_api_keys attribute Show native_connector_api_keys attribute object

        • enabled boolean Required
      • sync_rules object

        Additional properties are allowed.

        Hide sync_rules attributes Show sync_rules attributes object

        • advanced object

          Additional properties are allowed.

          Hide advanced attribute Show advanced attribute object

          • enabled boolean Required
        • basic object

          Additional properties are allowed.

          Hide basic attribute Show basic attribute object

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

      • active object Required

        Additional properties are allowed.

        Hide active attributes Show active attributes object

        • advanced_snippet object Required

          Additional properties are allowed.

        • rules array[object] Required
        • validation object Required

          Additional properties are allowed.

      • domain string
      • draft object Required

        Additional properties are allowed.

        Hide draft attributes Show draft attributes object

        • advanced_snippet object Required

          Additional properties are allowed.

        • rules array[object] Required
        • validation object Required

          Additional properties are allowed.

    • 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

      Additional properties are allowed.

      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

      Additional properties are allowed.

      Hide scheduling attributes Show scheduling attributes object

      • access_control object

        Additional properties are allowed.

        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

        Additional properties are allowed.

        Hide full attributes Show full attributes object

        • enabled boolean Required
        • interval string Required

          The interval is expressed using the crontab syntax

      • incremental object

        Additional properties are allowed.

        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

      Additional properties are allowed.

    • sync_now boolean Required