SAYMON Wiki

Download

SAYMON Wiki

- Getting started
- Server installation
  - Install SAYMON Server on Oracle VM VirtualBox
- Server configuration
- Connect to server
Monitoring
- SAYMON Agent
  - Install agent
  - Configuration
    - Agent configuration file
    - Agent log files configuration
  - Autodiscovery
  - Update agents
  - Agent metadata
  - Agent update notes
- Web-interface
- Security notes
- Guides
  - Agent
    - Setup TLS for PostgreSQL in the "Database query" probe
    - Change agent registration parameters
  - Alarms
  - Alarm filter
  - Alarm levels
  - Dictionaries
  - Graphs
  - Language
    - Configure available interface languages
  - Links
    - Configure link
  - Monitoring
  - Objects
  - Probes
    - Get file ID in custom probe
  - Properties
  - States
    - Manual state transition
  - State Change Conditions
    - Splash analytics and prediction
  - Users and groups
  - Widgets
  - Connect to host via SSH or Telnet
  - Get system version
- Integrations
- Glossary
- System elements
  - Agent
  - Alarms
  - Alarm Level
  - Audit Log
  - Backings
  - Object classes
  - Dictionary
  - Dictionary group
  - Dictionary for monitoring
  - Dictionary group for monitoring
  - Flow
  - Link
  - Multiparent
  - Notification Template
  - Object
  - Object permissions
  - Operation
  - Password policies
  - Permissions
  - Property
  - Property class
  - Reference
  - State
  - State change conditions
  - States priority and propagation
  - Widgets
    - Button
    - Chart
    - Circle
    - Counter
    - IFrame
    - Level
    - Radial
    - Ring
    - Section
    - Structure
- Extensions
  - Alarms Plus
