Query parameters

• fromnumber

  Starting offset (default: 0)
• sizenumber

  Specifies a max number of results to get

• index_namestring | array[string]

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

• connector_namestring | array[string]

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

• service_typestring | array[string]

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

• include_deletedboolean

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

• querystring

  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

  • countnumber Required
  • resultsarray[object] Required
    Hide results attributes Show results attributes object

    • api_key_idstring
    • api_key_secret_idstring
    • configurationobject Required
      Hide configuration attribute Show configuration attribute object

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

        • categorystring

        • default_valuenumber | string | boolean | null Required

          A scalar value.

          One of:

          ScalarValuenumberScalarValuenumberScalarValuestringScalarValuebooleanScalarValuestring | null
        • depends_onarray[object] Required
        • displaystring Required

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

        • labelstring Required
        • optionsarray[object] Required
        • ordernumber
        • placeholderstring
        • requiredboolean Required
        • sensitiveboolean Required

        • tooltipstring | null

          One of:

          string-1stringstring-2string | null
        • typestring

          Values are str, int, list, or bool.

        • ui_restrictionsarray[string]
        • validationsarray[object]
        • valueobject Required
    • custom_schedulingobject Required
      Hide custom_scheduling attribute Show custom_scheduling attribute object

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

        • configuration_overridesobject Required
          Hide configuration_overrides attributes Show configuration_overrides attributes object

          • max_crawl_depthnumber
          • sitemap_discovery_disabledboolean
          • domain_allowlistarray[string]
          • sitemap_urlsarray[string]
          • seed_urlsarray[string]
        • enabledboolean Required
        • intervalstring Required
        • last_syncedstring
        • namestring Required
    • deletedboolean Required
    • descriptionstring

    • errorstring | null

      One of:

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

      • document_level_securityobject
        Hide document_level_security attribute Show document_level_security attribute object

        • enabledboolean Required
      • incremental_syncobject
        Hide incremental_sync attribute Show incremental_sync attribute object

        • enabledboolean Required
      • native_connector_api_keysobject
        Hide native_connector_api_keys attribute Show native_connector_api_keys attribute object

        • enabledboolean Required
      • sync_rulesobject
        Hide sync_rules attributes Show sync_rules attributes object

        • advancedobject
          Hide advanced attribute Show advanced attribute object
        • basicobject
          Hide basic attribute Show basic attribute object

          • enabledboolean Required
    • filteringarray[object] Required
      Hide filtering attributes Show filtering attributes object

      • activeobject Required
        Hide active attributes Show active attributes object

        • advanced_snippetobject Required
        • rulesarray[object] Required
        • validationobject Required
      • domainstring
      • draftobject Required
        Hide draft attributes Show draft attributes object

        • advanced_snippetobject Required
        • rulesarray[object] Required
        • validationobject Required
    • idstring

    • index_namestring | null

      One of:

      IndexNamestringstring-2string | null
    • is_nativeboolean Required
    • languagestring
    • last_access_control_sync_errorstring

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

      DateTimestringUnitMillisnumber

      Time unit for milliseconds

    • last_access_control_sync_statusstring

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

    • last_deleted_document_countnumber

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

      DateTimestringUnitMillisnumber

      Time unit for milliseconds

    • last_indexed_document_countnumber

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

      DateTimestringUnitMillisnumber

      Time unit for milliseconds

    • last_sync_errorstring

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

      DateTimestringUnitMillisnumber

      Time unit for milliseconds

    • last_sync_statusstring

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

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

      DateTimestringUnitMillisnumber

      Time unit for milliseconds

    • namestring
    • pipelineobject
      Hide pipeline attributes Show pipeline attributes object

      • extract_binary_contentboolean Required
      • namestring Required
      • reduce_whitespaceboolean Required
      • run_ml_inferenceboolean Required
    • schedulingobject Required
      Hide scheduling attributes Show scheduling attributes object

      • access_controlobject
        Hide access_control attributes Show access_control attributes object

        • enabledboolean Required
        • intervalstring Required

          The interval is expressed using the crontab syntax

      • fullobject
        Hide full attributes Show full attributes object

        • enabledboolean Required
        • intervalstring Required

          The interval is expressed using the crontab syntax

      • incrementalobject
        Hide incremental attributes Show incremental attributes object

        • enabledboolean Required
        • intervalstring Required

          The interval is expressed using the crontab syntax

    • service_typestring
    • statusstring Required

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

    • sync_cursorobject
    • sync_nowboolean Required