provider Dashboards POST /rest/api/3/dashboard/{dashboardId}/gadget
@utdk/jira /rest/api/3/dashboard/{dashboardId}/gadget
Add gadget to dashboard
Adds a gadget to a dashboard. **[Permissions](#permissions) required:** None.
dashboardId path required
The ID of the dashboard.
integer

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

addgadget
POST/rest/api/3/dashboard/{dashboardId}/gadget
Adds a gadget to a dashboard. **[Permissions](#permissions) required:** None.

Parameters

required

The ID of the dashboard.

Input

The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`.

Whether to ignore the validation of module key and URI. For example, when a gadget is created that is a part of an application that isn't installed.

The module key of the gadget type. Can't be provided with `uri`.

The position of the gadget. When the gadget is placed into the position, other gadgets in the same column are moved down to accommodate it.

The title of the gadget.

The URI of the gadget type. Can't be provided with `moduleKey`.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.addgadget()