Sidebar
Table of Contents
23 URL
Description
These parameters and the possible property values for the respective dashboard widget field objects allow to configure the URL widget in dashboard.create and dashboard.update methods.
Parameters
The following parameters are supported for the URL widget.
| Parameter | type | name | value |
|---|---|---|---|
| Refresh interval | 0 | rf_rate | 0 - (default) No refresh; 10 - 10 seconds; 30 - 30 seconds; 60 - 1 minute; 120 - 2 minutes; 600 - 10 minutes; 900 - 15 minutes. |
| URL | 1 | url | Valid URL string. Parameter behavior: - required |
| Enable host selection | 0 | dynamic | 0 - (default) Disabled; 1 - Enabled. |
Examples
The following examples aim to only describe the configuration of the dashboard widget field objects for the URL widget. For more information on configuring a dashboard, see dashboard.create.
Configuring a URL widget
Configure a URL widget that displays the home page of Zabbix manual.
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "url",
"name": "URL",
"x": 0,
"y": 0,
"width": 12,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 1,
"name": "url",
"value": "https://www.zabbix.com/documentation/6.4/en"
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}Response: