The SAYMON API is implemented as a RESTful service. It uses standard HTTP methods for requests and returns responses in the JSON format. The API allows you to perform the same operations as you can do using a web interface. For instance, you can get objects' current states and their state history, write data to objects without using agents, work with incidents, create classes, and many others.
The documentation is work in progress. Some articles are still being developed, thus the description for some of them might be incomplete.
How the documentation is organized
The documentation contains a list of all methods available in the SAYMON API. The methods are divided into groups, such as Authentication, Objects, etc. Each group has a description of use cases for its methods. An article covering a particular API method consists of:
The code samples are implemented as self-sufficient as possible. The only parameters you need to provide to make them work are your login credentials and a SAYMON hostname. In some cases, some auxiliary parameters (such as an object or user ID) are required.