MindTouch Core Service

Copyright (c) 2006-2010 MindTouch Inc. (more) (blueprint)

Configuration

• imagemagick-identify-path = string : Path to ImageMagick identify tool
• imagemagick-convert-path = string : Path to ImageMagick converter tool
• deki-resources-path = string? : Path to resources folder (default: "%deki-path%/resources")
• authtoken-salt = string : Private key used to generate unique auth tokens
• admin-db-password = string : Database administrator password.
• admin-db-user = string? : Database administrator user name (default: "root").
• deki-sitename = string? : Site name (default: "MindTouch").
• deki-language = string? : Site language (default: "en-US").
• deki-path = string : Application installation folder
• deki-temp-path = string? : Path for temporary files (default: system default temp folder)
• deki-db-password = string : Password for database user.
• deki-db-user = string? : Database user name (default: wikiuser).
• deki-db-catalog = string? : Database table name (default: wikidb).
• deki-db-port = int? : Database port (default: 3306).
• deki-db-server = string? : Database host name (default: localhost).
• max-image-size = int? : Maximum supported image size in bytes or 0 for no limit (default: 0).
• deki-db-options = string : Optional connection string parameters
• banned-words = string? : Comma separated list of banned words
• deki-signature = string? : Puglic Digital Signature key to verify incoming requests from MindTouch. (default: none)
• apikey = string? : Key to access protected features of the service.
• uri.self = uri : Uri for current service (provided by Host).
• service-license = string? : signed service-license
• uri.log = uri? : Uri for logging service.

Features

DELETE: (private)

Stop service (more)

GET: (public)

Retrieve extension description (more)

GET:$files/{name} (public)

Retrieve file contents (more)

HEAD:$files/{name} (public)

Retrieve file headers (more)

GET:@about (public)

Retrieve service description (more)

GET:@blueprint (public)

Retrieve service blueprint (more)

DELETE:@config (private)

Deinitialize service (more)

GET:@config (private)

Retrieve service configuration (more)

PUT:@config (private)

Initialize service (more)

POST:@grants (internal)

Adds a grant to this service for accessing another service. (more)

GET:archive (public)

Retrieves a summary of available archive information (more)

• authenticate = bool? : Force authentication for request (default: false)

DELETE:archive/files (public)

Removes all files from the archive (wipe) (more)

• authenticate = bool? : Force authentication for request (default: false)

GET:archive/files (public)

Retrieves file info for all deleted files (more)

• authenticate = bool? : Force authentication for request (default: false)

POST:archive/files/restore/{fileid} (public)

Restores a deleted file back to its page (more)

• to = string? : Optional restore-to page to override a removed file's original parent id
• {fileid} = int : identifies a file by ID
• authenticate = bool? : Force authentication for request (default: false)

DELETE:archive/files/{fileid} (public)

Remove a file from the archive (wipe) (more)

• authenticate = bool? : Force authentication for request (default: false)
• {fileid} = int : identifies a file by ID

GET:archive/files/{fileid} (public)

Retrieves file content for a deleted file (more)

• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• authenticate = bool? : Force authentication for request (default: false)

GET:archive/files/{fileid}/info (public)

Retrieves file info for a deleted file (more)

• {fileid} = int : identifies a file by ID
• authenticate = bool? : Force authentication for request (default: false)

GET:archive/files/{fileid}/{filename} (public)

Retrieve file attachment content (more)

• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• authenticate = bool? : Force authentication for request (default: false)

GET:archive/pages (public)

Retrieve the pages that can be potentially restored from deletion. (more)

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

GET:archive/pages/{pageid} (public)

Retrieve basic page information for the deleted page (more)

• authenticate = bool? : Force authentication for request (default: false)
• {pageid} = string : An integer page ID of a deleted page

GET:archive/pages/{pageid}/contents (public)

Retrieve the contents of a deleted page for previewing (more)

• authenticate = bool? : Force authentication for request (default: false)
• {pageid} = string : An integer page ID of a deleted page

GET:archive/pages/{pageid}/info (public)

Retrieve basic page information for the deleted page (more)

• authenticate = bool? : Force authentication for request (default: false)
• {pageid} = string : An integer page ID of a deleted page

POST:archive/pages/{pageid}/restore (public)

Restore all revisions of a given page (more)

• {pageid} = int : An integer page ID from GET: archive/pages
• reason = string? : Reason for reverting
• to = string : new page title
• authenticate = bool? : Force authentication for request (default: false)

GET:archive/pages/{pageid}/subpages (public)

Retrieve the child pages that were deleted as well from deleting the given page (more)

• {pageid} = string : An integer page ID of a deleted page
• authenticate = bool? : Force authentication for request (default: false)

GET:comments/{commentid} (public)

Retrieve a comment and metadata (more)

• {commentnumber} = int? : identifies the comment on the page
• {pageid} = string? : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)
• {commentid} = int? : identifies the comment by its unique id

GET:contextmaps (public)

(more)

• verbose = bool? : return verbose page information (default: false)
• languagesonly = bool? :
• contextid = string? :
• mapped = bool? :
• language = string? :

DELETE:contextmaps/{language}/{id} (public)

(more)

• language = string :
• authenticate = bool? : Force authentication for request (default: false)
• id = string :

GET:contextmaps/{language}/{id} (public)

(more)

• authenticate = bool? : Force authentication for request (default: false)
• verbose = bool? : return verbose information (default: false)
• id = string :
• language = string :

PUT:contextmaps/{language}/{id} (public)

(more)

• language = string :
• authenticate = bool? : Force authentication for request (default: false)
• verbose = bool? : return verbose information (default: false)
• id = string :

GET:contexts (public)

(more)

• description = string? :
• contextid = string? :

POST:contexts (public)

(more)

• authenticate = bool? : Force authentication for request (default: false)

DELETE:contexts/{id} (public)

(more)

• authenticate = bool? : Force authentication for request (default: false)
• id = string :

GET:contexts/{id} (public)

(more)

• authenticate = bool? : Force authentication for request (default: false)
• id = string :

PUT:contexts/{id} (public)

(more)

• id = string :
• authenticate = bool? : Force authentication for request (default: false)

GET:files (public)

Retrieve information for all attached files (more)

• authenticate = bool? : Force authentication for request (default: false)
• skip = int? : Number of files to skip. Default: 0
• numfiles = int? : Number of files to retrieve. 'ALL' for no limit. Default: 100

PROPFIND:files (public)

Lock file (always returns 412 - Precondition Failed) (more)

DELETE:files/{fileid} (public)

Delete file attachment (more)

• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name

GET:files/{fileid} (public)

