Skip to content

SAYMON REST API

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.

Work in Progress

The documentation is a work in progress. Some articles are still being written, so some information in them might be incomplete or missing. These sections are marked with notes like this one.

Documentation Structure

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:

  • method verb (GET, POST, etc);
  • method URL (for example node/api/users/session);
  • method description;
  • method permissions;
  • request parameters;
  • response description.

Also, each article contains request examples in Bash, JavaScript, NodeJS, and Python. To make requests, Bash scripts use cURL, the examples in JavaScript, NodeJS, and Python use the http, fetch, and request libraries accordingly.

The code samples are implemented to be as self-contained as possible. The only parameters you need to provide to make them work are your login credentials and a SAYMON hostname. Some examples require you to provide auxiliary parameters (such as object or user ID).

How to use this documentation

A recommended way to use this documentation is to read about methods' permissions first, then learn Authentication schemes, and after that read articles about particular API methods and their applications.

Info

A convenient way to find a required API method is to use Search in the upper-right corner of this page.

Also, you might find useful an article about response errors. The article contains a description of errors you may encounter while making requests and possible ways to address these errors.