ATatlassian
Experimental

Delete page tree

Moves a pagetree rooted at a page to the space's trash:

  • If the content's type is page and its status is current, it will be trashed including all its descendants.
  • For every other combination of content type and status, this API is not supported.

This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously.

Response example:

<pre><code> { "id" : "1180606", "links" : { "status" : "/rest/api/longtask/1180606" } } </code></pre>

Use the /longtask/<taskId> REST API to get the copy task status.

Permissions required: 'Delete' permission for the space that the content is in.

delete/wiki/rest/api/content/{id}/pageTree

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/wiki/rest/api/content/{id}/pageTree
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: write:confluence-content

Path parameters

idstring required

The ID of the content which forms root of the page tree, to be deleted.

Response

Returned if the request to trash content and all its current page descendants, is successfully accepted.

aristring

the ARI for the long task, based on its ID

idstring required

a unique identifier for the long task

Changes

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