Retrieve file attachment content (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• size = {original, thumb, webview, bestfit, custom}? : Return a resized image from one of the preset cached sizes. Use 'thumb' or 'webview' to return a smaller scaled image. Use 'bestfit' along with height/width to return one of the known sizes being at least the size given. Default: original
• format = {jpg, png, bmp, gif}? : Convert output to given type. Default is to use original type.
• ratio = {fixed, var}? : Fixed preserves aspect ratio by applying height and width as bounding maximums rather than absolute values. Variable will use the width and height given. Default: fixed
• width = int? : Width of the image
• height = int? : Height of the image
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision

HEAD:files/{fileid} (public)

Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests) (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• size = {original, thumb, webview, bestfit, custom}? : Return a resized image from one of the preset cached sizes. Use 'thumb' or 'webview' to return a smaller scaled image. Use 'bestfit' along with height/width to return one of the known sizes being at least the size given. Default: original
• format = {jpg, png, bmp, gif}? : Convert output to given type. Default is to use original type.
• ratio = {fixed, var}? : Fixed preserves aspect ratio by applying height and width as bounding maximums rather than absolute values. Variable will use the width and height given. Default: fixed
• width = int? : Width of the image
• height = int? : Height of the image
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision

LOCK:files/{fileid} (public)

Lock file (always returns 200, mirroring the request document) (more)

OPTIONS:files/{fileid} (public)

Retrieve available HTTP options (more)

PROPFIND:files/{fileid} (public)

Lock file (always returns 412 - Precondition Failed) (more)

PUT:files/{fileid} (public)

Replace an existing attachment with a new version (more)

• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• {filename} = string : "=" followed by a double uri-encoded file name
• description = string? : file attachment description

UNLOCK:files/{fileid} (public)

Unlock file (always returns 204) (more)

POST:files/{fileid}/copy (public)

Copy an attachment from one page to another and/or change the filename (more)

• {fileid} = int : identifies a file by ID
• authenticate = bool? : Force authentication for request (default: false)
• name = string? : new filename
• to = string? : page id of target page

DELETE:files/{fileid}/description (public)

Reset the file description (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

GET:files/{fileid}/description (public)

retrieves a file description (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

PUT:files/{fileid}/description (public)

Update attachment description (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

POST:files/{fileid}/index (internal)

re-index an attachment (more)

• authenticate = bool? : Force authentication for request (default: false)
• {fileid} = int : identifies a file by ID

GET:files/{fileid}/info (public)

Retrieve file attachment information (more)

• revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• authenticate = bool? : Force authentication for request (default: false)

POST:files/{fileid}/move (public)

Move an attachment from one page to another and/or change the filename (more)

• {fileid} = int : identifies a file by ID
• authenticate = bool? : Force authentication for request (default: false)
• name = string? : new filename
• to = string? : page id of target page

GET:files/{fileid}/properties (public)

Retrieve the properties associated with a file attachment (more)

• 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
• {fileid} = int : identifies a file by ID
• redirects = int? : If zero, do not follow page redirects.
• authenticate = bool? : Force authentication for request (default: false)

POST:files/{fileid}/properties (public)

Create an attachment property (more)

• abort = {never, modified, exists}? : Specifies condition under which to prevent the creation; default is exists.
• authenticate = bool? : Force authentication for request (default: false)
• description = string? : Description of property
• {fileid} = int : identifies a file by ID
• redirects = int? : If zero, do not follow page redirects.

PUT:files/{fileid}/properties (public)

Perform changes on multiple attachment properties (more)

• authenticate = bool? : Force authentication for request (default: false)
• {fileid} = int : identifies a file by ID
• redirects = int? : If zero, do not follow page redirects.

DELETE:files/{fileid}/properties/{key} (public)

Remove an attachment property (more)

• {fileid} = int : identifies a file by ID
• authenticate = bool? : Force authentication for request (default: false)
• {key} = string : A unique identifier for a property that is obtained through GET:files/{fileid}/properties
• redirects = int? : If zero, do not follow page redirects.

GET:files/{fileid}/properties/{key} (public)

Retrieve the content of an attachment property (more)

• authenticate = bool? : Force authentication for request (default: false)
• {key} = string : A unique identifier for a property that is obtained through GET:files/{fileid}/properties
• {fileid} = int : identifies a file by ID
• redirects = int? : If zero, do not follow page redirects.

PUT:files/{fileid}/properties/{key} (public)

Update an existing attachment property (more)

• {key} = string : A unique identifier for a property that is obtained through GET:files/{fileid}/properties
• {fileid} = int : identifies a file by ID
• description = string? : Description of property
• authenticate = bool? : Force authentication for request (default: false)
• abort = {never, modified, exists}? : Specifies condition under which to prevent the update; default is modified.
• redirects = int? : If zero, do not follow page redirects.
• etag = string? : Etag of the current version of the property. Can alternatively be provided via ETag header.

GET:files/{fileid}/properties/{key}/info (public)

Retrieve the metadata about an attachment property (more)

• redirects = int? : If zero, do not follow page redirects.
• authenticate = bool? : Force authentication for request (default: false)
• {key} = string : A unique identifier for a property that is obtained through GET:files/{fileid}/properties
• {fileid} = int : identifies a file by ID
• contentcutoff = int? : Only show property content shorter than this number of bytes. Default: 2048

GET:files/{fileid}/revisions (public)

Retrieve file revision info (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• changefilter = string? : Only show revisions having a user-action listed in this comma delimited list. Valid actions are: CONTENT, NAME, LANGUAGE, META, DELETEFLAG, PARENT (default: all actions)
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

POST:files/{fileid}/revisions (public)

Performs operations such as hide/unhide for revisions of files (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• comment = string? : Reason for hiding revisions
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

DELETE:files/{fileid}/{filename} (public)

Delete file attachment (more)

• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name

GET:files/{fileid}/{filename} (public)

Retrieve file attachment content (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• size = {original, thumb, webview, bestfit, custom}? : Return a resized image from one of the preset cached sizes. Use 'thumb' or 'webview' to return a smaller scaled image. Use 'bestfit' along with height/width to return one of the known sizes being at least the size given. Default: original
• format = {jpg, png, bmp, gif}? : Convert output to given type. Default is to use original type.
• ratio = {fixed, var}? : Fixed preserves aspect ratio by applying height and width as bounding maximums rather than absolute values. Variable will use the width and height given. Default: fixed
• width = int? : Width of the image
• height = int? : Height of the image
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision

HEAD:files/{fileid}/{filename} (public)

Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests) (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• size = {original, thumb, webview, bestfit, custom}? : Return a resized image from one of the preset cached sizes. Use 'thumb' or 'webview' to return a smaller scaled image. Use 'bestfit' along with height/width to return one of the known sizes being at least the size given. Default: original
• format = {jpg, png, bmp, gif}? : Convert output to given type. Default is to use original type.
• ratio = {fixed, var}? : Fixed preserves aspect ratio by applying height and width as bounding maximums rather than absolute values. Variable will use the width and height given. Default: fixed
• width = int? : Width of the image
• height = int? : Height of the image
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision

LOCK:files/{fileid}/{filename} (public)

Lock file (always returns 200, mirroring the request document) (more)

OPTIONS:files/{fileid}/{filename} (public)

Retrieve available HTTP options (more)

PROPFIND:files/{fileid}/{filename} (public)

Lock file (always returns 412 - Precondition Failed) (more)

PUT:files/{fileid}/{filename} (public)

Replace an existing attachment with a new version (more)

• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• {filename} = string : "=" followed by a double uri-encoded file name
• description = string? : file attachment description

UNLOCK:files/{fileid}/{filename} (public)

Unlock file (always returns 204) (more)

GET:groups (public)

Retrieve list of groups. (more)

• limit = string? : Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100)
• sortby = {id, name, role, service}? : Sort field. Prefix value with '-' to sort descending. default: No sorting
• offset = int? : Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)
• authenticate = bool? : Force authentication for request (default: false)
• groupnamefilter = string? : Search for groups by name or part of a name
• authprovider = int? : Return groups belonging to given authentication service id

POST:groups (public)

Add or modify a group (more)

• authenticate = bool? : Force authentication for request (default: false)
• authpassword = string? : Password to use for verification with external authentication service
• authusername = string? : Username to use for verification with external authentication service

DELETE:groups/{groupid} (public)

Remove a group (more)

• authenticate = bool? : Force authentication for request (default: false)
• {groupid} = string : either an integer group ID or "=" followed by a double uri-encoded group name

GET:groups/{groupid} (public)

Retrieve group information (more)

• authenticate = bool? : Force authentication for request (default: false)
• {groupid} = string : either an integer group ID or "=" followed by a double uri-encoded group name

PUT:groups/{groupid} (public)

Modify an existing group (more)

• {groupid} = string : either an integer group ID or "=" followed by a double uri-encoded group name
• authenticate = bool? : Force authentication for request (default: false)

GET:groups/{groupid}/users (public)

Return a list of users in a group (more)

• offset = int? : Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)
• limit = string? : Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100)
• activatedfilter = bool? : Search for users by their active status
• rolefilter = string? : Search for users by a role name
• usernamefilter = string? : Search for users by name or part of a name
• {groupid} = string : either an integer group ID or "=" followed by a double uri-encoded group name
• sortby = {id, username, nick, email, fullname, date.lastlogin, status, role, service}? : Sort field. Prefix value with '-' to sort descending. default: No sorting
• authenticate = bool? : Force authentication for request (default: false)

POST:groups/{groupid}/users (public)

Add members to a group (more)

• authenticate = bool? : Force authentication for request (default: false)
• {groupid} = string : either an integer group ID or "=" followed by a double uri-encoded group name

PUT:groups/{groupid}/users (public)

Set the members for a group (more)

• authenticate = bool? : Force authentication for request (default: false)
• {groupid} = string : either an integer group ID or "=" followed by a double uri-encoded group name

DELETE:groups/{groupid}/users/{userid} (public)

Remove given member from a group (more)

• authenticate = bool? : Force authentication for request (default: false)
• {groupid} = string : either an integer group ID or "=" followed by a double uri-encoded group name
• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name

GET:host (internal)

Get all currently running tenants (more)

POST:host/stop (internal)

Stop the request associate tenant, if running (more)

POST:host/stop/{wikiid} (internal)

Stop the requested tenant, if running (more)

GET:license (public)

Retrieve server license. Requires ADMIN permission to retrieve private information, otherwise only the public information is obtained. (more)

• authenticate = bool? : Force authentication for request (default: false)
• format = string? : Response format for license aggreement (only availble for admins; one of "html", "xml"; default: "xml")

PUT:license (internal)

Update server license. (more)

• authenticate = bool? : Force authentication for request (default: false)

GET:pages (public)

Builds a site map starting from 'home' page. (more)

• authenticate = bool? : Force authentication for request (default: false)
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• startpage = bool? : For HTML sitemap, indicates if the start page should be included (default: true)
• format = {xml, html, google}? : Result format (default: xml)
• language = string? : Filter results by language (default: all languages)

GET:pages/popular (public)

Retrieves a list of popular pages. (more)

• limit = string? : Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 50)
• authenticate = bool? : Force authentication for request (default: false)
• language = string? : Filter results by language (default: all languages)
• offset = int? : Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)

DELETE:pages/{pageid} (public)

Deletes a page and optionally descendant pages by moving them to the archive (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• recursive = bool? : only delete page or delete page and descendants. Default: false
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

GET:pages/{pageid} (public)

Retrieve aggregate page information including attachments (more)

• revision = string? : Page revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision
• format = {html, xhtml}? : Result format (default: html)
• mode = {edit, raw, view} : render content for different uses; default is 'view'
• include = string? : Extra elements to include (choice of "contents"; default: include nothing extra)
• exclude = string? : Elements to exclude from response document (choice of "inbound", "outbound"; default: exclude nothing)
• redirects = int? : If zero, do not follow page redirects.
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)

GET:pages/{pageid}/aliases (public)

Retrieve list of page aliases (more)

• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.

POST:pages/{pageid}/allowed (public)

Filter a list of user ids based on access to the page (more)

• filterdisabled = bool? : DEPRECATED: Will always filter disabled users, regardless of permissions
• permissions = string? : A comma separated list of permissions that must be satisfied (e.g read, etc.). Defaults to read, if not provided
• {pageid} = int : integer page ID

GET:pages/{pageid}/comments (public)

Retrieve the comments on a page (more)

• depth = string? : Use 'infinity' to return comments from all descendant pages. (default: 0)
• sortby = {date.posted}? : Sort field. Prefix value with '-' to sort descending. (default: date.posted)
• offset = int? : Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)
• limit = string? : Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100)
• filter = string? : Comments to return: any, nondeleted. default: nondeleted
• format = {xml, atom}? : Output format (default: xml).
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• postedbyuserid = int? : Only return comments posted by the id of a user
• authenticate = bool? : Force authentication for request (default: false)

