Update gadget on dashboard

PUT

/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}

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

Permissions required: None.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/api/3/dashboard//gadget/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "color": "red",
    "position": {
        "column": 1,
        "row": 1
    },
    "title": "My new gadget title"
}'

Response Example

204 - Example 1

null

Request

Path Params

dashboardId

integer

required

The ID of the dashboard.

gadgetId

integer

required

The ID of the gadget.

Body Params application/json

The details of the gadget to update.

color

string

write-onlyoptional

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

position

object

write-onlyoptional

The position of the gadget.

The column position of the gadget.

integer <int32>

required

The row position of the gadget.

integer <int32>

required

title

string

write-onlyoptional

The title of the gadget.

Examples

Responses

🟢204Returned if the request is successful.

application/json

Body

No schema defined

🟠400Returned if the request is invalid.

🟠401Returned if the authentication credentials are incorrect.

🟠404Returned if the gadget or the dashboard is not found.

Modified at 2023-07-13 03:27:27

Add gadget to dashboard

Remove gadget from dashboard