Skip to main content

 

MindTouch Success Center

archive (GET) (TCS)

Overview

Retrieves a summary of available archive information

  • REST Method: GET
  • Method Access: public

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

Output:

<archive>
    <pages.archive href="{uri}" /> 
    <files.archive href="{uri}" /> 
</archive>

Implementation Notes

The archive contains all pages and files that have been deleted.

C# Code Sample: Retrieve Archive Information

The following code example retrieves archive information:

Sample Code

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

Sample Response from executing Code

<archive>
    <pages.archive href="http://deki-hayes/@api/deki/archive/pages" /> 
    <files.archive href="http://deki-hayes/@api/deki/archive/files" /> 
</archive>

Implementation notes 

Add notes about requirements or config values

Curl Code Sample: Retrieve Archive Information

The following command retrieves a summary of available archives:

Sample Code

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

Sample Response from executing Code

<archive>
  <pages.archive href="http://192.168.59.128/@api/deki/archive/pages"/>
  <files.archive href="http://192.168.59.128/@api/deki/archive/files"/>
</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?