Skip to main content

API

Typical API request is SERVER_URL/api?cat=device&action=get_onu_info&param=ZTEGC01234567

API support GET and POST requests

Of cource API support access key (key) what is optional (SERVER_URL/api?cat=device&action=get_onu_info&param=ZTEGC01234567&key=AAAA)

key is optional parametr. Set it in options

Category (cat) - billing

update_region - Create or update region data (If no id or no data in database - new region will created)

  • id = REGION_ID (required)
  • title = REGION_NAME(required)

update_district - Create or update district data (If no id or no data in database - new district will created)

  • id = DISTRICT_ID (required)
  • region_id = REGION_ID (required)
  • title = DISTRICT_NAME(required)

update_city - Create or update city data (If no id or no data in database - new city will created)

  • id = CITY_ID (required)
  • district_id = DISTRICT_ID (required)
  • title = CITY_NAME (required)

update_street - Create or update street data (If no id or no data in database - new street will created)

  • id = STREET_ID (required)
  • city_id = CITY_ID (required)
  • title = STREET_NAME (required)

update_building - Create or update building data (If no id or no data in database - new building will created )

  • id = BUILDING_ID (required)
  • title = BUILDING_NAME (required)
  • street_id = STREET_ID (required)
  • description
  • entrances_count
  • floors_count
  • lat
  • lon

update_user - Create or update user data (If no id or no data in database - new user will created)

  • id = USER_ID (required)
  • building_id
  • login
  • user_name
  • mac (if no param - NULL by default)
  • onu_name (if no param - NULL by default)
  • ip (if no param - NULL by default) 
  • is_business
  • apartment
  • entrance
  • floor
  • money
  • status
  • lat
  • lon
  • address (If no address - it will autogenerated by building_id)
  • deleted_at - (if date in format 2025-01-01 00:00:00 - user will deleted.  If empty - user will recovered. If no argument - no changes)

