POST /rest/api/2/dashboard/{dashboardId}/gadget
Adds a gadget to a dashboard.
Permissions required: None.
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
dashboardId |
Integer | Yes |
The ID of the dashboard. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
uri |
String | No |
The URI of the gadget type. Can't be provided with |
moduleKey |
String | No |
The module key of the gadget type. Can't be provided with |
title |
String | No |
The title of the gadget. |
color |
String | No |
The color of the gadget. Should be one of |
ignoreUriAndModuleKeyValidation |
Boolean | No |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.