- Regular Expressions
- REST API
  - Postman Collection
  - General
    - Permissions
    - Response errors
  - Methods
    - Agents
      - Update Agent
      - Update All Agents
    - Authentication
      - Authentication
      - Authentication Token
        
        Create Authentication Token
        
        Delete Authentication Token
      - Session ID
        
        Create Session ID
        
        Delete Session ID
        
        Verify Session ID
    - Bulks
      - Get Bulk Operation Status
      - Run Bulk Operation for Objects
    - Classes
      - State Conditions
        
        Get Class’s State Conditions
        
        Set Class’s State Conditions
        
        Check If Class’s State Conditions Exist
      - Incident Conditions
        
        Get Class’s Incident Conditions
        
        Set Class’s Incident Conditions
      - Create Class
      - Get Class by ID
      - Get All Classes
      - Update Class
      - Delete Class by ID
      - Count Class’s Objects
    - Security
      - Get Security Log
    - Server Configuration
      - Password Policy
        
        Create Password Policy
        
        Get All Password Policies
        
        Update Password Policy
        
        Delete Password Policy
      - Password Log
        
        Get Password Log
        
        Get Password Expiration Time
      - Get All Custom Triggers
      - Get Server Configuration
      - Get All Custom Tasks
      - Update Server Configuration
    - Client Configuration
    - Dictionaries
    - Dictionary groups
    - Dictionaries for monitoring
    - Dictionary groups for monitoring
    - Entities
      - Stat
        
        Get Entity Stat
        
        Set Entity Stat
      - State
        
        Set Entity State
        
        Set Entity’s Manual State
      - Get Entity by ID
      - Get Entity Children
      - Get All Root Entities
    - Event Log
    - Extensions
      - Get All Backend Extensions
    - Files
      - Download saved file
    - Flows
      - Documents
        
        Get Flow’s Document
        
        Add Document to Flow
        
        Delete Flow’s Document
      - Create Flow
      - Get All Flows
      - Update Flow
      - Delete Flow
    - History Annotations
    - Incident Levels
    - Incidents
    - Jobs
    - Limits
      - Get list of blocked requests
    - Links
      - State Conditions
        
        Get Link’s State Conditions
        
        Set Link’s State Conditions
        
        Delete Link’s State Conditions
        
        Check If Link’s State Conditions Exist
      - Config Log
        
        Get Link’s Config Log
        
        Get Link’s Config Log Item
      - State
        
        Get Link’s State Triggers
        
        Set Link’s State Triggers
        
        Set Link’s Manual State
        
        Get Link’s State History
        
        Set Link’s State
      - Stat
        
        Get Link’s Stat
        
        Set Link’s Stat
        
        Get Link’s Stat Metadata
        
        Set Link’s Stat Metadata
        
        Get Link’s Stat Metrics
        
        Get Link’s Metrics History
        
        Get Link’s N Last Metrics
      - Incident Conditions
        
        Set Link’s Incident Conditions
        
        Get Link’s Incident Conditions
        
        Delete Link’s Incident Conditions
      - Documents
        
        Add Document to Link
        
        Get Link’s Document
        
        Delete Link’s Document
      - Create Link
      - Get Link by ID
      - Get All Links
      - Get Link’s Parent Paths
      - Get Link’s Audit Log
      - Update Link
      - Delete Link by ID
    - Metric Tokens
    - MQTT
      - Get All MQTT Subscriptions
    - Notification Templates
    - Objects
    - Operations
      - Entity Operations
        
        Execute Entity Operation
      - Link Operations
        
        Create Link Operation
        
        Update Link Operation
        
        Delete Link Operation
        
        Execute Link Operation
      - Class Operations
        
        Create Class Operation
        
        Update Class Operation
        
        Delete Class Operation
      - Object Operations
        
        Create Object Operation
        
        Update Object Operation
        
        Execute Object Operation
        
        Delete Object Operation
      - Get Operation ID
    - Presets
    - Properties
      - Entity Properties
        
        Get Entity Properties
      - Object Properties
        
        Create Object Property
        
        Get Object Properties
        
        Update Object Property
        
        Delete Object Property
        
        Get Object Children Properties
        
        Set Object’s Monitoring Properties
        
        Test Monitoring Properties
        
        Perform Object’s Monitoring Check
      - Class Properties
        
        Create Class Property
        
        Get Class Properties
        
        Update Class Property
        
        Delete Class Property
      - Flow Properties
        
        Create Flow Property
        
        Get Flow Properties
        
        Update Flow Property
        
        Delete Flow Property
      - Link Properties
        
        Create Link Property
        
        Get Link Properties
        
        Update Link Property
        
        Delete Link Property
        
        Set Link’s Monitoring Properties
        
        Test Monitoring Properties
        
        Perform Link’s Monitoring Check
      - Incident Properties
        
        Set Incident Properties
        
        Delete Incident Properties
    - Property Classes
    - References
    - Reports
    - Scripts
    - Service
    - Stat
      - Get Stat History
      - Get Stat for Several Entities
    - Stat Rules
      - Objects
        
        Get Object Stat Rules
        
        Set Object Stat Rules
      - Links
        
        Get Link Stat Rules
        
        Set Link Stat Rules
    - State History
    - States
    - Tags
      - Create Tag
      - Get All Tags
    - User Groups
    - Users
      - Favorites
        
        Get Favorites
        
        Set Favorites
      - Register User
        
        Confirm Registration
        
        Register User
        
        Generate CAPTCHA
      - Passwords
        
        Change User’s Password
        
        Restore User’s Password
        
        Send Restore Password Email
      - Log
        
        Get Users' Sessions Log
        
        Get User’s Audit Log
      - Create User
      - Get Current User
      - Get User by ID
      - Get All Users
      - Update User
      - Delete User
      - Search Users
    - Variables
      - Render a variable
  - Methods (API v2)
  - Misc
  - Models
    - Backend Extensions
    - Server Configuration
    - Client Configuration
    - Dictionary
    - Event Filter
    - Event Log
    - Flow
    - Favorites
    - History Annotation
    - Incident Condition
    - Alarm levels
    - Incident
    - Incident Comment
    - Job
    - Link
    - Manual State
    - Notification template
    - Object
    - Operation
    - Password Policy
    - Password Log
    - Preset
    - Property
    - Property class
    - Reference
    - Script
    - Security Log
    - Stat
    - Stat Metadata
    - Stat Rule
    - State
    - State Change Condition
    - State Trigger
    - State History
    - Tag
    - User
    - User Group
    - Widget
  - Cookbook
- Socket.IO
  - Entity State
    - State Change Event
  - Client Event
    - Client Notification Event
  - Entity Stat
    - Stat Event
  - Server Events
  - Model Events
    - Model Changed Event
  - Incidents
    - Incidents Event
    - Incident Count Event
  - Error Event
  - Custom Style Change Event
- Release notes

SAYMON Wiki
REST API
Models
Tag

3.18.93 3.17.92 3.16.91

Tag

Tags can be used to search objects with the Search Objects and Run Bulk Operation for Objects requests.

Field

Type

Description

id

String

Tag’s ID.

name

String

Tag’s name.

State History User