[comment]: # ({935965bf-0cec15ee})
# 29 URL

[comment]: # ({/935965bf-0cec15ee})

[comment]: # ({44743321-103f7d14})
### Description

These parameters and the possible property values for the respective dashboard widget field objects allow to configure
the [*URL*](/manual/web_interface/frontend_sections/dashboards/widgets/url) widget in `dashboard.create` and `dashboard.update` methods.

::: noteimportant
Widget `fields` properties are not validated during the creation or update of a dashboard.
This allows users to modify [built-in widgets](/manual/web_interface/frontend_sections/dashboards/widgets) and create [custom widgets](/devel/modules/tutorials/widget), but also introduces the risk of creating or updating widgets incorrectly.
To ensure the successful creation or update of the *URL* widget, please refer to the parameter behavior outlined in the tables below.
:::

[comment]: # ({/44743321-103f7d14})

[comment]: # ({5944f4ec-df854d95})
### Parameters

The following parameters are supported for the *URL* widget.

|Parameter|[type](/manual/api/reference/dashboard/object#dashboard-widget-field)|name|value|
|-----|-|-----|-------------------|
|*Refresh interval*|0|rf_rate|0 - *(default)* No refresh;<br>10 - 10 seconds;<br>30 - 30 seconds;<br>60 - 1 minute;<br>120 - 2 minutes;<br>600 - 10 minutes;<br>900 - 15 minutes.|
|*URL*|1|url|Valid URL string.<br><br>[Parameter behavior](/manual/api/reference_commentary#parameter-behavior):<br>- *required*|
|*Override host*|1|override_hostid.\_reference|`ABCDE._hostid` - set a [compatible widget](/manual/web_interface/frontend_sections/dashboards/widgets#widget-compatibility) (with its *Reference* parameter set to "`ABCDE`") as the data source for hosts;<br>`DASHBOARD._hostid` - set the dashboard [*Host* selector](/manual/web_interface/frontend_sections/dashboards/widgets#override-host) as the data source for hosts.<br><br>This parameter is not supported if configuring the widget on a [template dashboard](/manual/api/reference/templatedashboard/object).|

[comment]: # ({/5944f4ec-df854d95})

[comment]: # ({b34af70f-44ecbf19})
### 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`](/manual/api/reference/dashboard/create).

[comment]: # ({/b34af70f-44ecbf19})

[comment]: # ({6aa26102-34af51c0})
#### Configuring a *URL* widget

Configure a *URL* widget that displays the home page of Zabbix manual.

[Request](/manual/api#performing-requests):

```json
{
    "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": 36,
                        "height": 5,
                        "view_mode": 0,
                        "fields": [
                            {
                                "type": 1,
                                "name": "url",
                                "value": "https://www.zabbix.com/documentation/7.0/en"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}
```

Response:

```json
{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}
```

[comment]: # ({/6aa26102-34af51c0})

[comment]: # ({e9d30322-c2753f05})
### See also

-   [Dashboard widget field](/manual/api/reference/dashboard/object#dashboard-widget-field)
-   [`dashboard.create`](/manual/api/reference/dashboard/create)
-   [`dashboard.update`](/manual/api/reference/dashboard/update)

[comment]: # ({/e9d30322-c2753f05})