MindTouch Core Service
Copyright (c) 2006-2009 MindTouch Inc. (more) (blueprint)
Configuration
- banned-words = string? : Comma separated list of banned words
- max-image-size = int? : Maximum supported image size in bytes or 0 for no limit (default: 0).
- imagemagick-identify-path = string : Path to ImageMagick identify tool
- admin-db-user = string? : Database administrator user name (default: "root").
- 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.
- imagemagick-convert-path = string : Path to ImageMagick converter tool
- deki-language = string? : Site language (default: "en-US").
- deki-path = string : Application installation folder
- deki-db-options = string : Optional connection string parameters
- 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).
- deki-sitename = string? : Site name (default: "MindTouch").
- 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).
- uri.log = uri? : Uri for logging service.
- service-license = string? : signed service-license
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)
Retrieve service description (more)
Retrieve service blueprint (more)
DELETE:@config (private)
Deinitialize service (more)
Retrieve service configuration (more)
PUT:@config (private)
Initialize service (more)
POST:@grants (internal)
Adds a grant to this service for accessing another service. (more)
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)
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)
- authenticate = bool? : Force authentication for request (default: false)
- {filename} = string : "=" followed by a double uri-encoded file name
- {fileid} = int : identifies a file by ID
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)
- authenticate = bool? : Force authentication for request (default: false)
- {filename} = string : "=" followed by a double uri-encoded file name
- {fileid} = int : identifies a file by ID
Retrieve the pages that can be potentially restored from deletion. (more)
- authenticate = bool? : Force authentication for request (default: false)
- title = string? : Show deleted pages matching the given title. (default: all pages)
- offset = int? : Number of titles to skip. Default: 0
- count = string? : Number of titles to retrieve. 'ALL' for no limit. (default: 100)
GET:archive/pages/{pageid} (public)
Retrieve basic page information for the deleted page (more)
- {pageid} = string : An integer page ID of a deleted page
- authenticate = bool? : Force authentication for request (default: false)
GET:archive/pages/{pageid}/contents (public)
Retrieve the contents of a deleted page for previewing (more)
- {pageid} = string : An integer page ID of a deleted page
- authenticate = bool? : Force authentication for request (default: false)
GET:archive/pages/{pageid}/info (public)
Retrieve basic page information for the deleted page (more)
- {pageid} = string : An integer page ID of a deleted page
- authenticate = bool? : Force authentication for request (default: false)
POST:archive/pages/{pageid}/restore (public)
Restore all revisions of a given page (more)
- authenticate = bool? : Force authentication for request (default: false)
- reason = string? : Reason for reverting
- to = string : new page title
- {pageid} = int : An integer page ID from GET: archive/pages
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)
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
DELETE:files/{fileid} (public)
Delete file attachment (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} (public)
Retrieve file attachment content (more)
- 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
- 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
- revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision
- format = {jpg, png, bmp, gif}? : Convert output to given type. Default is to use original type.
- authenticate = bool? : Force authentication for request (default: false)
- 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
- redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
HEAD:files/{fileid} (public)
Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests) (more)
- 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
- 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
- revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision
- format = {jpg, png, bmp, gif}? : Convert output to given type. Default is to use original type.
- authenticate = bool? : Force authentication for request (default: false)
- 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
- redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
LOCK:files/{fileid} (public)
Lock file (always returns 412 - Precondition Failed) (more)
OPTIONS:files/{fileid} (public)
Retrieve available HTTP options (more)
PUT:files/{fileid} (public)
Upload 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.
- description = string? : file attachment description
- {filename} = string : "=" followed by a double uri-encoded file name
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).
- {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
- {filename} = string : "=" followed by a double uri-encoded file name
- {fileid} = int : identifies a file by ID
GET:files/{fileid}/description (public)
retrieves a file description (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)
- {filename} = string : "=" followed by a double uri-encoded file name
- revision = string? : File 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 (only applies when {pageid} is present).
- {fileid} = int : identifies a file by ID
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).
- {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
- {filename} = string : "=" followed by a double uri-encoded file name
- {fileid} = int : identifies a file by ID
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)
- 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
POST:files/{fileid}/move (public)
Move an attachment from one page to another and/or change the filename (more)
- authenticate = bool? : Force authentication for request (default: false)
- name = string? : new filename
- to = string? : page id of target page
- {fileid} = int : identifies a file by ID
GET:files/{fileid}/properties (public)
Retrieve the properties associated with a file attachment (more)
- authenticate = bool? : Force authentication for request (default: false)
- 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. Default: all properties
- {fileid} = int : identifies a file by ID
- redirects = int? : If zero, do not follow page redirects.
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.
- {fileid} = int : identifies a file by ID
- description = string? : Description of property
- authenticate = bool? : Force authentication for request (default: false)
- redirects = int? : If zero, do not follow page redirects.
PUT:files/{fileid}/properties (public)
Perform changes on multiple attachment properties (more)
- redirects = int? : If zero, do not follow page redirects.
- {fileid} = int : identifies a file by ID
- authenticate = bool? : Force authentication for request (default: false)
DELETE:files/{fileid}/properties/{key} (public)
Remove an attachment 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:files/{fileid}/properties
- {fileid} = int : identifies a file by ID
GET:files/{fileid}/properties/{key} (public)
Retrieve the content of an 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
- authenticate = bool? : Force authentication for request (default: false)
- redirects = int? : If zero, do not follow page redirects.
PUT:files/{fileid}/properties/{key} (public)
Update an existing attachment property (more)
- description = string? : Description of property
- redirects = int? : If zero, do not follow page redirects.
- {fileid} = int : identifies a file by ID
- 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:files/{fileid}/properties
- authenticate = bool? : Force authentication for request (default: false)
- 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)
- {fileid} = int : identifies a file by ID
- 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:files/{fileid}/properties
- authenticate = bool? : Force authentication for request (default: false)
- redirects = int? : If zero, do not follow page redirects.
GET:files/{fileid}/revisions (public)
Retrieve file revision info (more)
- {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
- 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
- authenticate = bool? : Force authentication for request (default: false)
- redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
POST:files/{fileid}/revisions (public)
Performs operations such as hide/unhide for revisions of files (more)
- 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
- {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)
- {filename} = string : "=" followed by a double uri-encoded file name
DELETE:files/{fileid}/{filename} (public)
Delete file attachment (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}/{filename} (public)
Retrieve file attachment content (more)
- 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
- 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
- revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision
- format = {jpg, png, bmp, gif}? : Convert output to given type. Default is to use original type.
- authenticate = bool? : Force authentication for request (default: false)
- 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
- redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
HEAD:files/{fileid}/{filename} (public)
Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests) (more)
- 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
- 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
- revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision
- format = {jpg, png, bmp, gif}? : Convert output to given type. Default is to use original type.
- authenticate = bool? : Force authentication for request (default: false)
- 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
- redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
LOCK:files/{fileid}/{filename} (public)
Lock file (always returns 412 - Precondition Failed) (more)
OPTIONS:files/{fileid}/{filename} (public)
Retrieve available HTTP options (more)
PUT:files/{fileid}/{filename} (public)
Upload 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.
- description = string? : file attachment description
- {filename} = string : "=" followed by a double uri-encoded file name
Retrieve list of groups. (more)
- authprovider = int? : Return groups belonging to given authentication service id
- sortby = {id, name, role, service}? : Sort field. Prefix value with '-' to sort descending. default: No sorting
- limit = int? : Number of entries to retrieve. Default: 100
- authenticate = bool? : Force authentication for request (default: false)
- groupnamefilter = string? : Search for groups by name or part of a name
- offset = int? : Number of entries to skip. Default: 0
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)
- 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)
- activatedfilter = bool? : Search for users by their active status
- rolefilter = string? : Search for users by a role name
- {groupid} = string : either an integer group ID or "=" followed by a double uri-encoded group name
- limit = int? : Number of entries to retrieve. Default: 100
- offset = int? : Number of entries to skip. Default: 0
- usernamefilter = string? : Search for users by name or part of a name
POST:groups/{groupid}/users (public)
Add members to a 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)
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)
- {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
- {groupid} = string : either an integer group ID or "=" followed by a double uri-encoded group name
- authenticate = bool? : Force authentication for request (default: false)
Retrieve server license. Requires ADMIN permission to retrieve private information, otherwise only the public information is obtained. (more)
- format = string? : Response format for license aggreement (only availble for admins; one of "html", "xml"; default: "xml")
- authenticate = bool? : Force authentication for request (default: false)
PUT:license (internal)
Update server license. (more)
- authenticate = bool? : Force authentication for request (default: false)
Retrieve MindTouch site logo (more)
- authenticate = bool? : Force authentication for request (default: false)
Builds a site map starting from 'home' page. (more)
- language = string? : Filter results by language (default: all languages)
- startpage = bool? : For HTML sitemap, indicates if the start page should be included (default: true)
- format = {xml, html, google}? : Result format (default: xml)
- {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)
Retrieves a list of popular pages. (more)
- limit = uint? : max number of results to return (default: 50)
- authenticate = bool? : Force authentication for request (default: false)
- language = string? : Filter results by language (default: all languages)
- offset = uint? : offset
DELETE:pages/{pageid} (public)
Deletes a page and optionally descendant pages by moving them to the archive (more)
- 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
- authenticate = bool? : Force authentication for request (default: false)
GET:pages/{pageid} (public)
Retrieve aggregate page information including attachments (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}/aliases (public)
Retrieve list of page aliases (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
POST:pages/{pageid}/allowed (public)
Filter a list of user ids based on access to the page (more)
- {pageid} = int : integer page ID
- permissions = string? : A comma separated list of permissions that must be satisfied (e.g read, etc.). Defaults to read, if not provided
- filterdisabled = bool? : Consider disabled users to be disallowed, regardless of permissions (default: false)
GET:pages/{pageid}/comments (public)
Retrieve the comments on a page (more)
- authenticate = bool? : Force authentication for request (default: false)
- postedbyuserid = int? : Only return comments posted by the id of a user
- depth = string? : Use 'infinity' to return comments from all descendant pages. (default: 0)
- limit = int? : Number of comments to retrieve. (default: 100)
- offset = int? : Number of comments to skip. Default: 0
- 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
- sortby = {date.posted}? : Sort field. Prefix value with '-' to sort descending. (default: No sorting)
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)
- {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)
GET:pages/{pageid}/comments/{commentnumber} (public)
Retrieve a comment and metadata (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
- {commentnumber} = int : identifies the comment on the page
GET:pages/{pageid}/comments/{commentnumber}/content (public)
Retrieve the comment text only (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
- {commentnumber} = int : identifies the comment on the page
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)
- authenticate = bool? : Force authentication for request (default: false)
- 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)
- format = {html, xhtml}? : Result format (default: html)
- section = int? : The section number (default: none)
- 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.
- highlight = string? : Comma separated list of terms to highlight (default: empty)
- reltopath = string? : Page used for path normalization. Ignored if relto parameter is defined. (default: none)
- relto = int? : Page used for path normalization (default: none)
- {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
- mode = {edit, raw, view} : render content for different uses; default is 'view'
POST:pages/{pageid}/contents (public)
Update contents of a page (more)
- authenticate = bool? : Force authentication for request (default: false)
- 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
- comment = string? : the edit comment
- preservetitle = bool? : keep existing display title (default: false)
- title = string? : the display title (default: determine title from page path)
- language = string? : the page language (default: determine culture from parent)
- tidy = {remove, convert}? : Determines if invalid content is converted to text or removed (default: 'convert')
- section = int? : the section number. If zero, append as a new section
- {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
- 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)
- edittime = string : the edit timestamp (yyyyMMddHHmmss or yyyy-MM-ddTHH:mm:ssZ
- relto = int? : Page used for path normalization (default: none)
GET:pages/{pageid}/diff (public)
Show changes between revisions (more)
- format = {html, xhtml}? : Result format (default: html)
- 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
- mode = {edit, raw, view}? : which rendering mode to use when diffing; default is 'edit'
- authenticate = bool? : Force authentication for request (default: false)
GET:pages/{pageid}/feed (public)
Retrieve feed of page changes (more)
- authenticate = bool? : Force authentication for request (default: false)
- redirects = int? : If zero, do not follow page redirects.
- 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)
- 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
- limit = int? : Number of changes to retrieve (default: 100)
GET:pages/{pageid}/feed/new (public)
Retrieve feed of new page creations (more)
- authenticate = bool? : Force authentication for request (default: false)
- redirects = int? : If zero, do not follow page redirects.
- 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)
- 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
- limit = int? : Number of changes to retrieve (default: 100)
GET:pages/{pageid}/files (public)
Retrieves a list of files 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
GET:pages/{pageid}/files,subpages (public)
Retrieves a list of files and subpages for a given page (more)
- {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.
- authenticate = bool? : Force authentication for request (default: false)
DELETE:pages/{pageid}/files/{filename} (public)
Delete file attachment (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} (public)
Retrieve file attachment content (more)
- 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
- 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
- revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision
- format = {jpg, png, bmp, gif}? : Convert output to given type. Default is to use original type.
- authenticate = bool? : Force authentication for request (default: false)
- 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
- redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
HEAD:pages/{pageid}/files/{filename} (public)
Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests) (more)
- 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
- 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
- revision = string? : File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision
- format = {jpg, png, bmp, gif}? : Convert output to given type. Default is to use original type.
- authenticate = bool? : Force authentication for request (default: false)
- 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
- redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
LOCK:pages/{pageid}/files/{filename} (public)
Lock file (always returns 412 - Precondition Failed) (more)
OPTIONS:pages/{pageid}/files/{filename} (public)
Retrieve available HTTP options (more)
PUT:pages/{pageid}/files/{filename} (public)
Upload 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.
- description = string? : file attachment description
- {filename} = string : "=" followed by a double uri-encoded file name
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).
- {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
- {filename} = string : "=" followed by a double uri-encoded file name
- {fileid} = int : identifies a file by ID
GET:pages/{pageid}/files/{filename}/description (public)
retrieves a file description (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)
- {filename} = string : "=" followed by a double uri-encoded file name
- revision = string? : File 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 (only applies when {pageid} is present).
- {fileid} = int : identifies a file by ID
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).
- {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
- {filename} = string : "=" followed by a double uri-encoded file name
- {fileid} = int : identifies a file by ID
GET:pages/{pageid}/files/{filename}/info (public)
Retrieve file attachment information (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}/properties/{key} (public)
Update an existing attachment property (more)
- description = string? : Description of property
- redirects = int? : If zero, do not follow page redirects.
- {fileid} = int : identifies a file by ID
- 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:files/{fileid}/properties
- authenticate = bool? : Force authentication for request (default: false)
- 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)
- {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
- 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
- authenticate = bool? : Force authentication for request (default: false)
- redirects = int? : If zero, do not follow page redirects (only applies when {pageid} is present).
POST:pages/{pageid}/files/{filename}/revisions (public)
Performs operations such as hide/unhide for revisions of files (more)
- 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
- {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)
- {filename} = string : "=" followed by a double uri-encoded file name
POST:pages/{pageid}/index (internal)
re-index a page and it's attributes (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}/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)
- 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
- dir = {from, to} : links pointing to a page or from a page
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)
- to = string : new page title
- {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}/pdf (public)
Export a page to PDF (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)
GET:pages/{pageid}/properties (public)
Retrieve the properties associated with 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
- names = string? : Comma separated list of names of properties to return. The entire value should be URI encoded including the commas. Default: all properties
- authenticate = bool? : Force authentication for request (default: false)
- contentcutoff = int? : Only show property content shorter than this number of bytes. Default: 2048
POST:pages/{pageid}/properties (public)
Create a page property (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)
- abort = {never, modified, exists}? : Specifies condition under which to prevent the creation; default is exists.
- description = string? : Description of property
PUT:pages/{pageid}/properties (public)
Perform changes on multiple page properties (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.
DELETE:pages/{pageid}/properties/{key} (public)
Remove a page property (more)
- {key} = string : A unique identifier for a property that is obtained through GET:pages/{pageid}/properties
- 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
GET:pages/{pageid}/properties/{key} (public)
Retrieve the content of a page property (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)
- {key} = string : A unique identifier for a property that is obtained through GET:pages/{pageid}/properties
- redirects = int? : If zero, do not follow page redirects.
PUT:pages/{pageid}/properties/{key} (public)
Update an existing page property (more)
- etag = string? : Etag of the current version of the property. Can alternatively be provided via etag header.
- description = string? : Description of property
- {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.
- {key} = string : A unique identifier for a property that is obtained through GET:pages/{pageid}/properties
- authenticate = bool? : Force authentication for request (default: false)
- abort = {never, modified, exists}? : Specifies condition under which to prevent the update; default is modified.
GET:pages/{pageid}/properties/{key}/info (public)
Retrieve the metadata about a page property (more)
- {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
- contentcutoff = int? : Only show property content shorter than this number of bytes. Default: 2048
- authenticate = bool? : Force authentication for request (default: false)
- redirects = int? : If zero, do not follow page redirects.
POST:pages/{pageid}/revert (public)
Revert page to an earlier revision (more)
- fromrevision = int : Revision number of page that will become the new head revision
- {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}/revisions (public)
Retrieve revision history of a given title (more)
- authenticate = bool? : Force authentication for request (default: false)
- revision = int? : Page revision to retrieve
- redirects = int? : If zero, do not follow page redirects.
- offset = int? : Skipped revisions (default: 0)
- {pageid} = string : either an integer page ID, "home", or "=" followed by a double uri-encoded page title
- limit = int? : Number of revisions to retrieve. (default: 50)
POST:pages/{pageid}/revisions (public)
Performs operations such as hide/unhide for revisions of pages (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.
- comment = string? : Reason for hiding revisions
DELETE:pages/{pageid}/security (public)
Reset page restricts and grants (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.
GET:pages/{pageid}/security (public)
Retrieve page security info (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
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)
- 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
- 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}/subpages (public)
Retrieve list of sub-pages (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.
- offset = int? : Number of subpages to skip. Default: 0
- limit = int? : Number of subpages to retrieve. (default: 100)
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)
- 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}/tree (public)
Builds a site map starting from a given page. (more)
- language = string? : Filter results by language (default: all languages)
- startpage = bool? : For HTML sitemap, indicates if the start page should be included (default: true)
- format = {xml, html, google}? : Result format (default: xml)
- {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 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)
- authenticate = bool? : Force authentication for request (default: false)
GET:site/bans/{banid} (public)
See a specific ban entry (more)
- authenticate = bool? : Force authentication for request (default: false)
POST:site/export (public)
Generates export 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)
Retrieve feed of site changes (more)
- since = string? : Start date for changes. Date is provided in 'yyyyMMddHHmmss' format (default: ignored).
- limit = int? : Number of changes to retrieve (default: 100)
- authenticate = bool? : Force authentication for request (default: false)
- 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)
Retrieve feed of new page creations (more)
- since = string? : Start date for changes. Date is provided in 'yyyyMMddHHmmss' format (default: ignored).
- limit = int? : Number of changes to retrieve (default: 100)
- authenticate = bool? : Force authentication for request (default: false)
- 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)
Get list of available extensions (more)
- format = {html, body, xml}? : output format (default: html)
- authenticate = bool? : Force authentication for request (default: false)
POST:site/import (public)
Generates import 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.
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)
Retrieve the site logo image (more)
- authenticate = bool? : Force authentication for request (default: false)
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)
Retrieve the site logo image (more)
- authenticate = bool? : Force authentication for request (default: false)
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.
- 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)
- 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).
- 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}/full (public)
Retrieve <div> tags of the full navigation tree for the given page. (more)
- 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).
- width = int? : Max width for visible text
- {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)
- authenticate = bool? : Force authentication for request (default: false)
- 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
- width = int? : Max width for visible text
- redirects = int? : If zero, do not follow page redirects.
Search the site index (more)
- constraint = string? : Additional search constraint (ex: language:en-us AND type:wiki) default: none
- offset = uint? : offset
- limit = uint? : max number of results to return (default: 100)
- format = {rss | atom}? : search output format (rss | atom) default: atom
- q = string : lucene search string
- authenticate = bool? : Force authentication for request (default: false)
- sortby = {score, title, date, size, wordcount}? : Sort field. Prefix value with '-' to sort descending. default: score
Get the OpenSearch Description document (more)
- authenticate = bool? : Force authentication for request (default: false)
Search the site index (more)
- authenticate = bool? : Force authentication for request (default: false)
- q = string : lucene search string
- constraint = string? : Additional search constraint (ex: language:en-us AND type:wiki) default: none
- sortby = {score, title, date, size, wordcount}? : Sort field. Prefix value with '-' to sort descending. default: score
Retrieve all known security operations (more)
- authenticate = bool? : Force authentication for request (default: false)
Retrieve the properties associated with the site (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
- names = string? : Comma separated list of names of properties to return. The entire value should be URI encoded including the commas. Default: all properties
POST:site/properties (public)
Create a site property (more)
- authenticate = bool? : Force authentication for request (default: false)
- redirects = int? : If zero, do not follow page redirects.
- abort = {never, modified, exists}? : Specifies condition under which to prevent the creation; default is exists.
- description = string? : Description of property
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.
- {key} = string : A unique identifier for a property that is obtained through GET:site/properties
- 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:site/properties/{key} (public)
Retrieve the content of a site property (more)
- authenticate = bool? : Force authentication for request (default: false)
- {key} = string : A unique identifier for a property that is obtained through GET:site/properties
- redirects = int? : If zero, do not follow page redirects.
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.
- 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
- {key} = string : A unique identifier for a property that is obtained through GET:site/properties
- authenticate = bool? : Force authentication for request (default: false)
GET:site/properties/{key}/info (public)
Retrieve the metadata about a site 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:site/properties
- contentcutoff = int? : Only show property content shorter than this number of bytes. Default: 2048
Retrieve list of defined roles (more)
- authenticate = bool? : Force authentication for request (default: false)
GET:site/roles/{roleid} (public)
Retrieve a role (more)
- {roleid} = string : either an integer role ID or "=" followed by a double uri-encoded role name
- authenticate = bool? : Force authentication for request (default: false)
PUT:site/roles/{roleid} (public)
Modify or add a role (more)
- {roleid} = string : either an integer role ID or "=" followed by a double uri-encoded role name
- authenticate = bool? : Force authentication for request (default: false)
Search the site index (more)
- authenticate = bool? : Force authentication for request (default: false)
- offset = uint? : offset
- format = {xml | search}? : search output format (xml | search) default: xml
- verbose = bool? : show verbose page xml. default: true
- constraint = string? : Additional search constraints (ex: language:en-us AND type:wiki) default: none
- sortby = {score, title, date, size, wordcount}? : Sort field. Prefix value with '-' to sort descending. default: score
- limit = uint? : max number of results to return (default: 100)
- q = string : lucene search string
Retrieve all pages with a specified property (more)
- authenticate = bool? : Force authentication for request (default: false)
- name = string : The name of the property to search for
- verbose = bool? : Show verbose page output. default: true
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)
Retrieve list of services. (more)
- authenticate = bool? : Force authentication for request (default: false)
- sortby = {description, type, init, sid, uri}? : Sort field. Prefix value with '-' to sort descending. default: No sorting
- offset = int? : Number of entries to skip. Default: 0
- type = {auth, ext}? : Return only these types of services. Default: Return all
- limit = int? : Number of entries to retrieve. Default: 100
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)
- authenticate = bool? : Force authentication for request (default: false)
- {id} = int : identifies a service by ID
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
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)
Retrieve all configuration settings (more)
- 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 mindtouch instance status information (more)
Retrieve all tags (more)
- q = string? : partial tag name to match (ex: sometag%) (default false)
- pages = bool? : show pages with each tag (default: false)
- authenticate = bool? : Force authentication for request (default: false)
- 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)
- to = string? : end date for type=date (ex: 2008-12-30) (default: now + 30 days)
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)
Retrieve list of users. (more)
- authenticate = bool? : Force authentication for request (default: false)
- sortby = {id, username, nick, email, fullname, date.lastlogin, status, role, service, date.created}? : Sort field. Prefix value with '-' to sort descending. default: No sorting
- limit = int? : Number of entries to retrieve. Default: 100
- usernamefilter = string? : Search for users by name or part of a name
- offset = int? : Number of entries to skip. Default: 0
- activatedfilter = bool? : Search for users by their active status
- 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
POST:users (public)
Add or modify a user (more)
- authenticate = bool? : Force authentication for request (default: false)
- authusername = string? : Username to use for verification with external authentication service
- authpassword = string? : Password to use for verification with external authentication service
- accountpassword = string? : Account password to set (default: do not set/change password)
Authenticate a user given http header Credentials or an auth token. Response status 200 implies valid credentials and contains a new auth token. (more)
- authprovider = int? : Identifier for the external service to use for 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)
- authprovider = int? : Identifier for the external service to use for authentication.
GET:users/{userid} (public)
Retrieve information about 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)
PUT:users/{userid} (public)
Modify an existing user (more)
- authpassword = string? : Password to use for verification with external authentication service
- accountpassword = string? : Account password to set (default: do not set/change password)
- authenticate = bool? : Force authentication for request (default: false)
- authusername = string? : Username to use for verification with external authentication service
- {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
POST:users/{userid}/allowed (public)
Check one or more resources if given operation is allowed. (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
- operations = string? : Comma separated list of operations to verify
- mask = long? : Permission bit mask required for the pages
GET:users/{userid}/favorites (public)
Retrieves a list of favorite pages for a user. (more)
GET:users/{userid}/favorites/feed (public)
Retrieve feed of user favorites changes (more)
- offset = int? : Skipped changes (default: 0)
- format = {all, daily, raw, rawdaily}? : Format for feed (default: daily)
- authenticate = bool? : Force authentication for request (default: false)
- 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
- limit = int? : Number of changes to retrieve (default: 100)
GET:users/{userid}/feed (public)
Retrieve feed of user contributions (more)
- authenticate = bool? : Force authentication for request (default: false)
- offset = int? : Skipped changes (default: 0)
- format = {all, daily, raw, rawdaily}? : Format for feed (default: daily)
- 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
- limit = int? : Number of changes to retrieve (default: 100)
PUT:users/{userid}/password (public)
Set password for a given 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)
- 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)
- currentpassword = string? : Current password needed when changing your own password (without admin rights)
GET:users/{userid}/properties (public)
Retrieve the properties associated with a user (more)
- contentcutoff = int? : Only show property content shorter than this number of bytes. Default: 2048
- 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. Default: all properties
- {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
POST:users/{userid}/properties (public)
Create a user property (more)
- authenticate = bool? : Force authentication for request (default: false)
- 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
- description = string? : Description of property
- abort = {never, modified, exists}? : Specifies condition under which to prevent the creation; default is exists.
PUT:users/{userid}/properties (public)
Perform changes on multiple user properties (more)
- authenticate = bool? : Force authentication for request (default: false)
- 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
DELETE:users/{userid}/properties/{key} (public)
Remove a user property (more)
- 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
- authenticate = bool? : Force authentication for request (default: false)
- {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)
- 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
- {userid} = string : either an integer user ID, "current", or "=" followed by a double uri-encoded user name
PUT:users/{userid}/properties/{key} (public)
Update an existing user property (more)
- 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
- {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.
GET:users/{userid}/properties/{key}/info (public)
Retrieve the metadata about 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)
- 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:users/{userid}/properties
- redirects = int? : If zero, do not follow page redirects.
POST:{function} (public)
Invoke extension function (more)