POST:pages/{pageid}/comments (public)

Post a new comment to a page (more)

• authenticate = bool? : Force authentication for request (default: false)
• title = string? : Title for comment
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

DELETE:pages/{pageid}/comments/{commentnumber} (public)

Mark a comment as being deleted. This hides comment content from non admins (more)

• authenticate = bool? : Force authentication for request (default: false)
• {commentnumber} = int : identifies the comment on the page
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

GET:pages/{pageid}/comments/{commentnumber} (public)

Retrieve a comment and metadata (more)

• {commentnumber} = int? : identifies the comment on the page
• {pageid} = string? : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)
• {commentid} = int? : identifies the comment by its unique id

GET:pages/{pageid}/comments/{commentnumber}/content (public)

Retrieve the comment text only (more)

• authenticate = bool? : Force authentication for request (default: false)
• {commentnumber} = int : identifies the comment on the page
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

PUT:pages/{pageid}/comments/{commentnumber}/content (public)

Edit the specified comment (more)

• authenticate = bool? : Force authentication for request (default: false)
• {commentnumber} = int : identifies the comment on the page
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

GET:pages/{pageid}/contents (public)

Retrieve the contents of a page. (more)

• pageid = int? : For template pages, use specified page ID as context for template invocation (default: none)
• include = bool? : Treat page as an include (default: false)
• section = int? : The section number (default: none)
• format = {html, xhtml}? : Result format (default: html)
• highlight = string? : Comma separated list of terms to highlight (default: empty)
• mode = {edit, raw, view} : render content for different uses; default is 'view'
• redirects = int? : If zero, do not follow page redirects.
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)
• revision = string? : Page revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision
• relto = int? : Page used for path normalization (default: none)
• reltopath = string? : Page used for path normalization. Ignored if relto parameter is defined. (default: none)

POST:pages/{pageid}/contents (public)

Update contents of a page (more)

• overwrite = bool? : New page revision is created when no changes are detected when overwrite is true (default: false)
• reltopath = string? : Page used for path normalization. Ignored if relto parameter is defined. (default: none)
• relto = int? : Page used for path normalization (default: none)
• tidy = {remove, convert}? : Determines if invalid content is converted to text or removed (default: 'convert')
• redirects = int? : If zero, do not follow page redirects.
• abort = {never, modified, exists}? : specifies condition under which to prevent the save; default is never
• xpath = string? : identifies the portion of the page to update; this parameter is ignored if section is specified
• section = int? : the section number. If zero, append as a new section
• title = string? : the display title (default: use existing title or determine from page path.)
• language = string? : the page language (default: determine culture from parent)
• comment = string? : the edit comment
• edittime = string : the previous revision's edit timestamp (yyyyMMddHHmmss or yyyy-MM-ddTHH:mm:ssZ) or "now" to bypass concurrent edit check
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• restriction = string? : Optionally set the restriction of the page
• importtime = string? : If this is an import, the edit timestamp of the imported content (yyyyMMddHHmmss or yyyy-MM-ddTHH:mm:ssZ)
• authenticate = bool? : Force authentication for request (default: false)

