Dashboards - Delete

Delete a dashboard given its ID. This also deletes the widgets associated with this dashboard.

DELETE https://dev.azure.com/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}?api-version=7.1-preview.3

URI Parameters

Name In Required Type Description
dashboardId
path True

string

uuid

ID of the dashboard to delete.

organization
path True

string

The name of the Azure DevOps organization.

project
path True

string

Project ID or project name

team
path

string

Team ID or team name

api-version
query True

string

Version of the API to use. This should be set to '7.1-preview.3' to use this version of the api.

Responses

Name Type Description
200 OK

successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name Description
vso.dashboards_manage Grants the ability to manage team dashboard information

Examples

Sample request

DELETE https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/dashboard/dashboards/7562562a-4f9f-4258-94a9-b048b1c817cf?api-version=7.1-preview.3

Sample response