get_user_id - get user ID by MAC, ONU, login (from build_335)

    param = MAC, ONU, login (required) type = search by type (available login, mac, onu_name). If no type, using search in all section

    Category (cat) - db

    This category get information from database without requests to devices or other services

    Devices

    availability - show list of device and ports with online status (/api?cat=db&action=availability)

    • orderby = 'ip', 'hostname', 'monitoring_is_device_available' 
    • order = 'asc', 'desc'

    device_id_by_hostname - Device ID based on hostname

    • hostname = HOSTNAME(required)
    • type = first_like, first_strict, all_like, all_strict (optional). Default is first_strict

    get_device_coordinates - get information about lat & lon for all devices

    get_device_by_ip - get information about device by IP

    • ip = IP (required)

    get_db_info_by_enterprise - get information about device by IP

    • enterprise = ENTERPRISE (required)

    get_device_list - get device list

    • param = DEVICE_TYPE (use get_device_types_list)

    get_device_list_short - get device list (IP only)

    • param = DEVICE_TYPE (use get_device_types_list)

    get_device_types_list - get devices types

    get_fdb - get FDB table from DB

    • ip = IP (required)

    get_arp_table - get ARP table

    • ip = IP (required)

    get_route_table - get Routing table

    • ip = IP (required)

    get_lldp - get LLDP

    • ip = IP (required)

    get_ip_address_table - get IP Address table

    • ip = IP (required)

    get_onus_counts_on_ifaces - get ONUs count on each PON port

    • ip = IP (required)

    update_device_active_at_date - update device active date

    • ip = IP (required)

    set_onu_field - update any field in ONU (/api?cat=db&action=set_onu_field&onu_name=ZTEGC1123456&field=description&data=DESCRIPTION)

    • onu_name (required)
    • field (required)
    • data (required)

    set_device_field - update any field in device 

    • ip (required)
    • field (required)
    • data (required)

    send_metrics - allow to send metrics from external source like script or so on (default supported types are: ALARM, ALARM MAIN, ALARM PORT, ALARM POWER, ALARM SENSOR,  AMPERAGE, Card CPU, Card CPU, Card Power, Card Power, Card RAM, Card RAM, Card Temp, Card Temp, CPU, CPU, DC_voltage, DC_voltage, Energy,  FAN, HDD Free, HDD Load, Humidity, Power Supply, Power Type, PRINTER PRINTED, RAM Free, RAM Load, RX RADIO, SSID RADIO, Temp, TX RADIO, VOLTAGE.
    For power monitoring: BATTERY_AMPERAGE, BATTERY_ENERGY, BATTERY_VOLTAGE, BATTERY_SOC, GRID_AMPERAGE, GRID_Energy, GRID_FREQUENCY, GRID_VOLTAGE_INPUT, GRID_VOLTAGE_OUTPUT, VOLTAGE_INPUT, VOLTAGE_OUTPUT). From build 316

    • device_id OR ip (required) 
    • metric (required)
    • value (required)

    This section should contain the following keywords: ALARM, AMPERAGE, CPU, DC, ENERGY, FAN, GRID, HDD, HUMIDITY, POWER, PRINTER, RAM , SOC, TEMP, VOLTAGE. This is necessary for correct parsing by the system.
    It is possible to add various prefixes to specify the parameters like FAN_FRONT, FAN_BACK.
    Of course, you can use your own names, but they will be presented exclusively in the digital graph.

    Events

    get_gevent_alarm - get events types (/api?cat=db&action=get_gevent_alarm)

    get_gevents - All active events (/api?cat=db&action=get_gevents)

    • event_type_id = EVENT_TYPE_ID

    get_gevents - Events by type, id and other (/api?cat=db&action=get_gevents&id=109055   /api?cat=db&action=get_gevents&param=onu_name_id&id=126001&history=2)

    • id = EVENT ID or (required)
    • ip = DEVICE IP or (required)
    • param = BY FIELD ("device_id", "port_id", "onu_name_id", "sfp_id", "closed_by_id", "confirmed_by_id", "event_id") - ID (required)

    • history = (2 - active + history, 1 - history, 0 - active)

    • event_type_id

    • show_additional = 1 (show info about device, ONU, SFP, port)
    ONUs

    get_last_registered_onu - get list of last registeref ONUs

    get_unregistered_onu - get info from database about unregistered ONUs

    get_unregistered_onu_scan - get info from database about unregistered ONUs after searching 

    get_unregistered_onu_param - get param for ONU register

    get_unregistered_onu_reg_template - get templates for ONU register

    get_onu_history - get ONUs signal history

    • param = ONU_NAME (required)
    • sub_param1 = DATE_FROM

    get_onu_list_all  - get all ONUs list

    get_onu_list_only - Get ONUs list by param (category)

    • param = 'critical', 'monitoring_enable', 'without_fob', 'without_fob_na', DEVICE_ID

    onu_geo_list - show ONUs with geo coordinates, addresses and user

    • param = 'critical', 'bad-signals'

    get_onu_list_by_ip - get ONUs list on OLT by IP

    • ip = IP (required)

    get_pon_iface_onu_load_by_olt_id - Show PON ports load by ONU on OLT

    • param = DEVICE_ID (required)

    get_pon_iface_onu_load - Show PON ports load by ONU

    • param = 'epon', 'gpon'

    search_onu - Search ONU by name, description, ONU MAC/SN 

    • param - name, description, ONU MAC/SN (required)
    • strict - '1' - strick search. Default 0

    update_onu_fob - update FON/PONBOX in ONU card

    • param = ONU_NAME (required)
    • sub_param1 = FOB (required)

    update_onu_main_info - update additional info about ONU, set monitoting data

    • onu_name = ONU SN/MAC (required)
    • critical_onu - set ONU as critical (available data 0 or 1)
    • monitoring_enable - set ONU to monitoring avaliability (available data 0 or 1)
    • active - set ONU as active (available data 0 or 1)
    • send_notify - set ONU as critical (available data 0 or 1)
    • monitoring_iface_metrics - set ONU as getting traffic (available data 0 or 1)
    • node_id - set node ID as FOB-box and so on (integer, more when 0)
    • building_id - set building ID where ONU is located (integer, more when 0)
    • lon  - geo coordinates
    • lat  - geo coordinates
    • fob_n - FOB-BOX number (as text)
    • description - ONU description (as text)
    SFP

    get_sfp_power_history - get signal historu about SFP

    • param = DEVICE_ID (required)
    • port = PORT_NAME(required)
    • sub_param1 = DATE_FROM
    Users

    get_user_by_onu - get information about user what associated this this ONU (/api?cat=db&action=get_user_by_onu¶m=ZTEGC01234567)

    • param=ONU_NAME (required)

    get_user_by_mac - get information about user what associated this this MAC address (/api?cat=db&action=get_user_by_mac¶m=012345678911)

    • param=MAC (required)

    get_user_by_login - get information about user what associated this this MAC login (/api?cat=db&action=get_user_by_login¶m=user)

    • param=LOGIN (required)

    set_user_geo_by_login - set user geo by login (/api?cat=db&action=set_user_geo_by_login¶m=LOGIN&lat=LAT&lon=LON )

    • param=LOGIN
    • lat=LAT
    • lon=LON
    Other

    backups_device_list - List of devices what support creating backups

    cli_list - Show CLI command alailable on this device

    • ip = IP (required)

    find_mac - where MAC was found

    • param = MAC (required)
    • deleted =0, 1

    find_onu_by_user_mac - on which ONU MAC was found

    • param = MAC (required)

    fdb_device_list - List of devices what support getting FDB

    get_mac_vendor - Get information about vendor by MAC

    • param=MAC (required)

    sfp_device_list - List of devices what support SFP

    Category (cat) - device

    Device backup

    do_backup - get device backup

    • ip = IP (required)

    get_device_list_for_do_backup - get device list for backup

    • ip = IP (required)

    get_remote_backup_file_list - get list of remote backup

    • ip = IP (required)
    Main device

    get_snmp_uptime - Get device uptime

    • ip = IP (required)

    get_snmp_hostname - Get device hostname

    • ip = IP (required)

    get_snmp_description - Get device description

    • ip = IP (required)

    check_available  - Get device availability

    • ip = IP (required)

    check_ip - check device info

    • ip = IP (required)

    device_versions - get device version

    • ip = IP (required)

    get_device_sys_info - get device setem info

    • ip = IP (required)

    get_device_port_status_only  - get device ports statuses

    • ip = IP (required)

    get_device_load - get device CPU, RAM and other

    • ip = IP (required)

    get_sfp_power - get SFP power

    • ip = IP (required)

    get_fdb - get FDB table 

    • ip = IP (required)
    • save = 1, 0

    get_arp_table - get ARP table

    • ip = IP (required)

    get_route_table - get Routing table

    • ip = IP (required)

    get_lldp - get LLDP

    • ip = IP (required)

    get_ip_address_table - get IP Address table

    • ip = IP (required)

     get_vlans - get VLAN list

    • ip = IP (required)

    get_vlans_list_to_db - get VLAN list & save to DB

    • ip = IP (required)

    get_iferror - get errors on port

    • ip = IP (required)
    • save = 1, 0

    check_device_in_db - check if device exist in db

    • ip = IP (required)
    • hostname = HOSTNAME (required)
    • enterprise = ENTERPRISE (required)
    Ports

    get_port_list - get device ports list

    • ip = IP (required)

    get_all_device_ports_states - get device all info port status

    • ip = IP (required)

    get_port_status - Get port info

    • ip= IP (required)
    • port = PORT_NAME (required)

    get_ports - get ports info

    • ip = IP (required)
    • param = PORT_INDEX 
    • sub_param1 = 1, 0 (full or short info)

    get_pon_ports - get PON ports info

    • ip = IP (required)
    • param = PORT_INDEX 
    • sub_param1 = 1, 0 (full or short info)

    get_ports_short  - get ports info short

    • ip = IP (required)
    • param = PORT_INDEX (required)

    get_pon_ports_short - get PON ports info short

    • ip = IP (required)
    • param = PORT_INDEX (required)
    PON/ONU

    get_zte_olt_cards - get information about OLTs card on ZTE, HUAWEI, NOKIA OLTs

    olt_list - get list of OLTs

    • ip = IP (required)
    • param = PORT_NAME

    onu_list_on_olt - List of ONUs on OLT (+ save to DB)

    get_onus_state_on_interface - get states of ONUs on interface(s)

    • ip = IP (required)
    • param = PORT_NAME

    get_onu_monitoring - Check ONU online

    • param = ONU_NAME (required)

    get_onu_info - Get ONU info from OLT

    • param = ONU_NAME (required)

    get_onu_info_offline - Get latest ONU info from database

    • param = ONU_NAME (required)

    get_onu_info_history- Get latest ONU info from database

    • param = ONU_NAME (required)

    get_onu_speed - get ONU current counters data

    • param = ONU_NAME
    • sub_param1 = 1, 0 (show traffic)
    • id = ONU_ID

    Category (cat) - reports

    main_report - generate daily report

    sfp_report - generate SFP problem report

    Category (cat) - system

    ping - PING

    • ip = IP (required)

    nmap - NMAP

    • ip = IP (required)

    traceroute - Traceroute

    • ip = IP (required)

    get_log_type - Get types of logs

    delete_expiration_days - Clean database from old data

    get_notify_list_last  - Get list of notify on last 3 hour

    get_notify_to_do - Get list of unsended messages

    send_notify - Send message from list

    • id = NOTIFY_ID (required)

    Category (cat) - run

    This is command for run work with devices

    run_device_monitoring - Start devices monitoring pollers

    run_port_monitoring - Start ports monitoring pollers

    run_onu_monitoring - Start ONU monitoring pollers

    run_device_discovery - Start device discovering pollers

    run_sfp_power_discovery - Start SFP discovering pollers

    run_onu_discovery - Start ONU discovering pollers

    run_fdb_discovery - Start FDB pollers

    run_device_backups - Start devices backup pollers

    run_onu_signals_discovery - Start device monitoring pollers

    • param = 'critical'

    Category (cat) - 3rdparty

    get_user_list_in_db - Get all users

    get_user_by_id - Get user by id

    • param = USER_ID (required)

    get_user_by_username  - Get user by login

    • param = USER_LOGIN (required)

    get_us_vols_nodes_list_from_us - Get and save commutation from Userside

    ips - Get list of generator and UPS

    notes - Get notes

    • id = NOTE_ID (optional)

    us_commutation - Get info from Grusher (UserSide inported)

    • param = US_NODE_TYPE 

    us_get_vehicle - Get GPS from Userside

    us_vols_list - Get fiber info from Grusher (UserSide imported)

    zabbix_find_freeport - Find free port from Zabbix

    • ip = IP (required)
    Back to top