Skip to main content

site/properties (GET) (TCS)


Retrieve the properties associated with the site

  • REST Method: GET
  • Method Access: public

Query Parameters

Name Type Description
authenticate bool? Force authentication for request (default: false)
redirects int? If zero, do not follow page redirects.
names string? Comma separated list of names of properties to return. The entire value should be URI encoded including the commas. Use '*' at the start or end of a name for wildcard matches. Default: all properties
contentcutoff int? Only show property content shorter than this number of bytes. Default: 2048

Return Codes

Name Value Description
OK 200 The request completed successfully
Bad Request 400 Invalid input parameter
Forbidden 403 ADMIN access is required

Message Format

Response is a list of the standard property xml blocks as well as the language element.

<properties count="{int}" href="{uri}">
 <property name="{text}" href="{uri}" etag="{text}">
  <contents type="{text}" href="{uri}">{text}</contents>
  <user.modified id="{int}" href="{uri}">

Implementation Notes

  • This feature shows the page language. An empty language indicates culture invariant.
  • ADMIN access is required to see site properties

C# Code Sample: Retrieve Site Properties

The following code authenticates and retrieves all site properties:

Sample Code

Plug p = Plug.New("http://devwiki/@api/deki"); 
p.At("users", "authenticate")
 .WithCredentials("sysop", "password").Get(); 
XDoc props = p.At("site", "properties")

Sample Response from executing Code

<properties count="1" href="http://devwiki/@api/deki/site/properties">
  <property name="myprop" href="http://devwiki/@api/deki/site/properties/myprop/info" etag="4465.r2_ts2009-03-20T23:52:50Z">
    <contents type="text/plain" href="http://devwiki/@api/deki/site/properties/myprop">new value for property</contents>
    <user.modified id="1" href="http://devwiki/@api/deki/users/1">
    <change-description>description of change</change-description>

Curl Code Sample: Retrieve Site Properties

The following command retrieves a list of site properties:

Sample Code

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

Sample Response from executing Code

Example output for a site with 1 property:

Content-Type: application/xml

<properties count="1" href="">
  <property name="foo" href="" etag="115.r1_ts2010-02-01T23:49:47Z">
    <contents type="text/plain" size="3" href="">bar</contents>
    <user.modified id="1" href="">

Implementation notes 

curl flags

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


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