SearchBlox

Downloads
Search as a Service
Guides
API Reference
Forums
Open Ticket
Contact Us

{{user.name}}Log In

SearchBlox Developer Hub

Welcome to the SearchBlox developer hub. Here you will find comprehensive guides and documentation to help you start working with SearchBlox as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides

v9.1

v8.5.1
v8.6
v8.6.3
v8.6.4
v8.6.5
v8.6.6
v8.6.7
v8.6.8
v8.6.9
v9.0
v9.1stable
v9.2beta

HomeGuidesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API LogsTutorials

Search results for "{{ search.query }}"

No results found for "{{search.query}}". Ask about it in support.

Documentation {{result.subdomain ? 'in ' + result.subdomain : ''}}
{{result.method}}Reference {{result.subdomain ? 'in ' + result.subdomain : ''}}
Changelog {{result.subdomain ? 'in ' + result.subdomain : ''}}
Discussions {{result.subdomain ? 'in ' + result.subdomain : ''}}
Page {{result.subdomain ? 'in ' + result.subdomain : ''}}

View All Results

Overview

Architecture
- High Availability Architecture
- High Performance Engineering
Getting Started
Features
Connectors
File Formats
Languages
- Stopwords
- Language Selection

Installation

Requirements
Installing on Windows
Installing on Centos, RHEL
Installing on Ubuntu
Installing on Amazon Linux 2
Directory Layout
License Key
Cluster Setup
Cluster Setup on AWS
Deploying on Azure
Deploying on Docker
Monitoring
Installation Tuning
SSL Setup
Upgrading SearchBlox
Access to Elasticsearch
Using SQL in Elasticsearch
Indexed Data Storage
Snapshot and Restore
- SearchBlox Backup and Restore Utility in Windows
- SearchBlox Backup and Restore Utility in Linux
Enabling CORS for SearchBlox
Using SQL for Querylogs and Topviewed
Analyzers in SearchBlox
Customize 404 Error Page in SearchBlox
Setting up HAProxy for Cluster Setup

Admin Dashboard

Overview
Collections Dashboard
Search Settings
- Featured Results
- Security
Analytics and Reports
- Query Reports
- Top Clicked Documents
Configuration

Collections

HTTP Collection
File Collection
Email Collection
Database Collection
Amazon S3 Collection
MongoDB Collection
CSV Collection
Custom Collection

Search

Searching
Search Parameters
Regular Search
Advanced Search
Faceted Search
Custom Search Plugins
Secure Search
Document Preview / Translate
Document Tagging and Sharing
Relevancy Tuning & Boosting
Search Box
SearchBlox Widget for Search
Related Queries in Search and API
Filters and Facets
Uploading Search Front Ends
Custom Fields in Search
Integrating Sharepoint and SearchBlox
Google Analytics Integration

API

REST API
HTTP API
Featured Results API
Collection API
Search Query API
Using cURL for API
Best Practices

Google Search Appliance Migration

Search Requests
Search Responses
Query Suggestion Service
KeyMatch vs Featured Results
OneSource for SearchBlox

External Connectors

Connectors
Network Connector
Google Drive Connector
Google Site Connector
Box Connector
Dropbox Connector
Confluence Connector
SharePoint 2013 Connector
SharePoint Online Connector
GitHub Connector
Slack Connector
Alfresco Connector
OneDrive Connector
Drupal Connector
Azure File Connector
Azure Blob Connector
XML Connector
Salesforce Connector
Amazon S3 Connector
Zendesk Connector
SharePoint 2010 Connector
URL Connector
JIRA Connector

Third Party Integrations

Kibana Visualizations
Kibana Alerts
Typeform with SearchBlox using Zapier
Classify Images with DeepDetect
Indexing Azure File Storage

SearchBlox for Amazon Elasticsearch Service

SearchBlox for Amazon Elasticsearch Service
Sizing for EC2 instances

Overview

Architecture
- High Availability Architecture
- High Performance Engineering
Getting Started
Features
Connectors
File Formats
Languages
- Stopwords
- Language Selection

Installation

