Dashboards

Add gadget to dashboard

Adds a gadget to a dashboard.

Permissions required: None.

post/rest/api/2/dashboard/{dashboardId}/gadget

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/dashboard/{dashboardId}/gadget
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: write:jira-work, read:jira-work)

Path parameters

dashboardIdinteger required

The ID of the dashboard.

Request body

colorstring

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

ignoreUriAndModuleKeyValidationboolean

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.

moduleKeystring

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

titlestring

The title of the gadget.

uristring

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

Response

Returned if the request is successful.

color'blue' | 'red' | 'yellow' | 'green' | 'cyan' | 'purple' | 'gray' | 'white' required

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

idinteger required

The ID of the gadget instance.

moduleKeystring

The module key of the gadget type.

titlestring required

The title of the gadget.

uristring

The URI of the gadget type.

Changes

No recorded changes to this operation across all 26 revisions of this API.