Update dashboard

PUT

/rest/api/3/dashboard/{id}

Updates a dashboard, replacing all the dashboard details with those provided.

Permissions required: None

The dashboard to be updated must be owned by the user.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/api/3/dashboard/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "A dashboard to help auditors identify sample of issues to check.",
    "editPermissions": [],
    "name": "Auditors dashboard",
    "sharePermissions": [
        {
            "type": "global"
        }
    ]
}'

Response Example

200 - Success

{"id":"10000","isFavourite":false,"name":"System Dashboard","popularity":1,"self":"https://your-domain.atlassian.net/rest/api/3/dashboard/10000","sharePermissions":[{"type":"global"}],"view":"https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"}

Request

Path Params

Body Params application/json

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

🟠400Returned if the request is not valid.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠404Returned if the dashboard is not found or the dashboard is not owned by the user.

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

Get dashboard

Delete dashboard