GET:pages/{pageid}/contents/explain (public)

Explain how contents of a page are rendered. (more)

• pageid = int? : For template pages, use specified page ID as context for template invocation (default: none)
• include = bool? : Treat page as an include (default: false)
• section = int? : The section number (default: none)
• format = {html, xhtml}? : Result format (default: html)
• highlight = string? : Comma separated list of terms to highlight (default: empty)
• mode = {edit, raw, view} : render content for different uses; default is 'view'
• redirects = int? : If zero, do not follow page redirects.
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)
• revision = string? : Page revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision
• relto = int? : Page used for path normalization (default: none)
• reltopath = string? : Page used for path normalization. Ignored if relto parameter is defined. (default: none)

POST:pages/{pageid}/copy (public)

Copy page to a new location (more)

• children = bool? : Copy child pages? (default: false)
• talkpages = bool? : Copy talk pages? (default: true)
• attachments = bool? : Copy attachments? (default: true)
• tags = bool? : Copy tags? (default: true)
• authenticate = bool? : Force authentication for request (default: false)
• title = string? : Set the title of the page. (default: same as original title)
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• to = string : new page location including the path and name of the page

GET:pages/{pageid}/diff (public)

Show changes between revisions (more)

• mode = {edit, raw, view}? : which rendering mode to use when diffing; default is 'edit'
• diff = {combined, all}? : Result format; 'combined' shows changes to the page contents, 'all' shows in addition the before and after versions of the page with highlighted changes; default is 'combined'
• revision = string? : Page revision to retrieve. 'head' by default will retrieve latest revision. Positive integer will retrieve specific revision
• redirects = int? : If zero, do not follow page redirects.
• previous = string? : Previous page revision to retrieve. 'head' by default will retrieve latest revision. Positive integer will retrieve specific revision
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• format = {html, xhtml}? : Result format (default: html)
• authenticate = bool? : Force authentication for request (default: false)

POST:pages/{pageid}/export (public)

Generates the information so that clients can stream down the exported page(s) in mtarc format (more)

• pageid = int : The pageid for the page that you want to export

GET:pages/{pageid}/export/{token} (public)

Retrieve the mtarc tree export for the specific page using the token (more)

• recursive = bool? : Used to indicate if we export the full tree under the provided pageid
• relto = int? : Export relative to page id
• reltopath = string? : Export relative to uri path
• dryrun = bool? : Used to indicate that a simulated run will be done. Default is false
• token = string : A token that specifies the location of the page that we want to export
• pageid = int : The page's id

GET:pages/{pageid}/export/{token}/{filename} (public)

Retrieve the mtarc tree export for the specific page using the token and providing an optional filename for the file to download. (more)

• recursive = bool? : Used to indicate if we export the full tree under the provided pageid
• relto = int? : Export relative to page id
• reltopath = string? : Export relative to uri path
• dryrun = bool? : Used to indicate that a simulated run will be done. Default is false
• token = string : A token that specifies the location of the page that we want to export
• pageid = int : The page's id

GET:pages/{pageid}/feed (public)

Retrieve feed of page changes (more)

• depth = string? : How deep into the sub-tree changes should be included. 0 for the current page only, 'infinity' for entire sub-tree (default: 0)
• format = {all, daily, raw, rawdaily}? : Format for feed (default: daily)
• offset = int? : Skipped changes (default: 0)
• limit = int? : Number of changes to retrieve (default: 100)
• since = string? : Start date for changes. Date is provided in 'yyyyMMddHHmmss' format (default: ignored).
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• timezone = string? : Optionally indicate a timezone so that the news feed displays the messages with the timestamp adjusted to the preferred timezone (e.g. -09:00, the default is empty)
• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• filter = string? : use "new" to include only newly created pages in the feed (default: all)

GET:pages/{pageid}/feed/new (public)

Retrieve feed of new page creations (more)

• depth = string? : How deep into the sub-tree changes should be included. 0 for the current page only, 'infinity' for entire sub-tree (default: 0)
• format = {all, daily, raw, rawdaily}? : Format for feed (default: daily)
• offset = int? : Skipped changes (default: 0)
• limit = int? : Number of changes to retrieve (default: 100)
• since = string? : Start date for changes. Date is provided in 'yyyyMMddHHmmss' format (default: ignored).
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• timezone = string? : Optionally indicate a timezone so that the news feed displays the messages with the timestamp adjusted to the preferred timezone (e.g. -09:00, the default is empty)
• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• filter = string? : use "new" to include only newly created pages in the feed (default: all)

GET:pages/{pageid}/files (public)

Retrieves a list of files for a given page (more)

• redirects = int? : If zero, do not follow page redirects.
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)

GET:pages/{pageid}/files,subpages (public)

