Skip to main content
NICE CXone Expert
Expert Success Center

archive/pages/{pageid} (GET)


Retrieve basic page information for the deleted page

  • REST Method: GET
  • Method Access: public

Uri Parameters

Name Type Description
pageid string An integer page ID of a deleted page

Query Parameters

Name Type Description
authenticate bool? Force authentication for request (default: false)

Return Codes

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

Message Format


<page.archive id="{id}" href="{uri}">
  <contents type="{contenttype}" href="{uri}" /> 
  <user.deleted id="{id}" href="{id}">
    <email hidden="{bool}">{text}</email> 

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.

Use GET:archive/pages to retrieve a list of pages currently in the archive.  You can call GET:archive/pages/{pageid}/info and receive the same response.  

C# Code Sample: Retrieve Archived Page Info

The following code example retrieves a summary of all information available for the archived page ID 10168:

Sample Code

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

Sample Response from executing Code

<page.archive id="10168" href="http://deki-hayes/@api/deki/archive/pages/10168/info">
  <contents type="application/x.deki0702+xml" href="http://deki-hayes/@api/deki/archive/pages/10168/contents" /> 
  <user.deleted id="20" href="http://deki-hayes/@api/deki/users/20">
    <email hidden="true" /> 

Implementation notes 

Add notes about requirements or config values

Curl Code Sample: Retrieve Archived Page Info

The following command retrieves information of an archived page with page.archive ID = 1:

Sample Code

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

Sample Response

page.archiveID = 588

<page.archive id="588" href="">
  <contents type="application/x.deki0805+xml" href=""/>
  <user.deleted id="88" href="">
    <email hidden="true"/>

Implementation notes 

curl flags

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


ADMIN permission is required to execute above command.

Archived Pages

To view a list of archived pages, follow the instructions here.
  • Was this article helpful?