Skip to main content

 

MindTouch Success Center

archive/pages (GET)

Overview

Retrieve the pages that can be potentially restored from deletion.

  • REST Method: GET
  • Method Access: public

Query Parameters

Name Type Description
authenticate bool? Force authentication for request (default: false)
limit string? Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100)
offset int? Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)
title string? Show deleted pages matching the given title. (default: all pages)

Return Codes

Name Value Description
OK 200 The request completed successfully
Forbidden 403 Administrator access is required

Message Format

Output:

<pages.archive>
    <page.archive>
        <title>{text}</title> 
        <path>{text}</path> 
        <revisions.archive count="{int}" href="{uri}" /> 
    </page.archive>
    ...
</pages.archive>

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.

C# Code Sample: Retrieve List of Archived Pages

The following code example retrieves a list of pages in the archive:

Sample Code

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

Sample Response from executing Code

<pages.archive>
    <page.archive>
        <title>Page Title</title> 
        <path>Page_Title</path> 
        <revisions.archive count="2" href="http://deki-hayes/@api/deki/archive/pages/=Page_Title/revisions" /> 
    </page.archive>
</pages.archive>

Implementation notes 

Add notes about requirements or config values

Curl Code Sample: Retrieve List of Archived Pages

The following command retrieves a list of all deleted pages:

Sample Code

curl -u admin:password -i http://mindtouch.address/@api/deki/archive/pages

Sample Response from executing Code

Sample response with 129 deleted pages (shows only first archived one, page.archiveID = 588):

<pages.archive querycount="129">
  <page.archive id="588" href="http://192.168.59.128/@api/deki/archive/pages/588/info">
    <title>Test</title>
    <path>Test</path>
    <contents type="application/x.deki0805+xml" href="http://192.168.59.128/@api/deki/archive/pages/588/contents"/>
    <user.deleted id="88" href="http://192.168.59.128/@api/deki/users/88">
      <nick>test6</nick>
      <username>test6</username>
      <email hidden="true"/>
      <hash.email>989d7c3b24422e0f2ab2da41e3a91434</hash.email>
      <uri.gravatar>
http://www.gravatar.com/avatar/989d7c3b24422e0f2ab2da41e3a91434
</uri.gravatar>
    </user.deleted>
    <date.deleted>2010-01-26T22:40:57Z</date.deleted>
    <subpages count="0" href="http://192.168.59.128/@api/deki/archive/pages/588/subpages"/>
  </page.archive>
  <page.archive id="587" href="http://192.168.59.128/@api/deki/archive/pages/587/info">
    <title>Test</title>
    <path>Test</path>
    <contents type="application/x.deki0805+xml" href="http://192.168.59.128/@api/deki/archive/pages/587/contents"/>
    <user.deleted id="1" href="http://192.168.59.128/@api/deki/users/1">
      <nick>Admin</nick>
      <username>Admin</username>
      <email hidden="true"/>
      <hash.email>64e1b8d34f425d19e1ee2ea7236d3028</hash.email>
      <uri.gravatar>
http://www.gravatar.com/avatar/64e1b8d34f425d19e1ee2ea7236d3028
</uri.gravatar>
    </user.deleted>
    <date.deleted>2010-01-26T22:29:59Z</date.deleted>
    <subpages count="0" href="http://192.168.59.128/@api/deki/archive/pages/587/subpages"/>
  </page.archive>
  
  ...

</pages.archive>

Implementation notes 

curl flags

-u
Provides external user authentication.
-i
Outputs the HTTP response headers. Useful for debugging.

Permissions

ADMIN permission is required to execute above command.
  • Was this article helpful?