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

• include_deleted boolean

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

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

        • category string
        • depends_on array[object] Required
        • label string Required
        • options array[object] Required
        • order number
        • placeholder string
        • required boolean Required
        • sensitive boolean Required
        • tooltip
        • ui_restrictions array[string]
        • validations array[object]
        • value object Required
    • custom_scheduling object Required
      Hide custom_scheduling attribute Show custom_scheduling attribute object

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

        • enabled boolean Required
        • interval string Required
        • 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

        Indicates whether document-level security is enabled.

      • incremental_sync object

        Indicates whether incremental syncs are enabled.

      • native_connector_api_keys object

        Indicates whether managed connector API keys are enabled.

      • sync_rules object
    • filtering array[object] Required
      Hide filtering attributes Show filtering attributes object

      • active object Required
      • domain string
      • draft object Required
    • 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

      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

      One of:

      string-1 string UnitMillis number

      Time unit for milliseconds

    • last_indexed_document_count number

    • last_seen string | number

      One of:

      string-1 string UnitMillis number

      Time unit for milliseconds

    • last_sync_error string

    • last_sync_scheduled_at string | number

      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

      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
      • full object
      • incremental object
    • service_type string
    • status string Required

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

    • sync_cursor object
    • sync_now boolean Required