DELETE:pages/{pageid}

Overview

public. Deletes a page and optionally descendant pages by moving them to the archive

Message Format

Output:

<deletedpages count="{int}">
    <page id="{int}" href="{uri}">
        <title>{text}</title> 
        <path>{text}</path> 
    </page>
    ...
</deletedpages>

Implementation Notes

When a page is deleted, the page and all files on it are moved into the archive.  A page is never permanently deleted; it will remain in the archive until it is restored (POST:archive/pages/{pageid}/restore).  While a page is in the archive, it cannot be modified.

If the recursive=true query parameter is specified, the page and all its descendants will be deleted.  Otherwise, if the page has descendants, a placeholder parent page will be created for them.

Use GET:pages to retrieve a list of existing pages.

Code Samples

The following code example deletes the page with ID 41:

Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("pages", "41").Delete();

Sample response indicating that the page was successfully deleted:

<deletedpages count="1">
    <page id="41" href="http://deki-hayes/@api/deki/pages/41">
        <title>Page Title</title>
        <path>Page_Title</path>
    </page>
</deletedpages>