Retrieves a list of files and subpages for a given page (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

DELETE:pages/{pageid}/files/{filename} (public)

Delete file attachment (more)

• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name

GET:pages/{pageid}/files/{filename} (public)

Retrieve file attachment content (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• size = {original, thumb, webview, bestfit, custom}? : Return a resized image from one of the preset cached sizes. Use 'thumb' or 'webview' to return a smaller scaled image. Use 'bestfit' along with height/width to return one of the known sizes being at least the size given. Default: original
• format = {jpg, png, bmp, gif}? : Convert output to given type. Default is to use original type.
• ratio = {fixed, var}? : Fixed preserves aspect ratio by applying height and width as bounding maximums rather than absolute values. Variable will use the width and height given. Default: fixed
• width = int? : Width of the image
• height = int? : Height of the image
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision

HEAD:pages/{pageid}/files/{filename} (public)

Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests) (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• size = {original, thumb, webview, bestfit, custom}? : Return a resized image from one of the preset cached sizes. Use 'thumb' or 'webview' to return a smaller scaled image. Use 'bestfit' along with height/width to return one of the known sizes being at least the size given. Default: original
• format = {jpg, png, bmp, gif}? : Convert output to given type. Default is to use original type.
• ratio = {fixed, var}? : Fixed preserves aspect ratio by applying height and width as bounding maximums rather than absolute values. Variable will use the width and height given. Default: fixed
• width = int? : Width of the image
• height = int? : Height of the image
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision

LOCK:pages/{pageid}/files/{filename} (public)

Lock file (always returns 200, mirroring the request document) (more)

OPTIONS:pages/{pageid}/files/{filename} (public)

Retrieve available HTTP options (more)

PROPFIND:pages/{pageid}/files/{filename} (public)

Lock file (always returns 412 - Precondition Failed) (more)

PUT:pages/{pageid}/files/{filename} (public)

Replace an existing attachment with a new version or create a new attachment (more)

• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• {filename} = string : "=" followed by a double uri-encoded file name
• description = string? : file attachment description

UNLOCK:pages/{pageid}/files/{filename} (public)

Unlock file (always returns 204) (more)

DELETE:pages/{pageid}/files/{filename}/description (public)

Reset the file description (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

GET:pages/{pageid}/files/{filename}/description (public)

retrieves a file description (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

PUT:pages/{pageid}/files/{filename}/description (public)

Update attachment description (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

GET:pages/{pageid}/files/{filename}/info (public)

Retrieve file attachment information (more)

• revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• authenticate = bool? : Force authentication for request (default: false)

PUT:pages/{pageid}/files/{filename}/properties/{key} (public)

Update an existing attachment property (more)

• {key} = string : A unique identifier for a property that is obtained through GET:files/{fileid}/properties
• {fileid} = int : identifies a file by ID
• description = string? : Description of property
• authenticate = bool? : Force authentication for request (default: false)
• abort = {never, modified, exists}? : Specifies condition under which to prevent the update; default is modified.
• redirects = int? : If zero, do not follow page redirects.
• etag = string? : Etag of the current version of the property. Can alternatively be provided via ETag header.

GET:pages/{pageid}/files/{filename}/revisions (public)

Retrieve file revision info (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• changefilter = string? : Only show revisions having a user-action listed in this comma delimited list. Valid actions are: CONTENT, NAME, LANGUAGE, META, DELETEFLAG, PARENT (default: all actions)
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

POST:pages/{pageid}/files/{filename}/revisions (public)

Performs operations such as hide/unhide for revisions of files (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
• comment = string? : Reason for hiding revisions
• {fileid} = int : identifies a file by ID
• {filename} = string : "=" followed by a double uri-encoded file name
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

PUT:pages/{pageid}/import (public)

Import a tree of pages (mtarc format) into an instance at pageid as the root (more)

• behavior = string : Specify the semantics of the call between blocking and non-blocking. Valid values are sync and async, default value is sync.
• filename = string : The name of the file being uploaded
• pageid = int : The page's id of the page that we want to use as the root of the import

GET:pages/{pageid}/import/status/{token} (public)

Poll the status of an import identified by token into pageid (more)

• {token} = string : A token returned as part of the url that PUT:pages/{pageid}/import returns
• {pageid} = int : A page's id

POST:pages/{pageid}/index (internal)

re-index a page and it's attributes (more)

• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.

GET:pages/{pageid}/info (public)

Retrieve page information (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

GET:pages/{pageid}/links (public)

Retrieve list of inbound or outbound page links (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• dir = {from, to} : links pointing to a page or from a page
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

POST:pages/{pageid}/message/*//* (public)

Post a custom page event into the pubsub bus (limited to 128KB) (more)

• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

POST:pages/{pageid}/move (public)

Move page to a new location (more)

• redirects = int? : If zero, do not follow page redirects.
• authenticate = bool? : Force authentication for request (default: false)
• parentid = int? : Relocate the page under a given parent page
• name = string? : Move the page to the given name while keeping it under the same parent page
• to = string? : new page location including the path and name of the page
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• title = string? : Set the title of the page. The name of a page is also modified unless it's provided

GET:pages/{pageid}/pdf (public)

Export a page to PDF (more)

• authenticate = bool? : Force authentication for request (default: false)
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• showtoc = bool : flag to display a table of contents in the exported document
• sytlesheet = string : name of custom stylesheet to apply (stored in site/properties with namespace 'mindtouch.prince.stylesheet#
• format = string : format to export: pdf | html (default: pdf)
• deep = bool : flag to export the requested page and all subpages (default: false)

GET:pages/{pageid}/properties (public)

Retrieve the properties associated with a page (more)

• 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
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• contentcutoff = int? : Only show property content shorter than this number of bytes. Default: 2048

POST:pages/{pageid}/properties (public)

Create a page property (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• description = string? : Description of property
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• abort = {never, modified, exists}? : Specifies condition under which to prevent the creation; default is exists.

PUT:pages/{pageid}/properties (public)

Perform changes on multiple page properties (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

DELETE:pages/{pageid}/properties/{key} (public)

Remove a page property (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• {key} = string : A unique identifier for a property that is obtained through GET:pages/{pageid}/properties
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

GET:pages/{pageid}/properties/{key} (public)

Retrieve the content of a page property (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• {key} = string : A unique identifier for a property that is obtained through GET:pages/{pageid}/properties
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

PUT:pages/{pageid}/properties/{key} (public)

Update an existing page property (more)

• abort = {never, modified, exists}? : Specifies condition under which to prevent the update; default is modified.
• redirects = int? : If zero, do not follow page redirects.
• etag = string? : Etag of the current version of the property. Can alternatively be provided via ETag header.
• description = string? : Description of property
• authenticate = bool? : Force authentication for request (default: false)
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• {key} = string : A unique identifier for a property that is obtained through GET:pages/{pageid}/properties

GET:pages/{pageid}/properties/{key}/info (public)

Retrieve the metadata about a page property (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• contentcutoff = int? : Only show property content shorter than this number of bytes. Default: 2048
• {key} = string : A unique identifier for a property that is obtained through GET:pages/{pageid}/properties
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

GET:pages/{pageid}/ratings (public)

Retrieve the page rating (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.

POST:pages/{pageid}/ratings (public)

Rate the quality of a page (more)

• redirects = int? : If zero, do not follow page redirects.
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)
• score = int : A '0' or '1' respectively indicating a poor or good rating. A value of '' will reset a rating.

POST:pages/{pageid}/revert (public)

Revert page to an earlier revision (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• fromrevision = int : Revision number of page that will become the new head revision

GET:pages/{pageid}/revisions (public)

Retrieve revision history of a given title (more)

• revision = int? : Page revision to retrieve
• redirects = int? : If zero, do not follow page redirects.
• offset = int? : Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• limit = string? : Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 50)
• authenticate = bool? : Force authentication for request (default: false)

POST:pages/{pageid}/revisions (public)

Performs operations such as hide/unhide for revisions of pages (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• comment = string? : Reason for hiding revisions
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

DELETE:pages/{pageid}/security (public)

Reset page restricts and grants (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

GET:pages/{pageid}/security (public)

Retrieve page security info (more)

• authenticate = bool? : Force authentication for request (default: false)
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• redirects = int? : If zero, do not follow page redirects.

POST:pages/{pageid}/security (public)

Modify page security by adding and removing grants (more)

• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• cascade = {none, delta} : Apply proposed security to child pages. default: none
• redirects = int? : If zero, do not follow page redirects.
• authenticate = bool? : Force authentication for request (default: false)

PUT:pages/{pageid}/security (public)

Set page security info (more)

• redirects = int? : If zero, do not follow page redirects.
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)
• cascade = {none,delta,absolute}? : none: Permissions are not cascaded to child pages; deltas: Changes between given page's security and proposed security cascaded to child nodes; absolute: Proposed security is set on child pages. Default: none

GET:pages/{pageid}/subpages (public)

Retrieve list of sub-pages (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• offset = int? : Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)
• limit = string? : Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100)
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

GET:pages/{pageid}/tags (public)

Retrieve the tags on a page. (more)

• redirects = int? : If zero, do not follow page redirects.
• authenticate = bool? : Force authentication for request (default: false)
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

PUT:pages/{pageid}/tags (public)

Sets the tags on a page. (more)

• redirects = int? : If zero, do not follow page redirects.
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)

GET:pages/{pageid}/tree (public)

Builds a site map starting from a given page. (more)

• authenticate = bool? : Force authentication for request (default: false)
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• startpage = bool? : For HTML sitemap, indicates if the start page should be included (default: true)
• format = {xml, html, google}? : Result format (default: xml)
• language = string? : Filter results by language (default: all languages)

GET:site/activity (public)

Retrieve report on site activities (more)

• since = string? : Start date for report. Date is provided in 'yyyyMMddHHmmss' format (default: last 14 days).
• authenticate = bool? : Force authentication for request (default: false)

GET:site/bans (public)

Get a list of all IP and user bans (more)

• authenticate = bool? : Force authentication for request (default: false)

POST:site/bans (public)

Create a ban entry (more)

• authenticate = bool? : Force authentication for request (default: false)

DELETE:site/bans/{banid} (public)

Remove a ban entry (more)

• {banid} = int : Identifies a ban by ID
• authenticate = bool? : Force authentication for request (default: false)

GET:site/bans/{banid} (public)

See a specific ban entry (more)

• {banid} = int : Identifies a ban by ID
• authenticate = bool? : Force authentication for request (default: false)

POST:site/export (public)

Generates export information (more)

• relto = int? : Page used for path normalization (default: home page)
• reltopath = string? : Page used for path normalization. Ignored if relto parameter is defined.

GET:site/feed (public)

Retrieve feed of site changes (more)

• filter = string? : use "new" to include only newly created pages in the feed (default: all)
• namespace = string? : Filter results by namespace (default: all namespace)
• language = string? : Filter results by language (default: all languages)
• format = {all, daily, raw, rawdaily}? : Format for feed (default: daily)
• offset = int? : Skipped changes (default: 0)
• limit = int? : Number of changes to retrieve (default: 100)
• since = string? : Start date for changes. Date is provided in 'yyyyMMddHHmmss' format (default: ignored).
• authenticate = bool? : Force authentication for request (default: false)

GET:site/feed/new (public)

Retrieve feed of new page creations (more)

• filter = string? : use "new" to include only newly created pages in the feed (default: all)
• namespace = string? : Filter results by namespace (default: all namespace)
• language = string? : Filter results by language (default: all languages)
• format = {all, daily, raw, rawdaily}? : Format for feed (default: daily)
• offset = int? : Skipped changes (default: 0)
• limit = int? : Number of changes to retrieve (default: 100)
• since = string? : Start date for changes. Date is provided in 'yyyyMMddHHmmss' format (default: ignored).
• authenticate = bool? : Force authentication for request (default: false)

POST:site/feedback (public)

Logged in users can submit feedback to a site owner unless a feedback email is defined. (more)

GET:site/functions (public)

Get list of available extensions (more)

• authenticate = bool? : Force authentication for request (default: false)
• format = {html, body, xml}? : output format (default: html)

POST:site/import (public)

Generates import information (more)

• reltopath = string? : Page used for path normalization. Ignored if relto parameter is defined.
• relto = int? : Page used for path normalization (default: home page)
• forceoverwrite = bool? : Force overwrite of destination, even if import content is older.

GET:site/localization (public)

Retrieve a resource string localized for the current user, or provided culture (more)

• resource = string : resource name to retrieve
• lang = string? : Optional language code to use for resource localization

DELETE:site/logo (internal)

Remove the site logo (more)

• authenticate = bool? : Force authentication for request (default: false)

GET:site/logo (public)

Retrieve the site logo image (more)

• authenticate = bool? : Force authentication for request (default: false)
• default = string? : Absolute uri for default image

PUT:site/logo (internal)

Save a new site logo image (more)

• authenticate = bool? : Force authentication for request (default: false)

DELETE:site/logo.png (internal)

Remove the site logo (more)

• authenticate = bool? : Force authentication for request (default: false)

GET:site/logo.png (public)

Retrieve the site logo image (more)

• authenticate = bool? : Force authentication for request (default: false)
• default = string? : Absolute uri for default image

PUT:site/logo.png (internal)

Save a new site logo image (more)

• authenticate = bool? : Force authentication for request (default: false)

GET:site/nav/{pageid}/children (public)

Retrieve <div> tags for the sub-pages of the given page. (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• type = {compact, expandable}? : Navigation type (default: compact).
• format = {debug, xml, html}? : Output format (default: html).
• width = int? : Max width for visible text
• exclude = int? : Page to exclude from result set.
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

GET:site/nav/{pageid}/children,siblings (public)

Retrieve <div> tags for the sub-pages and sibling pages of the given page. (more)

• width = int? : Max width for visible text
• exclude = int? : Page to exclude from result set.
• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• format = {debug, xml, html}? : Output format (default: html).
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

GET:site/nav/{pageid}/full (public)

Retrieve <div> tags of the full navigation tree for the given page. (more)

• redirects = int? : If zero, do not follow page redirects.
• type = {compact, expandable}? : Navigation type (default: compact).
• format = {debug, xml, html}? : Output format (default: html).
• width = int? : Max width for visible text
• authenticate = bool? : Force authentication for request (default: false)
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title

GET:site/nav/{pageid}/siblings (public)

Retrieve <div> tags for sibling pages of the given page. (more)

• redirects = int? : If zero, do not follow page redirects.
• format = {debug, xml, html}? : Output format (default: html).
• width = int? : Max width for visible text
• {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
• authenticate = bool? : Force authentication for request (default: false)

GET:site/opensearch (public)

Search the site index (more)

• authenticate = bool? : Force authentication for request (default: false)
• nocache = bool? : Use caching search path (better for paging results) (default: false)
• parser = {bestguess|term|filename|lucene}? : The parser to use for the query (default: bestguess)
• constraint = string? : Additional search constraint (ex: language:en-us AND type:wiki) default: none
• sortby = {score, title, date, size, wordcount, rating.score, rating.count}? : Sort field. Prefix value with '-' to sort descending. default: -score
• offset = int? : Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)
• format = {rss | atom}? : search output format (rss | atom) default: atom
• q = string : lucene search string
• limit = string? : Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100)

GET:site/opensearch/description (public)

Get the OpenSearch Description document (more)

• authenticate = bool? : Force authentication for request (default: false)

GET:site/opensearch/suggestions (public)

Search the site index (more)

• authenticate = bool? : Force authentication for request (default: false)
• constraint = string? : Additional search constraint (ex: language:en-us AND type:wiki) default: none
• sortby = {score, title, date, size, wordcount, rating.score, rating.count}? : Sort field. Prefix value with '-' to sort descending. default: -score
• q = string : lucene search string

GET:site/operations (public)

Retrieve all known security operations (more)

• authenticate = bool? : Force authentication for request (default: false)

GET:site/properties (public)

Retrieve the properties associated with the site (more)

• contentcutoff = int? : Only show property content shorter than this number of bytes. Default: 2048
• 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
• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.

POST:site/properties (public)

Create a site property (more)

• description = string? : Description of property
• redirects = int? : If zero, do not follow page redirects.
• abort = {never, modified, exists}? : Specifies condition under which to prevent the creation; default is exists.
• authenticate = bool? : Force authentication for request (default: false)

PUT:site/properties (public)

Perform changes on multiple site properties (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.

DELETE:site/properties/{key} (public)

Remove a site property (more)

• redirects = int? : If zero, do not follow page redirects.
• authenticate = bool? : Force authentication for request (default: false)
• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
• {key} = string : A unique identifier for a property that is obtained through GET:site/properties

GET:site/properties/{key} (public)

Retrieve the content of a site property (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• {key} = string : A unique identifier for a property that is obtained through GET:site/properties

PUT:site/properties/{key} (public)

Update an existing site property (more)

• abort = {never, modified, exists}? : Specifies condition under which to prevent the update; default is modified.
• {key} = string : A unique identifier for a property that is obtained through GET:site/properties
• etag = string? : Etag of the current version of the property. Can alternatively be provided via ETag header.
• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• description = string? : Description of property

GET:site/properties/{key}/info (public)

Retrieve the metadata about a site property (more)

• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• contentcutoff = int? : Only show property content shorter than this number of bytes. Default: 2048
• {key} = string : A unique identifier for a property that is obtained through GET:site/properties

GET:site/query (public)

Search the site index with analytical tracking. Primarily for user facing search. (more)

• q = string : lucene search string
• notrack = bool? : Disable analytics query tracking (default: false)
• authenticate = bool? : Force authentication for request (default: false)
• explain = bool? : Include ranking details (default: false)
• constraint = string? : Additional search constraints (ex: language:en-us AND type:wiki) default: none
• sortby = {rank, title, modified}? : Sort field. Prefix value with '-' to sort descending. (default: -rank)
• offset = int? : Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)
• limit = int? : Maximum number of items to retrieve. Must be a positive number (default: 25)
• previousqueryid = ulong? : Query tracking id of previous query, if this is a follow-up query
• parser = {bestguess|term|lucene}? : The parser to use for the query (default: bestguess)
• queryid = ulong? : Query tracking id returned by original query result (used for paging/changing sort order)

GET:site/query/log (internal)

Get tracked search data. (more)

• offset = int? : Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)
• limit = int? : Maximum number of items to retrieve. Must be a positive number (default: 25)
• before = string? : End date for result set. Date is provided in 'yyyyMMddHHmmss' format (default: now).
• lowquality = bool? : Find searches that have 0 or more than 3 result
• since = string? : Start date for result set. Date is provided in 'yyyyMMddHHmmss' format (default: one month ago).
• term = string? : Find searches containing a specific term.
• query = string? : Find searches using the given query term string (overrides 'term')
• groupby = {query}? : Aggregate by query
• authenticate = bool? : Force authentication for request (default: false)

GET:site/query/log/terms (internal)

Get tracked search terms (more)

• offset = int? : Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)
• lowquality = bool? : Find searches that have 0 or more than 1 result
• before = string? : End date for result set. Date is provided in 'yyyyMMddHHmmss' format (default: now).
• since = string? : Start date for result set. Date is provided in 'yyyyMMddHHmmss' format (default: one month ago).
• limit = int? : Maximum number of items to retrieve. Must be a positive number (default: 25)
• authenticate = bool? : Force authentication for request (default: false)

GET:site/query/log/{queryid} (internal)

Get tracked search detail (more)

• authenticate = bool? : Force authentication for request (default: false)
• since = string? : Start date for querystring based aggregation. Date is provided in 'yyyyMMddHHmmss' format (default: one month ago).
• before = string? : End date for querystring based aggregation. Date is provided in 'yyyyMMddHHmmss' format (default: now).
• queryid = string : Either the unique query id, or the aggregated, sorted querystring prefixed with an =

GET:site/query/recommendations (public)

Retrieve search recommendations (more)

• authenticate = bool? : Force authentication for request (default: false)
• offset = int? : Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)
• limit = int? : Maximum number of items to retrieve. Must be a positive number (default: 25)

POST:site/query/recommendations (public)

Add a search recommendation (more)

• authenticate = bool? : Force authentication for request (default: false)

DELETE:site/query/recommendations/{id} (public)

Update a search recommendation (more)

• authenticate = bool? : Force authentication for request (default: false)

GET:site/query/recommendations/{id} (public)

Retrieve search recommendations (more)

• authenticate = bool? : Force authentication for request (default: false)
• limit = int? : Maximum number of items to retrieve. Must be a positive number (default: 25)
• offset = int? : Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)

PUT:site/query/recommendations/{id} (public)

Update a search recommendation (more)

• authenticate = bool? : Force authentication for request (default: false)

POST:site/query/{queryid} (public)

Register a tracked search result selection. (more)

• authenticate = bool? : Force authentication for request (default: false)
• typeid = uint? : Id of type (if not 'page'
• type = {page,file,comment} : Type of result
• position = ushort? : Search result position
• pageid = uint : Page id where the result occured
• rank = double : Search result rank
• notrack = bool? : Disable analytics query tracking (default: false)

GET:site/roles (public)

Retrieve list of defined roles (more)

• authenticate = bool? : Force authentication for request (default: false)

GET:site/roles/{roleid} (public)

Retrieve a role (more)

• authenticate = bool? : Force authentication for request (default: false)
• {roleid} = string : either an integer role ID or "=" followed by a double uri-encoded role name

PUT:site/roles/{roleid} (public)

Modify or add a role (more)

• authenticate = bool? : Force authentication for request (default: false)
• {roleid} = string : either an integer role ID or "=" followed by a double uri-encoded role name

GET:site/search (public)

Search the site index (more)

• parser = {bestguess|term|filename|lucene}? : The parser to use for the query (default: bestguess)
• sortby = {score, title, date, size, wordcount, rating.score, rating.count}? : Sort field. Prefix value with '-' to sort descending. default: -score
• nocache = bool? : Use caching search path (better for paging results) (default: false)
• authenticate = bool? : Force authentication for request (default: false)
• format = {xml | search}? : search output format (xml | search) default: xml
• offset = int? : Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)
• q = string : lucene search string
• constraint = string? : Additional search constraints (ex: language:en-us AND type:wiki) default: none
• limit = string? : Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100)
• verbose = bool? : show verbose page xml. default: true

GET:site/search/properties (public)

Retrieve all pages with a specified property (more)

• name = string : The name of the property to search for
• authenticate = bool? : Force authentication for request (default: false)
• verbose = bool? : Show verbose page output. default: true

GET:site/search/rebuild (public)

Return rebuild information (more)

• authenticate = bool? : Force authentication for request (default: false)

POST:site/search/rebuild (internal)

Rebuild the site index (more)

• authenticate = bool? : Force authentication for request (default: false)

POST:site/search/repair (internal)

Repair the site index (more)

• checkonly = bool? : Report on entities that need to be repaired, but do not execute repair (default: false)
• authenticate = bool? : Force authentication for request (default: false)
• verbose = bool? : Report on all entities considered, whether or not repair was required (default: false)

GET:site/services (public)

Retrieve list of services. (more)

• sortby = {description, type, init, sid, uri}? : Sort field. Prefix value with '-' to sort descending. default: No sorting
• authenticate = bool? : Force authentication for request (default: false)
• offset = int? : Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)
• limit = string? : Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100)
• type = {auth, ext}? : Return only these types of services. Default: Return all

POST:site/services (internal)

Add a service (backward compatibility: empty body will restart all services) (more)

• authenticate = bool? : Force authentication for request (default: false)

DELETE:site/services/{id} (internal)

Delete a service (more)

• authenticate = bool? : Force authentication for request (default: false)

GET:site/services/{id} (public)

Retrieve service. (more)

• {id} = string : identifies a service by ID or ={namespace}
• authenticate = bool? : Force authentication for request (default: false)

POST:site/services/{id} (internal)

Restart a service (backwards compatibility) (more)

• authenticate = bool? : Force authentication for request (default: false)
• {id} = int : identifies a service by ID

PUT:site/services/{id} (internal)

Update a service (more)

• authenticate = bool? : Force authentication for request (default: false)
• {id} = int : identifies a service by ID

*:site/services/{id}/proxy//* (public)

Proxy requets to a service. (more)

• authenticate = bool? : Force authentication for request (default: false)
• {id} = string : identifies a service by ID or ={namespace}

POST:site/services/{id}/start (internal)

Start or restart a service (more)

• authenticate = bool? : Force authentication for request (default: false)

POST:site/services/{id}/stop (internal)

Stop a service (more)

• authenticate = bool? : Force authentication for request (default: false)

GET:site/settings (internal)

Retrieve all configuration settings (more)

• include = string : Optional parameter used to include anonymous user and license information (possible values: anonymous, license). By default we do not include them.
• authenticate = bool? : Force authentication for request (default: false)

PUT:site/settings (internal)

Set all configuration settings (more)

• authenticate = bool? : Force authentication for request (default: false)

GET:site/status (public)

Get mindtouch instance status information (more)

GET:site/tags (public)

Retrieve all tags (more)

• authenticate = bool? : Force authentication for request (default: false)
• q = string? : partial tag name to match (ex: tagprefix) (default none)
• pages = bool? : show pages with each tag (default: false)
• to = string? : end date for type=date (ex: 2008-12-30) (default: now + 30 days)
• from = string? : start date for type=date (ex: 2008-01-30) (default: now)
• type = string? : type of the tag (text | date | user | define) (default: all types)

GET:site/tags/{tagid} (public)

Retrieve pages with tag (more)

• {tagid} = string : either an integer tag ID or "=" followed by a double uri-encoded tag name
• language = string? : filter pages by language (default: all languages)
• authenticate = bool? : Force authentication for request (default: false)

GET:users (public)

Retrieve list of users. (more)

• rolefilter = string? : Search for users by a role name
• authprovider = int? : Return users belonging to given authentication service id
• usernameemailfilter = string? : Search for users by name and email or part of a name and email
• fullnamefilter = string? : Search for users full name starting with supplied text
• usernamefilter = string? : Search for users name starting with supplied text
• verbose = bool? : Return detailed user information. (default: true)
• sortby = {id, username, nick, email, fullname, date.lastlogin, status, role, service, date.created}? : Sort field. Prefix value with '-' to sort descending. default: No sorting
• offset = int? : Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)
• limit = string? : Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100)
• seatfilter = string? : Search for users with or without seats (one of "seated", "unseated", or "recommended"; default: none)
• activatedfilter = bool? : Search for users by their active status
• authenticate = bool? : Force authentication for request (default: false)

POST:users (public)

Add or modify a user (more)

• authenticate = bool? : Force authentication for request (default: false)
• authpassword = string? : Password to use for verification with external authentication service
• authusername = string? : Username to use for verification with external authentication service
• accountpassword = string? : Account password to set (default: do not set/change password)

GET:users/authenticate (public)

Authenticate a user given http header Credentials or an auth token. Response status 200 implies valid credentials and contains a new auth token. (more)

• callback = string? : If specified, return response as a jsonp call using the provided callback.
• ssotoken = string? : Token from remote auth service to be used for internal SSO authentication.
• authprovider = int? : Identifier for the external service to use for authentication.
• redirect = uri? : Redirect to the given URI upon authentication

POST:users/authenticate (public)

Authenticate a user given http header Credentials or an auth token. When using external authentication, this will automatically create an account and synchronize groups. Response status 200 implies valid credentials and contains a new auth token. (more)

• callback = string? : If specified, return response as a jsonp call using the provided callback.
• ssotoken = string? : Token from remote auth service to be used for internal SSO authentication.
• authprovider = int? : Identifier for the external service to use for authentication.
• redirect = uri? : Redirect to the given URI upon authentication

GET:users/{userid} (public)

Retrieve information about a user. (more)

• authenticate = bool? : Force authentication for request (default: false)
• {userid} = string : Either an integer user ID, "current", or "=" followed by a double uri-encoded user name
• exclude = string? : Elements to exclude from response document (choice of "groups", "properties"; default: exclude nothing)

PUT:users/{userid} (public)

Modify an existing user (more)

• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
• authenticate = bool? : Force authentication for request (default: false)
• authpassword = string? : Password to use for verification with external authentication service
• authusername = string? : Username to use for verification with external authentication service

POST:users/{userid}/allowed (public)

Check one or more resources if given operation is allowed. (more)

• operations = string? : Comma separated list of operations to verify
• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
• verbose = bool? : Return verbose information on permitted pages (default: true
• authenticate = bool? : Force authentication for request (default: false)
• invert = bool? : Return filtered instead of allowed pages. Sets verbose to false (default: false
• mask = long? : Permission bit mask required for the pages

GET:users/{userid}/favorites (public)

DEPRECATED: Retrieves a list of favorite pages for a user. (more)

• authenticate = bool? : Force authentication for request (default: false)
• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name

GET:users/{userid}/favorites/feed (public)

DEPRECATED: Retrieve feed of user favorites changes (more)

• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
• since = string? : Start date for changes. Date is provided in 'yyyyMMddHHmmss' format (default: ignored).
• authenticate = bool? : Force authentication for request (default: false)
• format = {all, daily, raw, rawdaily}? : Format for feed (default: daily)
• offset = int? : Skipped changes (default: 0)
• limit = int? : Number of changes to retrieve (default: 100)

GET:users/{userid}/feed (public)

Retrieve feed of user contributions (more)

• since = string? : Start date for changes. Date is provided in 'yyyyMMddHHmmss' format (default: ignored).
• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
• authenticate = bool? : Force authentication for request (default: false)
• offset = int? : Skipped changes (default: 0)
• limit = int? : Number of changes to retrieve (default: 100)
• format = {all, daily, raw, rawdaily}? : Format for feed (default: daily)

GET:users/{userid}/metrics (public)

Retrieve usage metrics for a user (more)

• authenticate = bool? : Force authentication for request (default: false)
• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name

PUT:users/{userid}/password (public)

Set password for a given user. (more)

• authenticate = bool? : Force authentication for request (default: false)
• currentpassword = string? : Current password needed when changing your own password (without admin rights)
• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
• altpassword = bool? : If true, the given password sets a secondary password that can be used for login. The main password is not overwritten. (default: false)

GET:users/{userid}/properties (public)

Retrieve the properties associated with a user (more)

• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
• 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

POST:users/{userid}/properties (public)

Create a user property (more)

• authenticate = bool? : Force authentication for request (default: false)
• abort = {never, modified, exists}? : Specifies condition under which to prevent the creation; default is exists.
• description = string? : Description of property
• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
• redirects = int? : If zero, do not follow page redirects.

PUT:users/{userid}/properties (public)

Perform changes on multiple user properties (more)

• authenticate = bool? : Force authentication for request (default: false)
• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
• redirects = int? : If zero, do not follow page redirects.

DELETE:users/{userid}/properties/{key} (public)

Remove a user property (more)

• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
• authenticate = bool? : Force authentication for request (default: false)
• redirects = int? : If zero, do not follow page redirects.
• {key} = string : A unique identifier for a property that is obtained through GET:users/{userid}/properties

GET:users/{userid}/properties/{key} (public)

Retrieve the content of a user property (more)

• authenticate = bool? : Force authentication for request (default: false)
• {key} = string : A unique identifier for a property that is obtained through GET:users/{userid}/properties
• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
• redirects = int? : If zero, do not follow page redirects.

PUT:users/{userid}/properties/{key} (public)

Update an existing user property (more)

• etag = string? : Etag of the current version of the property. Can alternatively be provided via ETag header.
• {key} = string : A unique identifier for a property that is obtained through GET:users/{userid}/properties
• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
• authenticate = bool? : Force authentication for request (default: false)
• abort = {never, modified, exists}? : Specifies condition under which to prevent the update; default is modified.
• redirects = int? : If zero, do not follow page redirects.
• description = string? : Description of property

GET:users/{userid}/properties/{key}/info (public)

Retrieve the metadata about a user property (more)

• authenticate = bool? : Force authentication for request (default: false)
• contentcutoff = int? : Only show property content shorter than this number of bytes. Default: 2048
• redirects = int? : If zero, do not follow page redirects.
• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
• {key} = string : A unique identifier for a property that is obtained through GET:users/{userid}/properties

DELETE:users/{userid}/seat (internal)

Remove a license seat from a user. (more)

• authenticate = bool? : Force authentication for request (default: false)
• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name

PUT:users/{userid}/seat (internal)

Give a user a license seat. (more)

• {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
• authenticate = bool? : Force authentication for request (default: false)

POST:{function} (public)

Invoke extension function (more)