Pages - Delete

Deletes a wiki page.

DELETE https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path={path}&api-version=5.0
DELETE https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path={path}&comment={comment}&api-version=5.0

URI Parameters

Name In Required Type Description
organization
path True

string

The name of the Azure DevOps organization.

project
path True

string

Project ID or project name

wikiIdentifier
path True

string

Wiki Id or name.

api-version
query True

string

Version of the API to use. This should be set to '5.0' to use this version of the api.

path
query True

string

Wiki page path.

comment
query

string

Comment to be associated with this page delete.

Responses

Name Type Description
200 OK

WikiPage

Page deleted.

Headers

ETag: string

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.wiki_write Grants the ability to read, create and updates wikis, wiki pages and wiki attachments.

Examples

Sample Request

DELETE https://dev.azure.com/fabrikam/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path=/SamplePage129&api-version=5.0

Sample Response

eTag: ""
{
  "path": "/SamplePage129",
  "order": 9,
  "gitItemPath": "/SamplePage129.md",
  "subPages": [],
  "url": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_apis/wiki/wikis/0ede3074-ce9f-4e0e-b9d6-20c23b774e05/pages/SamplePage129",
  "remoteUrl": "https://dev.azure.com/fabrikam/15cbba90-8ac5-450e-934c-16f43021546b/_wiki/wikis/0ede3074-ce9f-4e0e-b9d6-20c23b774e05?pagePath=%2FSamplePage129",
  "content": ""
}

Definitions

WikiPage

Defines a page in a wiki.

Name Type Description
content

string

Content of the wiki page.

gitItemPath

string

Path of the git item corresponding to the wiki page stored in the backing Git repository.

isNonConformant

boolean

True if a page is non-conforming, i.e. 1) if the name doesn't match page naming standards. 2) if the page does not have a valid entry in the appropriate order file.

isParentPage

boolean

True if this page has subpages under its path.

order

integer

Order of the wiki page, relative to other pages in the same hierarchy level.

path

string

Path of the wiki page.

remoteUrl

string

Remote web url to the wiki page.

subPages

WikiPage[]

List of subpages of the current page.

url

string

REST url for this wiki page.