DownloadsDocumentationAPI ReferenceChangelogOpen A TicketContact

The SearchBlox REST-API enables the indexing and searching of custom content using simple HTTP POST and GET actions. The REST-API can add and delete documents from Custom, HTTP and File Collections only.

SearchBlox REST-API provide methods for working with standard and custom collections by means of REST requests with XML and JSON payloads. Index, delete, clear, and check the status of custom collections, or create new custom collections using REST-API. Individual documents can also be added or deleted in HTTP and file collections.

# **SearchBlox Development Environment**

The SearchBlox Development Environment otherwise known as **API Explorer** is a simple browser-based tool designed to help developers use the SearchBlox REST-API with minimal effort. This tool is part of the SearchBlox deployment and can be accessed here: [http://localhost:8080/searchblox/sde/index.jsp](🔗). SearchBlox's API Explorer supports REST-XML and REST-JSON API.

POSTMAN is another external third-party tool that can be used with Searchblox XML and JSON API. The settings for POSTMAN API can be found at the end of this documentation. For more details on the POSTMAN API tool, refer to [https://www.getpostman.com](🔗).

# **Index**

## Index URL

REST-XML API http://localhost:8080/searchblox/api/rest/add REST-JSON API http://localhost:8080/searchblox/rest/v2/api/add

## Method

POST

## Media Type

REST-XML API text or text/xml or application/xml REST-JSON API application/json

## Document Syntax

REST-XML API


REST-JSON API

## Document Description
XML Tag/JSON keyAttributeValue
searchbloxLicenseidLicense value from license.xml file.
apikey
API key from http://localhost:8080/searchblox/admin/main.jsp?menu1=adm.
documentcolnameName of the custom collection.
documentLocationValue of file location (URL or file path)
url
URL value to be returned with search results.
uid
Assigned unique identifier for a document (the URL is used as uid when unassigned).
title
Title value of search results.
titleboostBoost value range from 1-10.
keywords
Keyword value of document.
keywordsboostBoost value range from 1-10.
content
Content of document.
contentboostBoost value range from 1-10.
description
Description of search result.
descriptionBoostBoost value ranage from 1-10.
lastmodified
Date in format 07 May 2015 06:19:42 GMT.
size
Size value.
alpha
Text value for sorting.
contenttype
Type of content value (HTML, PDF, etc.,).
urllen
length
meta
meta fields to be updated
## Response Codes
XML
CodeDescription
100Document Indexed
101Error Indexing Document
500Invalid Collection Name
502Invalid Document Location
503Specified collection is not a CUSTOM collection
JSON 
codeDescription
100Document Indexed
101Error Indexing Document
501Invalid Collection Name
502Invalid Document Location
# **Update Meta Data**
## updatemetadata URL
REST-JSON API
http://localhost:8080/searchblox/rest/v2/api/updatemetadata
## Method
POST
## Media Type
REST-JSON API
application/json
## Document Syntax
REST-JSON API

## Document Description
JSON AttributeDescription
apikeyAPI key from http://localhost:8080/searchblox/admin/main.jsp?menu1=adm.
colnameName of the collection
urlURL value to be returned with search results.
meta fieldscustom fields
## Response Codes
CodeDescription
7000Meta Data updated successfully
601Invalid API Key
7003Document not found
# **Delete**
This is to delete documents only in custom collection
## Delete URL 
REST-XML API
http://localhost:8080/searchblox/api/rest/delete
REST-JSON API
http://localhost:8080/searchblox/rest/v2/api/delete
## Method
POST
## Media Type
REST-XML API
text or text/xml or application/xml
REST-JSON API
application/json
## Document Syntax
REST-XML API

REST-JSON API

# Document Description
XML Tag/JSON keyAttributeValue
searchbloxlicenseidLicense value from license.xml file.
apikey
API key from http://localhost:8080/searchblox/admin/main.jsp?menu1=adm.
documentcolnameName of the custom collection.
documentuidValue of unique identifier (file location or URL).
## Response Codes
XML
Column Title
Column Title
200Document Deleted Successfully
201Document requested for deletion does not exist.
500Invalid Collection Name
503Specified collection is not a CUSTOM collection.
JSON 
Column Title
Column Title
2001Document Deleted Successfully
2002Document requested for deletion does not exist.
501Invalid Collection Name
# **Document Status**
## Status URL
REST-XML API
http://localhost:8080/searchblox/api/rest/status
REST-JSON API
http://localhost:8080/searchblox/rest/v2/api/status
## Method
POST
## Media Type
REST-XML API
text or text/xml or application/xml
REST-JSON API
application/json
## Document Syntax
REST-XML API

REST-JSON API

## Document Description
XML TagAttributeValue
searchbloxlicenseidLicense value from license.xml file.
apikey
API key from http://localhost:8080/searchblox/admin/main.jsp?menu1=adm.
documentcolnameName of the custom collection.
documentuidValue of unique identifier (URL or file location)
## Response Codes
XML
Column Title
Column Title
301Document Not Found
500Invalid Collection Name
503Specified collection is not a CUSTOM collection.
JSON 
Column Title
Column Title
501Invalid Collection Name
# **Clear Collection**
## Clear URL
REST-XML API
http://localhost:8080/searchblox/api/rest/clear
REST-JSON API
http://localhost:8080/searchblox/rest/v2/api/clear
## Method
POST
## Media Type
REST-XML API
text or text/xml or application/xml
REST-JSON API
application/json
## Document Syntax
REST-XML API

REST-JSON API

## Document Description
XML TagAttributeValue
searchbloxlicenseid/apikeyLicense value from license.xml file.
apikey
API key from http://localhost:8080/searchblox/admin/main.jsp?menu1=adm.
documentcolnameName of the custom collection.
## Response
XML
Column Title
Column Title
400Collection Cleared
500Invalid Collection Name
503Specified collection is not a CUSTOM collection.
JSON 
Column Title
Column Title
400Collection Cleared
501Invalid Collection Name
# **Add collection**
You can add a new custom collection through REST-API using XML or JSON payload using the details provided here.
## Add Collection URL
REST-XML API
http://localhost:8080/searchblox/api/rest/coladd
REST-JSON API
http://localhost:8080/searchblox/rest/v2/api/coladd
## Method
POST
## Media Type
REST-XML API
text or text/xml or application/xml
REST-JSON API
application/json
## Document Syntax
REST-XML API

REST-JSON API

## Document Description
XML Tag/JSON KeyAttributeValue
searchbloxapikeyAPI key from http://localhost:8080/searchblox/admin/main.jsp?menu1=adm.
documentcolnameName of the custom collection.

languageLanguage of the collection specified in standard two letter code.
[https://developer.searchblox.com/v9.2/docs/supported-languages#language-codes](🔗)

coltypeType of collection.
## Response Codes
XML
Column Title
Column Title
900Custom Collection Added
901Failed Adding Collection
JSON 
Column Title
Column Title
900Custom Collection Added
901Failed Adding Collection
# **Delete Collection**
You can delete existing custom collections through REST-API using XML orJSON payload using the details given here.
## Delete Collection URL
REST-XML API
http://localhost:8080/searchblox/api/rest/coldelete
REST-JSON API
http://localhost:8080/searchblox/rest/v2/api/coldelete
## Method
POST
## Media Type
REST-XML API
text or text/xml or application/xml
REST-JSON API
application/json
## Document Syntax
REST-XML API

REST-JSON API

## Document Description
XML TagAttributeValue
searchbloxapikeyAPI key from http://localhost:8080/searchblox/admin/main.jsp?menu1=adm.
documentcolnameName of the custom collection.
## Response
XML
Column Title
Column Title
800Custom Collection Deleted
500Invalid Collection Name
503Specified collection is not a CUSTOM collection.
JSON 
Column Title
Column Title
800Collection Deleted
501Invalid Collection Name
# **Add/Update Document**
You can add documents to an HTTP collection or File collection through REST-API using XML (SDE in SearchBlox can also be used) or JSON payload using the details given here.
## Add/update Document URL
REST-XML API
http://localhost:8080/searchblox/api/rest/docadd
REST-JSON API
http://localhost:8080/searchblox/rest/v2/api/docadd
## Method
POST
## Media Type
REST-XML API
text or text/xml or application/xml
REST-JSON API
application/json
z
##Document Syntax
REST-XML API

REST-JSON API

## Document Description
XML TagAttributeValue
searchbloxapikeyAPI key from http://localhost:8080/searchblox/admin/main.jsp?menu1=adm.
documentcolnameName of the Http or file collection.
documentlocationValue of file location (URL or file location)
## Response
XML
Column Title
Column Title
1001Custom Added Successfully
1002Document couldn't be reached.
JSON
Column Title
Column Title
1001Custom Added Successfully
1002Document couldn't be reached.
501Invalid Collection Name
# **Delete Document**
You can delete documents from an HTTP collection or File collection through REST-API from the Delete Document tab in SDE, using the XML code given in the following Document Syntax section.
## Delete Document URL
REST-XML API
http://localhost:8080/searchblox/api/rest/docdelete
REST-JSON API
http://localhost:8080/searchblox/rest/v2/api/docdelete
## Method
POST
## Media Type
REST-XML API
 text or text/xml or application/xml
REST-JSON API
 application/json
## Document Syntax
REST-XML API

REST-JSON API

## Document Description
XML TagAttributeValue
searchbloxapikeyAPI key from http://localhost:8080/searchblox/admin/main.jsp?menu1=adm.
documentcolnameName of the HTTP or file collection.
documentuidValue of file location (URL or file location)
## Response
XML
Column Title
Column Title
2001Document Deleted Successfully
506Invalid Document UID
 JSON 
Column Title
Column Title
2001Document Deleted Successfully
506Invalid Document UID
501Invalid Collection Name
# **Response Codes**
## Document Syntax

## Status Code Description
Column Title
Column Title
100Document Indexed
101Error Indexing Document
200Document Deleted
201Document requested for deletion does not exist.
301Document Not Found
400Collection Cleared
401Error Clearing Collection
404URL Not Found
405Method not allowed or incorrect method selected.
415Unsupported Media Type
500Invalid Collection Name
501Invalid Request
502Invalid Document Location
503Specified collection is not a CUSTOM collection.
504Licensed Document Limit Exceeded
506Invalid Document UID
601Invalid License ID
602Custom documents not supported by this edition of SearchBlox.
800Custom Collection Deleted
900Custom Collection Added
1001Document Added Successfully
1002Document Couldn't Be Reached
2001Document Deleted Successfully
2002Specified collection is not a custom collection.
# **Settings in POSTMAN API** 
Postman API is a third-party tool that can be using with SearchBlox API. The prerequisite settings that are required to work with SearchBlox API are as follows:
  1. URL to be given for each API function as mentioned under each function in the preceding documentation.
  2. Method to be selected is POST for all functions.
  3. Header to be added is Content-Type, which has to be given as header. The value for the header for XML API is application/xml, and for JSON API it is application/json. This could be also done by selecting the dropdown XML or JSON as required.
The screenshots for XML and JSON API on settings and result are given here. Select raw to view the status code for JSON API.
##XML API POSTMAN settings
1016

## JSON API POSTMAN settings
1011