Zabbix Documentation 1.8

2.23.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.43.23.4

User Tools

Site Tools


Sidebar

api:screen:delete

Table of Contents

delete()

Available since version: 1.8
This function allows you to delete information about one or several screens. Screen items will be removed.

Parameters

Array of Screen IDs

Returns

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

Example

Delete screens by screen ID

{
"jsonrpc":"2.0",
"method":"screen.delete",
"params":["107824",  "107825"],
"auth":"3a57200802b24cda67c4e4010b50c065",
"id":2
}

Screens deleted successfully:

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

Screens does not exist:

{
"jsonrpc":"2.0",
"error":{
      "code":-32500,
      "message":"Application error.",
      "data":"[ CScreen::delete ] Screen does not exist"
},
"id":2
}