Zabbix Documentation 1.8

3.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.22.43.23.4

User Tools

Site Tools


Sidebar

api:screen:update

Table of Contents

update()

Available since version: 1.8
The method is used to control all screen attributes including screen screens.

Parameters

ParameterTypeOptionalDescriptionDetails
screenidstring Screen ID.
screen attributeany Yes New value for a screen attribute.
screenitemsany Yes New screen item list.

Returns

ParameterDescription
resultOperation successful. Result will contain array of updated Screen IDs.
errorIn case of any errors

Example

Set screen name to “New Name”:

  {
   "jsonrpc":"2.0",
   "method":"screen.update",
   "params":{
      "screenid": "100100000010092",
      "name": "New Name"
   },
   "auth":"700ca65537074ec963db7efabda78259",
   "id":2
  }

Retrieved updated screen IDs:

  {
   "jsonrpc":"2.0",
   "result": {
       "screenids":["100100000010092"]
   },
   "id":2
  }