SearchBlox

SearchBlox Developer Documentation

Welcome to the SearchBlox developer documentation. Here you will find comprehensive technical 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

Collection API

The SearchBlox Collections API enables the user to get a list of collection names/ids as well as individual collection id from SearchBlox using simple HTTP POST and GET actions. Searchblox Collection API provides methods for working with few aspects of collection and indexed documents using REST requests with JSON payloads.

Listing the Collections

Index URL

http://localhost:8080/searchblox/rest/collection/list

Method

POST

Media Type

application/json

Headers

content-type : application/json
accept: application/json

Document Syntax

{
"apikey":"C6D418861BAD66A46A7CC96B70CEADF9"
}

Document Description

JSON Fields

Value

apikey

API key accessible in the SearchBlox Admin Console. It is also present in the config.xml file.

Get the individual Collection Id

Index URL

http://localhost:8080/searchblox/rest/collection/list

Method

POST

Media Type

application/json

Headers

content-type : application/json
accept: application/json

Document Syntax

{
"apikey":"C6D418861BAD66A46A7CC96B70CEADF9",
"name": "site"
}

Document Description

JSON Fields

Value

apikey

API key accessible in the SearchBlox Admin Console. It is also present in the config.xml file.

Name

Name of the collection for which the id has to be identified

Updated 10 months ago


Collection API


Suggested Edits are limited on API Reference Pages

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