Monitor - Control - Automate

Home Knowledgebase Z-Command Backend API/SDK
Z-Command Backend API/SDK

The Z-Command backend exposes a web service. Here is the API

 

  • AbortAddOrResetDevice
    Aborts a device addition or reset operation
  •  

  • ActivateScene
    Activate a scene
  •  

  • AddAssociation
    Associate a device
  •  

  • AddDevice
    Add a new device to the network
  •  

  • AuxCommand
    Special commands
  •  

  • CloneRule
    Clone an existing rule
  •  

  • DeleteRule
  •  

  • DeleteScene
    Delete a scene
  •  

  • DeleteUser
    Delete a user
  •  

  • GetAdminDetail
    Get admin info that includes server password, SMTP details etc
  •  

  • GetAssociations
    Get groups and devices association of a device.
  •  

  • GetConfig
  •  

  • GetDevice
    Queries a device then returns it
  •  

  • GetDevices
    Returns all devices without querying them first
  •  

  • GetDevices2
    Returns all devices without querying them first. Returned devices list can be filtered by device name and location.
  •  

     

  • GetLocation
    Get the device location
  •  

  • GetLog
    Get events log
  •  

  • GetName
    Get the device name
  •  

  • GetPCController
  •  

  • GetPollingInterval
    Gets the polling interval for a device. Use a node ID of 0 to get the global default
  •  

  • GetRules
    Get set rules
  •  

  • GetScenes
    Return available scenes
  •  

  • GetUser
  •  

  • GetUsers
  •  

  • Init
    For Z-Command GX1's use. Executes at boot-up.
  •  

  • QueryBattery
  •  

  • QueryDevice
  •  

  • QueryDeviceInit
    Perform initial query on a device. This will query for battery support and manufacturer name.
  •  

  • ReceiveNetworkInfo
    Receive network information from another controller
  •  

  • RemoveAssociation
    Remove a node ID from device association
  •  

  • RemoveFailedDevice
    Remove failed nodes from the network. This function is not for removing properly functioning nodes
  •  

  • ResetController
  •  

  • ResetDevice
    Reset a device
  •  

  • SendNetworkInfo
    Send network information to another controller
  •  

  • SetConfig
    Save a configuration
  •  

  • SetDeviceLevel
  •  

  • SetLocation
    Set the device location
  •  

  • SetName
    Set the device name
  •  

  • SetNetworkInfo
    Set Network Information
  •  

  • SetPollingInterval
    Sets the polling interval for a device. Use a node ID of 0 to set the global default
  •  

  • SetRule
    Sets a rule.
  •  

  • SetSMTPInfo
    Set SMTP Information
  •  

  • SetScene
    Create or update a scene
  •  

  • SetThermostat
    Set various properties of a thermostat. Set a parameter to null to ignore it
  •  

  • SetUser
  •  

  • SetWakeUpTime
    Set the duration in minutes that a battery-operated device stays awake when it wakes up.
  •