You can access the JSON REST APIs through the AIE baseport (port 17000 by default), using the /rest context root.
All endpoints accept HTTP POST requests, and some methods that do not require POSTed arguments also accept a HTTP GET.
These features require that the rest module be included when you run createproject to create the project directories.
REST API Parameters
The master list of QueryRequest REST parameters is on the HTTP REST APIs page.
REST API Tutorial
Be sure to examine the REST API Tutorial.
View incoming links.
The following REST clients are recommended.
|Chrome||Postman - Configuration file for search + ingest APIs is attached. The perfmon API is separately attached.|
|IE||this space intentionally left blank|
|Unix Command Line||cURL with examples found in our tutorial|
|Model Data Type||JSON Representation||Examples|
|String||JSON String||"Hello World"|
|int, long, double, float||JSON numeric type||1, 5.678|
|BigDecimal, BigInteger||JSON String||"1234.56789"|
|Date||JSON String using date format ||"1969-12-31T19:00:10.000-0500"|
In order to achieve the correct output format the
Content-Type headers need to be set on all requests.
Any of the URI endpoints that support JSON output will also support JSONP output. JSONP allows web developers to access JSON data structures from remote web app containers without the use of a proxy.
JSONP requests will be padded with a callback function. The function name, which defaults to 'callback', may be specified with the 'jsonpCallback' parameter in the query string.
All REST API's support GZIP HTTP compression by default. HTTP compression can drastically reduce the amount of data transmitted over the wire which can reduce the time it takes to issue a request. Compression can be enabled by adding the following header to your HTTP request: