The FRUITS API allows interaction with FRUITS nodes using HTTP requests to port 8126. Most HTTP requests can use either the GET or POST methods, but some API calls accept only the POST method for security reasons. Responses are returned as JSON objects.

The JSON response fields are each preceded by one of the following: S for ‘string’, A for ‘array’, O for ‘object’, N for ‘number’, or B for ‘boolean’. Note: This is a documentation convention only. These notations are not part of the API responses. In the examples, the FRUITS node is represented as localhost and requests and responses are formatted for easy reading; line breaks and spaces are not used except in some parameter values. All requests are in URL format, which implies the HTTP GET method. When GET is allowed, the URL can be entered into a browser URL field, but proper URL encoding is usually required (e.g., spaces in a parameter value must be replaced by + or %20). Otherwise, the URL should be used as a guide to preparing an HTTP POST request using cURL.

Last updated