Requirements
Installing on Windows
Installing on Centos, RHEL
Installing on Ubuntu
Installing on Amazon Linux 2
Directory Layout
License Key
Cluster Setup
Cluster Setup on AWS
Deploying on Azure
Deploying on Docker
Monitoring
Installation Tuning
SSL Setup
Upgrading SearchBlox
Access to Elasticsearch
Using SQL in Elasticsearch
Indexed Data Storage
Snapshot and Restore
- SearchBlox Backup and Restore Utility in Windows
- SearchBlox Backup and Restore Utility in Linux
Enabling CORS for SearchBlox
Using SQL for Querylogs and Topviewed
Analyzers in SearchBlox
Customize 404 Error Page in SearchBlox
Setting up HAProxy for Cluster Setup

Admin Dashboard

Overview
Collections Dashboard
Search Settings
- Featured Results
- Security
Analytics and Reports
- Query Reports
- Top Clicked Documents
Configuration

Collections

HTTP Collection
File Collection
Email Collection
Database Collection
Amazon S3 Collection
MongoDB Collection
CSV Collection
Custom Collection

Search

Searching
Search Parameters
Regular Search
Advanced Search
Faceted Search
Custom Search Plugins
Secure Search
Document Preview / Translate
Document Tagging and Sharing
Relevancy Tuning & Boosting
Search Box
SearchBlox Widget for Search
Related Queries in Search and API
Filters and Facets
Uploading Search Front Ends
Custom Fields in Search
Integrating Sharepoint and SearchBlox
Google Analytics Integration

API

REST API
HTTP API
Featured Results API
Collection API
Search Query API
Using cURL for API
Best Practices

Google Search Appliance Migration

Search Requests
Search Responses
Query Suggestion Service
KeyMatch vs Featured Results
OneSource for SearchBlox

External Connectors

Connectors
Network Connector
Google Drive Connector
Google Site Connector
Box Connector
Dropbox Connector
Confluence Connector
SharePoint 2013 Connector
SharePoint Online Connector
GitHub Connector
Slack Connector
Alfresco Connector
OneDrive Connector
Drupal Connector
Azure File Connector
Azure Blob Connector
XML Connector
Salesforce Connector
Amazon S3 Connector
Zendesk Connector
SharePoint 2010 Connector
URL Connector
JIRA Connector

Third Party Integrations

Kibana Visualizations
Kibana Alerts
Typeform with SearchBlox using Zapier
Classify Images with DeepDetect
Indexing Azure File Storage

SearchBlox for Amazon Elasticsearch Service

SearchBlox for Amazon Elasticsearch Service
Sizing for EC2 instances

Support

REST API - XML

post
Add Custom Collection - /api/rest/coladd
post
Delete Collection - /api/rest/coldelete
post
Clear Collection - /api/rest/clear
post
Index Custom Collection - /api/rest/index
post
Document Status - /api/rest/status
post
Delete Document - /api/rest/delete
post
Add/Update Document - /api/rest/docadd
post
Delete Document HTTP Collection - /api/rest/docdelete

REST API - JSON

post
Add Collection - /rest/v2/api/coladd
post
Delete Collection - rest/v2/api/coldelete
post
Clear Collection - /rest/v2/api/clear
post
Index Custom Collection - rest/v2/api/index
post
Document Status - rest/v2/api/status
post
Delete Document - rest/v2/api/delete
post
Add/Update Document - rest/v2/api/docadd
post
Delete Document HTTP Collection - rest/v2/api/docdelete

HTTP API - JSON

post
Add Collection - /rest/collection/add
post
Delete Collection - /rest/collection/delete
post
Update Collection Path - /rest/collection/updatePath
post
Update Collection Settings - /rest/collection/updateSettings
post
Update Scheduler - /rest/collection/updateScheduler
post
Collection Actions - /rest/collection/actions

Featured Results API

post
Add Featured Result - /rest/v2/api/ads/create
post
Update Featured Result - /rest/v2/api/ads/update
post
Delete a Featured Result - /rest/v2/api/ads/delete
post
Activate a Featured Result - /rest/v2/api/ads/activate
post
List UIDs of All Featured Result - /rest/v2/api/ads/list
post
Delete All Featured Result - /rest/v2/api/ads/clear

Search Query API

post
Related Queries API - /rest/v2/api/related/query
post
Top Queries API - /rest/v2/api/query/top

Collection API

post
Listing the Collections - /rest/collection/list
post
Getting Collection ID - /rest/collection/list

Installing on Ubuntu

Suggest Edits

Updated 3 months ago

Table of Contents
{{ node.data[1] }}
- {{ node.data[1] }}

Table of Contents
{{ node.data[1] }}
- {{ node.data[1] }}

Installing on Ubuntu

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.