SAYMON API belongs to the REpresentational State Transfer (REST) category. This allows you to perform "RESTful" operations like read, modify, add or delete data from your cloud account or on-site installation.
New methods and their description are constantly added here: https://saas.saymon.info/apidoc/
What can I do with the SAYMON API?
Every operation you can perform in SAYMON web interface can be implemented with API, e.g.:
- get list of objects;
- get current state of objects and their state history;
- write data to objects without agents;
- modify properties of objects;
- work with incidents;
- create classes with probes additon;
- and many more.
What API commands are allowed?
SAYMON API has been implemented as JSON over HTTP and allows the following REST Commands:
|GET||Fetch information about existing items|
|POST||Create new items|
|PUT||Update and modify existing items|
|PATCH||Update and modify existing items|
|DELETE||Remove existing items|
What about the access rights?
Your ability to access data or perform actions depends on the permissions available for your SAYMON user account.
Before you start you may wish to learn more about authentication. There are several options described below.
Basic Access Authorization
Pretend your login is login and the password is password. You can use basic auth to get info about your account like this:
Session ID (Cookie)
API Key (API Token)
Pretend your login is login and the password is password:
- login with these credentials to the web-interface of the system;
- click on your login on the top right corner;
- go to Configuration page.
Your API token will be available in the Authorization Link field -. Use it in each request like this: