Dashboards

Update gadget on dashboard

Changes the title, position, and color of the gadget on a dashboard.

Permissions required: None.

put/rest/api/2/dashboard/{dashboardId}/gadget/{gadgetId}

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/dashboard/{dashboardId}/gadget/{gadgetId}
  • 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)

Path parameters

dashboardIdinteger required

The ID of the dashboard.

gadgetIdinteger required

The ID of the gadget.

Request body

colorstring

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

titlestring

The title of the gadget.

Response

Returned if the request is successful.

unknown required

Changes

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