mindtouch.dekiMindTouch.Deki.DekiWikiServiceMindTouch Core ServiceCopyright (c) 2006-2010 MindTouch Inc.http://developer.mindtouch.com/en/ref/MindTouch_APIsid://mindtouch.com/2006/11/dekiwikihttp://services.mindtouch.com/deki/draft/2006/11/dekiwikihttp://www.mindtouch.com/services/2006/11/dekiwikiimagemagick-identify-pathstringPath to ImageMagick identify toolimagemagick-convert-pathstringPath to ImageMagick converter tooldeki-resources-pathstring?Path to resources folder (default: "%deki-path%/resources")authtoken-saltstringPrivate key used to generate unique auth tokensadmin-db-passwordstringDatabase administrator password.admin-db-userstring?Database administrator user name (default: "root").deki-sitenamestring?Site name (default: "MindTouch").deki-languagestring?Site language (default: "en-US").deki-pathstringApplication installation folderdeki-temp-pathstring?Path for temporary files (default: system default temp folder)deki-db-passwordstringPassword for database user.deki-db-userstring?Database user name (default: wikiuser).deki-db-catalogstring?Database table name (default: wikidb).deki-db-portint?Database port (default: 3306).deki-db-serverstring?Database host name (default: localhost).max-image-sizeint?Maximum supported image size in bytes or 0 for no limit (default: 0).deki-db-optionsstringOptional connection string parametersbanned-wordsstring?Comma separated list of banned wordsdeki-signaturestring?Puglic Digital Signature key to verify incoming requests from MindTouch. (default: none)apikeystring?Key to access protected features of the service.uri.selfuriUri for current service (provided by Host).service-licensestring?signed service-licenseuri.loguri?Uri for logging service.GET:contextshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetContextDefinitionsdescriptionstring?contextidstring?Read access to the page is requiredThe request completed successfullyThe requested page could not be foundInvalid input parameter or request bodypublicPOST:contextshttp://developer.mindtouch.com/en/ref/MindTouch_APIPostContextDefinitionsauthenticatebool?Force authentication for request (default: false)The request completed successfullyThe requested page could not be foundRead access to the page is requiredInvalid input parameter or request bodypublicGET:contexts/{id}http://developer.mindtouch.com/en/ref/MindTouch_APIGetContextDefinitionauthenticatebool?Force authentication for request (default: false)idstringRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyThe requested page could not be foundpublicPUT:contexts/{id}http://developer.mindtouch.com/en/ref/MindTouch_APIPutContextDefinitionidstringauthenticatebool?Force authentication for request (default: false)Read access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyThe requested page could not be foundpublicDELETE:contexts/{id}http://developer.mindtouch.com/en/ref/MindTouch_APIDeleteContextDefinitionauthenticatebool?Force authentication for request (default: false)idstringRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyThe requested page could not be foundpublicGET:contextmapshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetContextMapsverbosebool?return verbose page information (default: false)languagesonlybool?contextidstring?mappedbool?languagestring?Read access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyThe requested page could not be foundpublicGET:contextmaps/{language}/{id}http://developer.mindtouch.com/en/ref/MindTouch_APIGetContextMapauthenticatebool?Force authentication for request (default: false)verbosebool?return verbose information (default: false)idstringlanguagestringThe request completed successfullyThe requested mapping could not be foundInvalid input parameter or request bodyRead access to the mapping is requiredpublicPUT:contextmaps/{language}/{id}http://developer.mindtouch.com/en/ref/MindTouch_APIPutContextMaplanguagestringauthenticatebool?Force authentication for request (default: false)verbosebool?return verbose information (default: false)idstringInvalid input parameter or request bodyThe request completed successfullyThe requested mapping could not be foundRead access to the mapping is requiredpublicDELETE:contextmaps/{language}/{id}http://developer.mindtouch.com/en/ref/MindTouch_APIDeleteContextMaplanguagestringauthenticatebool?Force authentication for request (default: false)idstringThe requested page could not be foundRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicPOST:host/stopStop the request associate tenant, if runninghttp://developer.mindtouch.com/en/ref/MindTouch_APIPostHostInstanceStopinternalPOST:host/stop/{wikiid}Stop the requested tenant, if runninghttp://developer.mindtouch.com/en/ref/MindTouch_APIPostHostInstanceStopByWikiIdinternalGET:hostGet all currently running tenantshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetHostInstancesinternalGET:site/opensearch/descriptionGet the OpenSearch Description documenthttp://developer.mindtouch.com/en/ref/MindTouch_APIGetSearchDescriptionauthenticatebool?Force authentication for request (default: false)publicGET:site/opensearchSearch the site indexhttp://developer.mindtouch.com/en/ref/MindTouch_APIOpenSearchauthenticatebool?Force authentication for request (default: false)nocachebool?Use caching search path (better for paging results) (default: false)parser{bestguess|term|filename|lucene}?The parser to use for the query (default: bestguess)constraintstring?Additional search constraint (ex: language:en-us AND type:wiki) default: nonesortby{score, title, date, size, wordcount, rating.score, rating.count}?Sort field. Prefix value with '-' to sort descending. default: -scoreoffsetint?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: atomqstringlucene search stringlimitstring?Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100)The request completed successfullyInvalid input parameter or request bodypublicGET:site/opensearch/suggestionsSearch the site indexhttp://developer.mindtouch.com/en/ref/MindTouch_APIOpenSearchSuggestauthenticatebool?Force authentication for request (default: false)constraintstring?Additional search constraint (ex: language:en-us AND type:wiki) default: nonesortby{score, title, date, size, wordcount, rating.score, rating.count}?Sort field. Prefix value with '-' to sort descending. default: -scoreqstringlucene search stringThe request completed successfullyInvalid input parameter or request bodypublicGET:site/searchSearch the site indexhttp://developer.mindtouch.com/en/ref/MindTouch_APISearchIndexparser{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: -scorenocachebool?Use caching search path (better for paging results) (default: false)authenticatebool?Force authentication for request (default: false)format{xml | search}?search output format (xml | search) default: xmloffsetint?Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)qstringlucene search stringconstraintstring?Additional search constraints (ex: language:en-us AND type:wiki) default: nonelimitstring?Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100)verbosebool?show verbose page xml. default: trueInvalid input parameter or request bodyThe request completed successfullypublicGET:site/querySearch the site index with analytical tracking. Primarily for user facing search.http://developer.mindtouch.com/en/ref/MindTouch_APIGetRankedSearchqstringlucene search stringnotrackbool?Disable analytics query tracking (default: false)authenticatebool?Force authentication for request (default: false)explainbool?Include ranking details (default: false)constraintstring?Additional search constraints (ex: language:en-us AND type:wiki) default: nonesortby{rank, title, modified}?Sort field. Prefix value with '-' to sort descending. (default: -rank)offsetint?Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)limitint?Maximum number of items to retrieve. Must be a positive number (default: 25)previousqueryidulong?Query tracking id of previous query, if this is a follow-up queryparser{bestguess|term|lucene}?The parser to use for the query (default: bestguess)queryidulong?Query tracking id returned by original query result (used for paging/changing sort order)Invalid input parameter or request bodyThe request completed successfullypublicPOST:site/query/{queryid}Register a tracked search result selection.http://developer.mindtouch.com/en/ref/MindTouch_APIPostSearchResultAnalyticsauthenticatebool?Force authentication for request (default: false)typeiduint?Id of type (if not 'page'type{page,file,comment}Type of resultpositionushort?Search result positionpageiduintPage id where the result occuredrankdoubleSearch result ranknotrackbool?Disable analytics query tracking (default: false)Invalid input parameter or request bodyThe request completed successfullypublicGET:site/query/logGet tracked search data.http://developer.mindtouch.com/en/ref/MindTouch_APIGetTrackedSearchesoffsetint?Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)limitint?Maximum number of items to retrieve. Must be a positive number (default: 25)beforestring?End date for result set. Date is provided in 'yyyyMMddHHmmss' format (default: now).lowqualitybool?Find searches that have 0 or more than 3 resultsincestring?Start date for result set. Date is provided in 'yyyyMMddHHmmss' format (default: one month ago).termstring?Find searches containing a specific term.querystring?Find searches using the given query term string (overrides 'term')groupby{query}?Aggregate by queryauthenticatebool?Force authentication for request (default: false)Invalid input parameter or request bodyThe request completed successfullyinternalGET:site/query/log/termsGet tracked search termshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetTrackedSearchTermsoffsetint?Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)lowqualitybool?Find searches that have 0 or more than 1 resultbeforestring?End date for result set. Date is provided in 'yyyyMMddHHmmss' format (default: now).sincestring?Start date for result set. Date is provided in 'yyyyMMddHHmmss' format (default: one month ago).limitint?Maximum number of items to retrieve. Must be a positive number (default: 25)authenticatebool?Force authentication for request (default: false)The request completed successfullyInvalid input parameter or request bodyinternalGET:site/query/log/{queryid}Get tracked search detailhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetTrackedSearchDetailauthenticatebool?Force authentication for request (default: false)sincestring?Start date for querystring based aggregation. Date is provided in 'yyyyMMddHHmmss' format (default: one month ago).beforestring?End date for querystring based aggregation. Date is provided in 'yyyyMMddHHmmss' format (default: now).queryidstringEither the unique query id, or the aggregated, sorted querystring prefixed with an =The request completed successfullyInvalid input parameter or request bodyinternalGET:site/query/recommendationsRetrieve search recommendationshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetSearchRecommendationsauthenticatebool?Force authentication for request (default: false)offsetint?Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)limitint?Maximum number of items to retrieve. Must be a positive number (default: 25)MindTouch API key or Administrator access is required.The request completed successfullypublicPOST:site/query/recommendationsAdd a search recommendationhttp://developer.mindtouch.com/en/ref/MindTouch_APIAddSearchRecommendationsauthenticatebool?Force authentication for request (default: false)The request completed successfullyMindTouch API key or Administrator access is required.publicGET:site/query/recommendations/{id}Retrieve search recommendationshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetSearchRecommendationauthenticatebool?Force authentication for request (default: false)limitint?Maximum number of items to retrieve. Must be a positive number (default: 25)offsetint?Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)The request completed successfullyMindTouch API key or Administrator access is required.publicPUT:site/query/recommendations/{id}Update a search recommendationhttp://developer.mindtouch.com/en/ref/MindTouch_APIUpdateSearchRecommendationsauthenticatebool?Force authentication for request (default: false)The request completed successfullyMindTouch API key or Administrator access is required.publicDELETE:site/query/recommendations/{id}Update a search recommendationhttp://developer.mindtouch.com/en/ref/MindTouch_APIDeleteSearchRecommendationsauthenticatebool?Force authentication for request (default: false)MindTouch API key or Administrator access is required.The request completed successfullypublicGET:site/search/rebuildReturn rebuild informationhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetRebuildInformationauthenticatebool?Force authentication for request (default: false)Invalid input parameter or request bodyThe request completed successfullypublicPOST:site/search/rebuildRebuild the site indexhttp://developer.mindtouch.com/en/ref/MindTouch_APIRebuildIndexauthenticatebool?Force authentication for request (default: false)The request completed successfullyMindTouch API key or Administrator access is required.internalPOST:site/search/repairRepair the site indexhttp://developer.mindtouch.com/en/ref/MindTouch_APIRepairIndexcheckonlybool?Report on entities that need to be repaired, but do not execute repair (default: false)authenticatebool?Force authentication for request (default: false)verbosebool?Report on all entities considered, whether or not repair was required (default: false)MindTouch API key or Administrator access is required.The request completed successfullyinternalGET:site/bansGet a list of all IP and user banshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetBansauthenticatebool?Force authentication for request (default: false)Request completed successfullyADMIN access is requiredpublicGET:site/bans/{banid}See a specific ban entryhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetBan{banid}intIdentifies a ban by IDauthenticatebool?Force authentication for request (default: false)Request completed successfullyADMIN access is requiredBan ID does not existpublicPOST:site/bansCreate a ban entryhttp://developer.mindtouch.com/en/ref/MindTouch_APIPostBansauthenticatebool?Force authentication for request (default: false)ADMIN access is requiredRequest completed successfullyInvalid request bodypublicDELETE:site/bans/{banid}Remove a ban entryhttp://developer.mindtouch.com/en/ref/MindTouch_APIDeleteBan{banid}intIdentifies a ban by IDauthenticatebool?Force authentication for request (default: false)Ban ID does not existADMIN access is requiredRequest completed successfullypublicGET:comments/{commentid}Retrieve a comment and metadatahttp://developer.mindtouch.com/en/ref/MindTouch_APIGetComment{commentnumber}int?identifies the comment on the page{pageid}string?either an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false){commentid}int?identifies the comment by its unique idRequested comment could not be foundRead access to the page is requiredInvalid input parameter or request bodyRequest completed successfullypublicGET:pages/{pageid}/comments/{commentnumber}Retrieve a comment and metadatahttp://developer.mindtouch.com/en/ref/MindTouch_APIGetComment{commentnumber}int?identifies the comment on the page{pageid}string?either an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false){commentid}int?identifies the comment by its unique idRequested comment could not be foundRead access to the page is requiredInvalid input parameter or request bodyRequest completed successfullypublicGET:pages/{pageid}/comments/{commentnumber}/contentRetrieve the comment text onlyhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetCommentContentauthenticatebool?Force authentication for request (default: false){commentnumber}intidentifies the comment on the page{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleThe requested comment could not be foundRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicGET:pages/{pageid}/commentsRetrieve the comments on a pagehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPageCommentsdepthstring?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)offsetint?Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)limitstring?Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100)filterstring?Comments to return: any, nondeleted. default: nondeletedformat{xml, atom}?Output format (default: xml).{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titlepostedbyuseridint?Only return comments posted by the id of a userauthenticatebool?Force authentication for request (default: false)The request completed successfullyInvalid input parameter or request bodyThe requested page could not be foundRead access to the page is requiredpublicPUT:pages/{pageid}/comments/{commentnumber}/contentEdit the specified commenthttp://developer.mindtouch.com/en/ref/MindTouch_APIPutCommentContentauthenticatebool?Force authentication for request (default: false){commentnumber}intidentifies the comment on the page{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleThe request completed successfullyThe requested comment could not be foundAdministrator access or comment author is requiredInvalid input parameter or request body (must be text MIME type)publicPOST:pages/{pageid}/commentsPost a new comment to a pagehttp://developer.mindtouch.com/en/ref/MindTouch_APIPostPageCommentauthenticatebool?Force authentication for request (default: false)titlestring?Title for comment{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleThe requested page could not be foundUpdate access to the page is requiredInvalid input parameter or request body (must be text MIME type)The request completed successfullypublicDELETE:pages/{pageid}/comments/{commentnumber}Mark a comment as being deleted. This hides comment content from non adminshttp://developer.mindtouch.com/en/ref/MindTouch_APIDeleteCommentauthenticatebool?Force authentication for request (default: false){commentnumber}intidentifies the comment on the page{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleThe request completed successfullyThe requested comment could not be foundAdministrator access or comment author is requiredInvalid input parameter or request bodypublicGET:filesRetrieve information for all attached fileshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetFilesauthenticatebool?Force authentication for request (default: false)skipint?Number of files to skip. Default: 0numfilesint?Number of files to retrieve. 'ALL' for no limit. Default: 100Read access to the page sis requiredInvalid input parameter or request bodyThe request completed successfullypublicGET:files/{fileid}/infoRetrieve file attachment informationhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetFileInforevisionstring?File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleredirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).authenticatebool?Force authentication for request (default: false)Requested file could not be foundRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicGET:pages/{pageid}/files/{filename}/infoRetrieve file attachment informationhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetFileInforevisionstring?File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleredirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).authenticatebool?Force authentication for request (default: false)Requested file could not be foundRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicOPTIONS:files/{fileid}Retrieve available HTTP optionshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetOptionspublicOPTIONS:pages/{pageid}/files/{filename}Retrieve available HTTP optionshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetOptionspublicOPTIONS:files/{fileid}/{filename}Retrieve available HTTP optionshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetOptionspublicUNLOCK:files/{fileid}Unlock file (always returns 204)http://developer.mindtouch.com/en/ref/MindTouch_APIUnLockFilepublicUNLOCK:pages/{pageid}/files/{filename}Unlock file (always returns 204)http://developer.mindtouch.com/en/ref/MindTouch_APIUnLockFilepublicUNLOCK:files/{fileid}/{filename}Unlock file (always returns 204)http://developer.mindtouch.com/en/ref/MindTouch_APIUnLockFilepublicLOCK:files/{fileid}Lock file (always returns 200, mirroring the request document)http://developer.mindtouch.com/en/ref/MindTouch_APILockFilepublicLOCK:pages/{pageid}/files/{filename}Lock file (always returns 200, mirroring the request document)http://developer.mindtouch.com/en/ref/MindTouch_APILockFilepublicLOCK:files/{fileid}/{filename}Lock file (always returns 200, mirroring the request document)http://developer.mindtouch.com/en/ref/MindTouch_APILockFilepublicPROPFIND:files/{fileid}/{filename}Lock file (always returns 412 - Precondition Failed)http://developer.mindtouch.com/en/ref/MindTouch_APIPropfindFilepublicPROPFIND:pages/{pageid}/files/{filename}Lock file (always returns 412 - Precondition Failed)http://developer.mindtouch.com/en/ref/MindTouch_APIPropfindFilepublicPROPFIND:files/{fileid}Lock file (always returns 412 - Precondition Failed)http://developer.mindtouch.com/en/ref/MindTouch_APIPropfindFilepublicPROPFIND:filesLock file (always returns 412 - Precondition Failed)http://developer.mindtouch.com/en/ref/MindTouch_APIPropfindDirectorypublicGET:pages/{pageid}/files/{filename}Retrieve file attachment contenthttp://developer.mindtouch.com/en/ref/MindTouch_APIGetFileauthenticatebool?Force authentication for request (default: false)redirectsint?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: originalformat{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: fixedwidthint?Width of the imageheightint?Height of the image{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titlerevisionstring?File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revisionRequested file could not be foundRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyRequested operation is not currently supportedpublicHEAD:files/{fileid}/{filename}Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests)http://developer.mindtouch.com/en/ref/MindTouch_APIGetFileauthenticatebool?Force authentication for request (default: false)redirectsint?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: originalformat{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: fixedwidthint?Width of the imageheightint?Height of the image{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titlerevisionstring?File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revisionRequested file could not be foundRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyRequested operation is not currently supportedpublicHEAD:files/{fileid}Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests)http://developer.mindtouch.com/en/ref/MindTouch_APIGetFileauthenticatebool?Force authentication for request (default: false)redirectsint?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: originalformat{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: fixedwidthint?Width of the imageheightint?Height of the image{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titlerevisionstring?File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revisionRequested file could not be foundRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyRequested operation is not currently supportedpublicHEAD:pages/{pageid}/files/{filename}Retrieve file attachment content (Note: image manipulation arguments are ignored for HEAD requests)http://developer.mindtouch.com/en/ref/MindTouch_APIGetFileauthenticatebool?Force authentication for request (default: false)redirectsint?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: originalformat{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: fixedwidthint?Width of the imageheightint?Height of the image{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titlerevisionstring?File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revisionRequested file could not be foundRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyRequested operation is not currently supportedpublicGET:files/{fileid}/{filename}Retrieve file attachment contenthttp://developer.mindtouch.com/en/ref/MindTouch_APIGetFileauthenticatebool?Force authentication for request (default: false)redirectsint?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: originalformat{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: fixedwidthint?Width of the imageheightint?Height of the image{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titlerevisionstring?File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revisionRequested file could not be foundRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyRequested operation is not currently supportedpublicGET:files/{fileid}Retrieve file attachment contenthttp://developer.mindtouch.com/en/ref/MindTouch_APIGetFileauthenticatebool?Force authentication for request (default: false)redirectsint?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: originalformat{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: fixedwidthint?Width of the imageheightint?Height of the image{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titlerevisionstring?File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revisionRequested file could not be foundRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyRequested operation is not currently supportedpublicGET:files/{fileid}/revisionsRetrieve file revision infohttp://developer.mindtouch.com/en/ref/MindTouch_APIGetFileRevisionsauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).changefilterstring?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}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleInvalid input parameter or request bodyThe request completed successfullyRequested file could not be foundRead access to the page is requiredpublicGET:pages/{pageid}/files/{filename}/revisionsRetrieve file revision infohttp://developer.mindtouch.com/en/ref/MindTouch_APIGetFileRevisionsauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).changefilterstring?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}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleInvalid input parameter or request bodyThe request completed successfullyRequested file could not be foundRead access to the page is requiredpublicPOST:files/{fileid}/revisionsPerforms operations such as hide/unhide for revisions of fileshttp://developer.mindtouch.com/en/ref/MindTouch_APIPostFileRevisionsauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).commentstring?Reason for hiding revisions{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleDELETE access is required to hide a revision and ADMIN access to unhideInvalid input parameter or request bodyThe request completed successfullyRequested file could not be foundpublicPOST:pages/{pageid}/files/{filename}/revisionsPerforms operations such as hide/unhide for revisions of fileshttp://developer.mindtouch.com/en/ref/MindTouch_APIPostFileRevisionsauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).commentstring?Reason for hiding revisions{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleDELETE access is required to hide a revision and ADMIN access to unhideInvalid input parameter or request bodyThe request completed successfullyRequested file could not be foundpublicPUT:files/{fileid}/{filename}Replace an existing attachment with a new versionhttp://developer.mindtouch.com/en/ref/MindTouch_APIPutFile{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.{filename}string"=" followed by a double uri-encoded file namedescriptionstring?file attachment descriptionThe request completed successfullyRequested page could not be foundUpdate access to the page is requiredInvalid input parameter or request bodypublicPUT:files/{fileid}Replace an existing attachment with a new versionhttp://developer.mindtouch.com/en/ref/MindTouch_APIPutFile{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.{filename}string"=" followed by a double uri-encoded file namedescriptionstring?file attachment descriptionThe request completed successfullyRequested page could not be foundUpdate access to the page is requiredInvalid input parameter or request bodypublicPUT:pages/{pageid}/files/{filename}Replace an existing attachment with a new version or create a new attachmenthttp://developer.mindtouch.com/en/ref/MindTouch_APIPutFile{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.{filename}string"=" followed by a double uri-encoded file namedescriptionstring?file attachment descriptionThe request completed successfullyRequested page could not be foundUpdate access to the page is requiredInvalid input parameter or request bodypublicPOST:files/{fileid}/moveMove an attachment from one page to another and/or change the filenamehttp://developer.mindtouch.com/en/ref/MindTouch_APIPostFileMove{fileid}intidentifies a file by IDauthenticatebool?Force authentication for request (default: false)namestring?new filenametostring?page id of target pageRequested file could not be foundUpdate access to the page is requiredThe request completed successfullyInvalid input parameter or request bodypublicPOST:files/{fileid}/copyCopy an attachment from one page to another and/or change the filenamehttp://developer.mindtouch.com/en/ref/MindTouch_APIPostFileMove{fileid}intidentifies a file by IDauthenticatebool?Force authentication for request (default: false)namestring?new filenametostring?page id of target pageRequested file could not be foundUpdate access to the page is requiredThe request completed successfullyInvalid input parameter or request bodypublicDELETE:files/{fileid}Delete file attachmenthttp://developer.mindtouch.com/en/ref/MindTouch_APIDeleteFile{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file nameThe requested file could not be foundUpdate access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicDELETE:pages/{pageid}/files/{filename}Delete file attachmenthttp://developer.mindtouch.com/en/ref/MindTouch_APIDeleteFile{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file nameThe requested file could not be foundUpdate access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicDELETE:files/{fileid}/{filename}Delete file attachmenthttp://developer.mindtouch.com/en/ref/MindTouch_APIDeleteFile{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file nameThe requested file could not be foundUpdate access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicGET:pages/{pageid}/files/{filename}/descriptionretrieves a file descriptionhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetFileDescriptionauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).revisionstring?File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleRequested file could not be foundRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicGET:files/{fileid}/descriptionretrieves a file descriptionhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetFileDescriptionauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).revisionstring?File revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revision{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleRequested file could not be foundRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicDELETE:pages/{pageid}/files/{filename}/descriptionReset the file descriptionhttp://developer.mindtouch.com/en/ref/MindTouch_APIPutFileDescriptionauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleRequested file could not be foundUpdate access to the page is requiredInvalid input parameter or request bodyRequest completed successfullypublicPUT:files/{fileid}/descriptionUpdate attachment descriptionhttp://developer.mindtouch.com/en/ref/MindTouch_APIPutFileDescriptionauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleRequested file could not be foundUpdate access to the page is requiredInvalid input parameter or request bodyRequest completed successfullypublicDELETE:files/{fileid}/descriptionReset the file descriptionhttp://developer.mindtouch.com/en/ref/MindTouch_APIPutFileDescriptionauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleRequested file could not be foundUpdate access to the page is requiredInvalid input parameter or request bodyRequest completed successfullypublicPUT:pages/{pageid}/files/{filename}/descriptionUpdate attachment descriptionhttp://developer.mindtouch.com/en/ref/MindTouch_APIPutFileDescriptionauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects (only applies when {pageid} is present).{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file name{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleRequested file could not be foundUpdate access to the page is requiredInvalid input parameter or request bodyRequest completed successfullypublicPOST:files/{fileid}/indexre-index an attachmenthttp://developer.mindtouch.com/en/ref/MindTouch_APIIndexFileauthenticatebool?Force authentication for request (default: false){fileid}intidentifies a file by IDRequest completed successfullyMindTouch API key or Administrator access is required.internalGET:groupsRetrieve list of groups.http://developer.mindtouch.com/en/ref/MindTouch_APIGetGroupslimitstring?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 sortingoffsetint?Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)authenticatebool?Force authentication for request (default: false)groupnamefilterstring?Search for groups by name or part of a nameauthproviderint?Return groups belonging to given authentication service idRead access is requiredInvalid input parameter or request bodyRequest completed successfullypublicGET:groups/{groupid}Retrieve group informationhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetGroupauthenticatebool?Force authentication for request (default: false){groupid}stringeither an integer group ID or "=" followed by a double uri-encoded group nameInvalid input parameter or request bodyRequest completed successfullyRead access is requiredRequested group could not be foundpublicGET:groups/{groupid}/usersReturn a list of users in a grouphttp://developer.mindtouch.com/en/ref/MindTouch_APIGetGroupUsersoffsetint?Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)limitstring?Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100)activatedfilterbool?Search for users by their active statusrolefilterstring?Search for users by a role nameusernamefilterstring?Search for users by name or part of a name{groupid}stringeither an integer group ID or "=" followed by a double uri-encoded group namesortby{id, username, nick, email, fullname, date.lastlogin, status, role, service}?Sort field. Prefix value with '-' to sort descending. default: No sortingauthenticatebool?Force authentication for request (default: false)Requested group could not be foundRead access is requiredInvalid input parameter or request bodyRequest completed successfullypublicPOST:groupsAdd or modify a grouphttp://developer.mindtouch.com/en/ref/MindTouch_APIPostGroupauthenticatebool?Force authentication for request (default: false)authpasswordstring?Password to use for verification with external authentication serviceauthusernamestring?Username to use for verification with external authentication serviceInvalid input parameter or request bodyRequest completed successfullyGroup already existsRequested group could not be foundAdministrator access is requiredpublicPUT:groups/{groupid}Modify an existing grouphttp://developer.mindtouch.com/en/ref/MindTouch_APIPutGroup{groupid}stringeither an integer group ID or "=" followed by a double uri-encoded group nameauthenticatebool?Force authentication for request (default: false)Requested group could not be foundRequest completed successfullyAdministrator access is requiredInvalid input parameter or request bodypublicDELETE:groups/{groupid}Remove a grouphttp://developer.mindtouch.com/en/ref/MindTouch_APIDeleteGroupauthenticatebool?Force authentication for request (default: false){groupid}stringeither an integer group ID or "=" followed by a double uri-encoded group nameRequested group could not be foundAdministrator access is requiredInvalid input parameter or request bodyRequest completed successfullypublicPUT:groups/{groupid}/usersSet the members for a grouphttp://developer.mindtouch.com/en/ref/MindTouch_APIPutGroupUsersauthenticatebool?Force authentication for request (default: false){groupid}stringeither an integer group ID or "=" followed by a double uri-encoded group nameInvalid input parameter or request bodyRequested group could not be foundAdministrator access is requiredRequest completed successfullypublicPOST:groups/{groupid}/usersAdd members to a grouphttp://developer.mindtouch.com/en/ref/MindTouch_APIPostGroupUsersauthenticatebool?Force authentication for request (default: false){groupid}stringeither an integer group ID or "=" followed by a double uri-encoded group nameInvalid input parameter or request bodyRequest completed successfullyRequested group could not be foundAdministrator access is requiredpublicDELETE:groups/{groupid}/users/{userid}Remove given member from a grouphttp://developer.mindtouch.com/en/ref/MindTouch_APIDeleteGroupUserauthenticatebool?Force authentication for request (default: false){groupid}stringeither an integer group ID or "=" followed by a double uri-encoded group name{userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user nameAdministrator access is requiredInvalid input parameterRequested group could not be foundRequest completed successfullypublicGET:licenseRetrieve server license. Requires ADMIN permission to retrieve private information, otherwise only the public information is obtained.http://developer.mindtouch.com/en/ref/MindTouch_APIGetLicenseauthenticatebool?Force authentication for request (default: false)formatstring?Response format for license aggreement (only availble for admins; one of "html", "xml"; default: "xml")Invalid input parameter or request bodyThe request completed successfullypublicPUT:licenseUpdate server license.http://developer.mindtouch.com/en/ref/MindTouch_APIPutLicenseauthenticatebool?Force authentication for request (default: false)ADMIN access is required to set or update a licenseInvalid license, input parameter, or request bodyThe request completed successfullyinternalGET:site/nav/{pageid}/fullRetrieve <div> tags of the full navigation tree for the given page.http://developer.mindtouch.com/en/ref/MindTouch_APIGetNavigationFullredirectsint?If zero, do not follow page redirects.type{compact, expandable}?Navigation type (default: compact).format{debug, xml, html}?Output format (default: html).widthint?Max width for visible textauthenticatebool?Force authentication for request (default: false){pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleBrowse access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyRequested page could not be foundpublicGET:site/nav/{pageid}/childrenRetrieve <div> tags for the sub-pages of the given page.http://developer.mindtouch.com/en/ref/MindTouch_APIGetNavigationChildrenauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.type{compact, expandable}?Navigation type (default: compact).format{debug, xml, html}?Output format (default: html).widthint?Max width for visible textexcludeint?Page to exclude from result set.{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleBrowse access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyRequested page could not be foundpublicGET:site/nav/{pageid}/children,siblingsRetrieve <div> tags for the sub-pages and sibling pages of the given page.http://developer.mindtouch.com/en/ref/MindTouch_APIGetNavigationChildrenSiblingswidthint?Max width for visible textexcludeint?Page to exclude from result set.authenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.format{debug, xml, html}?Output format (default: html).{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleRequested page could not be foundBrowse access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicGET:site/nav/{pageid}/siblingsRetrieve <div> tags for sibling pages of the given page.http://developer.mindtouch.com/en/ref/MindTouch_APIGetNavigationSiblingsredirectsint?If zero, do not follow page redirects.format{debug, xml, html}?Output format (default: html).widthint?Max width for visible text{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false)Invalid input parameter or request bodyBrowse access to the page is requiredThe request completed successfullyRequested page could not be foundpublicGET:site/feedRetrieve feed of site changeshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetSiteChangesfilterstring?use "new" to include only newly created pages in the feed (default: all)namespacestring?Filter results by namespace (default: all namespace)languagestring?Filter results by language (default: all languages)format{all, daily, raw, rawdaily}?Format for feed (default: daily)offsetint?Skipped changes (default: 0)limitint?Number of changes to retrieve (default: 100)sincestring?Start date for changes. Date is provided in 'yyyyMMddHHmmss' format (default: ignored).authenticatebool?Force authentication for request (default: false)Invalid input parameter or request bodyThe request completed successfullySuscribe access to the page is requiredpublicGET:site/feed/newRetrieve feed of new page creationshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetSiteChangesfilterstring?use "new" to include only newly created pages in the feed (default: all)namespacestring?Filter results by namespace (default: all namespace)languagestring?Filter results by language (default: all languages)format{all, daily, raw, rawdaily}?Format for feed (default: daily)offsetint?Skipped changes (default: 0)limitint?Number of changes to retrieve (default: 100)sincestring?Start date for changes. Date is provided in 'yyyyMMddHHmmss' format (default: ignored).authenticatebool?Force authentication for request (default: false)Invalid input parameter or request bodyThe request completed successfullySuscribe access to the page is requiredpublicGET:site/activityRetrieve report on site activitieshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetSiteActivitiessincestring?Start date for report. Date is provided in 'yyyyMMddHHmmss' format (default: last 14 days).authenticatebool?Force authentication for request (default: false)Invalid input parameter or request bodyThe request completed successfullySuscribe access to the page is requiredpublicGET:pages/{pageid}/feedRetrieve feed of page changeshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPageChangesdepthstring?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)offsetint?Skipped changes (default: 0)limitint?Number of changes to retrieve (default: 100)sincestring?Start date for changes. Date is provided in 'yyyyMMddHHmmss' format (default: ignored).{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titletimezonestring?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)authenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.filterstring?use "new" to include only newly created pages in the feed (default: all)Read/suscribe access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyRequested page could not be foundpublicGET:pages/{pageid}/feed/newRetrieve feed of new page creationshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPageChangesdepthstring?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)offsetint?Skipped changes (default: 0)limitint?Number of changes to retrieve (default: 100)sincestring?Start date for changes. Date is provided in 'yyyyMMddHHmmss' format (default: ignored).{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titletimezonestring?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)authenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.filterstring?use "new" to include only newly created pages in the feed (default: all)Read/suscribe access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyRequested page could not be foundpublicGET:users/{userid}/feedRetrieve feed of user contributionshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetUserContributionssincestring?Start date for changes. Date is provided in 'yyyyMMddHHmmss' format (default: ignored).{userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user nameauthenticatebool?Force authentication for request (default: false)offsetint?Skipped changes (default: 0)limitint?Number of changes to retrieve (default: 100)format{all, daily, raw, rawdaily}?Format for feed (default: daily)Requested user could not be foundSuscribe access is requiredInvalid input parameter or request bodyThe request completed successfullypublicGET:users/{userid}/favorites/feedDEPRECATED: Retrieve feed of user favorites changeshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetUserFavoritesChanges{userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user namesincestring?Start date for changes. Date is provided in 'yyyyMMddHHmmss' format (default: ignored).authenticatebool?Force authentication for request (default: false)format{all, daily, raw, rawdaily}?Format for feed (default: daily)offsetint?Skipped changes (default: 0)limitint?Number of changes to retrieve (default: 100)The request completed successfullySuscribe access to the page is requiredRequested user could not be foundInvalid input parameter or request bodypublicGET:pages/{pageid}Retrieve aggregate page information including attachmentshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPagerevisionstring?Page revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revisionformat{html, xhtml}?Result format (default: html)mode{edit, raw, view}render content for different uses; default is 'view'includestring?Extra elements to include (choice of "contents"; default: include nothing extra)excludestring?Elements to exclude from response document (choice of "inbound", "outbound"; default: exclude nothing)redirectsint?If zero, do not follow page redirects.{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false)Read access to the page is requiredRequested page could not be foundInvalid input parameter or request bodyThe request completed successfullypublicPOST:pages/{pageid}/allowedFilter a list of user ids based on access to the pagehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPageAllowedUsersfilterdisabledbool?DEPRECATED: Will always filter disabled users, regardless of permissionspermissionsstring?A comma separated list of permissions that must be satisfied (e.g read, etc.). Defaults to read, if not provided{pageid}intinteger page IDRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyRequested page could not be foundpublicGET:pages/{pageid}/diffShow changes between revisionshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPageDiffmode{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'revisionstring?Page revision to retrieve. 'head' by default will retrieve latest revision. Positive integer will retrieve specific revisionredirectsint?If zero, do not follow page redirects.previousstring?Previous page revision to retrieve. 'head' by default will retrieve latest revision. Positive integer will retrieve specific revision{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleformat{html, xhtml}?Result format (default: html)authenticatebool?Force authentication for request (default: false)The request completed successfullyInvalid input parameter or request bodyRequested page could not be foundRead access to the page is requiredpublicGET:pages/{pageid}/infoRetrieve page informationhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPageInfoauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleThe request completed successfullyRequested page could not be foundRead access to the page is requiredInvalid input parameter or request bodypublicGET:pages/{pageid}/pdfExport a page to PDFhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPageExportPDFauthenticatebool?Force authentication for request (default: false){pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleshowtocboolflag to display a table of contents in the exported documentsytlesheetstringname of custom stylesheet to apply (stored in site/properties with namespace 'mindtouch.prince.stylesheet#formatstringformat to export: pdf | html (default: pdf)deepboolflag to export the requested page and all subpages (default: false)Requested page could not be foundRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicGET:pages/{pageid}/linksRetrieve list of inbound or outbound page linkshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPageLinksauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.dir{from, to}links pointing to a page or from a page{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleRead access to the page is requiredRequested page could not be foundInvalid input parameter or request bodyThe request completed successfullypublicGET:pages/{pageid}/subpagesRetrieve list of sub-pageshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPageSubpagesauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.offsetint?Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)limitstring?Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100){pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleRequested page could not be foundRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicGET:pages/{pageid}/aliasesRetrieve list of page aliaseshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPageAliases{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.Read access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyRequested page could not be foundpublicGET:pages/{pageid}/revisionsRetrieve revision history of a given titlehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPageRevisionsrevisionint?Page revision to retrieveredirectsint?If zero, do not follow page redirects.offsetint?Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0){pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titlelimitstring?Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 50)authenticatebool?Force authentication for request (default: false)Read access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyRequested page could not be foundpublicGET:pages/{pageid}/filesRetrieves a list of files for a given pagehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPageFilesredirectsint?If zero, do not follow page redirects.{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false)Requested page could not be foundRead access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicGET:pages/{pageid}/files,subpagesRetrieves a list of files and subpages for a given pagehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPageSubpagesAndFilesauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleThe request completed successfullyInvalid input parameter or request bodyRequested page could not be foundRead access to the page is requiredpublicPOST:pages/{pageid}/revertRevert page to an earlier revisionhttp://developer.mindtouch.com/en/ref/MindTouch_APIPostPageRevertauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titlefromrevisionintRevision number of page that will become the new head revisionInvalid input parameter or request bodyThe request completed successfullyUpdate access to the page is requiredRequested page could not be foundpublicPOST:pages/{pageid}/copyCopy page to a new locationhttp://developer.mindtouch.com/en/ref/MindTouch_APIPostPageCopychildrenbool?Copy child pages? (default: false)talkpagesbool?Copy talk pages? (default: true)attachmentsbool?Copy attachments? (default: true)tagsbool?Copy tags? (default: true)authenticatebool?Force authentication for request (default: false)titlestring?Set the title of the page. (default: same as original title){pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titletostringnew page location including the path and name of the pageRequested page could not be foundThe request completed successfullyInvalid input parameter or request bodyPage move would conflict with an existing pageUpdate access to the page is requiredpublicPOST:pages/{pageid}/moveMove page to a new locationhttp://developer.mindtouch.com/en/ref/MindTouch_APIPostPageMoveredirectsint?If zero, do not follow page redirects.authenticatebool?Force authentication for request (default: false)parentidint?Relocate the page under a given parent pagenamestring?Move the page to the given name while keeping it under the same parent pagetostring?new page location including the path and name of the page{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titletitlestring?Set the title of the page. The name of a page is also modified unless it's providedUpdate access to the page is requiredInvalid input parameter or request bodyRequested page could not be foundThe request completed successfullyPage move would conflict with an existing pagepublicGET:pages/{pageid}/contentsRetrieve the contents of a page.http://developer.mindtouch.com/en/ref/MindTouch_APIGetPageContentspageidint?For template pages, use specified page ID as context for template invocation (default: none)includebool?Treat page as an include (default: false)sectionint?The section number (default: none)format{html, xhtml}?Result format (default: html)highlightstring?Comma separated list of terms to highlight (default: empty)mode{edit, raw, view}render content for different uses; default is 'view'redirectsint?If zero, do not follow page redirects.{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false)revisionstring?Page revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revisionreltoint?Page used for path normalization (default: none)reltopathstring?Page used for path normalization. Ignored if relto parameter is defined. (default: none)Page contents could not be parsed in its native format and was returned in an alternative format insteadRequested page could not be foundUpdate access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicGET:pages/{pageid}/contents/explainExplain how contents of a page are rendered.http://developer.mindtouch.com/en/ref/MindTouch_APIGetPageContentspageidint?For template pages, use specified page ID as context for template invocation (default: none)includebool?Treat page as an include (default: false)sectionint?The section number (default: none)format{html, xhtml}?Result format (default: html)highlightstring?Comma separated list of terms to highlight (default: empty)mode{edit, raw, view}render content for different uses; default is 'view'redirectsint?If zero, do not follow page redirects.{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false)revisionstring?Page revision to retrieve. 'head' by default will retrieve latest revision. positive integer will retrieve specific revisionreltoint?Page used for path normalization (default: none)reltopathstring?Page used for path normalization. Ignored if relto parameter is defined. (default: none)Page contents could not be parsed in its native format and was returned in an alternative format insteadRequested page could not be foundUpdate access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicPOST:pages/{pageid}/contentsUpdate contents of a pagehttp://developer.mindtouch.com/en/ref/MindTouch_APIPostPageContentsoverwritebool?New page revision is created when no changes are detected when overwrite is true (default: false)reltopathstring?Page used for path normalization. Ignored if relto parameter is defined. (default: none)reltoint?Page used for path normalization (default: none)tidy{remove, convert}?Determines if invalid content is converted to text or removed (default: 'convert')redirectsint?If zero, do not follow page redirects.abort{never, modified, exists}?specifies condition under which to prevent the save; default is neverxpathstring?identifies the portion of the page to update; this parameter is ignored if section is specifiedsectionint?the section number. If zero, append as a new sectiontitlestring?the display title (default: use existing title or determine from page path.)languagestring?the page language (default: determine culture from parent)commentstring?the edit commentedittimestringthe previous revision's edit timestamp (yyyyMMddHHmmss or yyyy-MM-ddTHH:mm:ssZ) or "now" to bypass concurrent edit check{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titlerestrictionstring?Optionally set the restriction of the pageimporttimestring?If this is an import, the edit timestamp of the imported content (yyyyMMddHHmmss or yyyy-MM-ddTHH:mm:ssZ)authenticatebool?Force authentication for request (default: false)Update access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyRequested page could not be foundpublicPOST:pages/{pageid}/revisionsPerforms operations such as hide/unhide for revisions of pageshttp://developer.mindtouch.com/en/ref/MindTouch_APIPostPageRevisionsauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.commentstring?Reason for hiding revisions{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleThe request completed successfullyDELETE access is required to hide a revision and ADMIN access to unhideRequested page could not be foundInvalid input parameter or request bodypublicPOST:pages/{pageid}/indexre-index a page and it's attributeshttp://developer.mindtouch.com/en/ref/MindTouch_APIIndexPage{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.MindTouch API key or Administrator access is required.Invalid input parameter or request bodyThe request completed successfullyRequested page could not be foundinternalDELETE:pages/{pageid}Deletes a page and optionally descendant pages by moving them to the archivehttp://developer.mindtouch.com/en/ref/MindTouch_APIDeletePageauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.recursivebool?only delete page or delete page and descendants. Default: false{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleRequested page could not be foundUpdate/delete access to the page is requiredInvalid input parameter or request bodyRequest completed successfullypublicGET:pagesBuilds a site map starting from 'home' page.http://developer.mindtouch.com/en/ref/MindTouch_APIGetPagesauthenticatebool?Force authentication for request (default: false){pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titlestartpagebool?For HTML sitemap, indicates if the start page should be included (default: true)format{xml, html, google}?Result format (default: xml)languagestring?Filter results by language (default: all languages)Invalid input parameter or request bodyBrowse access to the page is requiredRequested page could not be foundThe request completed successfullypublicGET:pages/{pageid}/treeBuilds a site map starting from a given page.http://developer.mindtouch.com/en/ref/MindTouch_APIGetPagesauthenticatebool?Force authentication for request (default: false){pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titlestartpagebool?For HTML sitemap, indicates if the start page should be included (default: true)format{xml, html, google}?Result format (default: xml)languagestring?Filter results by language (default: all languages)Invalid input parameter or request bodyBrowse access to the page is requiredRequested page could not be foundThe request completed successfullypublicGET:pages/popularRetrieves a list of popular pages.http://developer.mindtouch.com/en/ref/MindTouch_APIGetPopularPageslimitstring?Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 50)authenticatebool?Force authentication for request (default: false)languagestring?Filter results by language (default: all languages)offsetint?Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)The request completed successfullypublicPOST:pages/{pageid}/exportGenerates the information so that clients can stream down the exported page(s) in mtarc formathttp://developer.mindtouch.com/en/ref/MindTouch_APIPostExportPageTreepageidintThe pageid for the page that you want to exportThe request completed successfullyOnly logged in users can calls this methodpublicGET:pages/{pageid}/export/{token}/{filename}Retrieve the mtarc tree export for the specific page using the token and providing an optional filename for the file to download.http://developer.mindtouch.com/en/ref/MindTouch_APIGetExportPageTreerecursivebool?Used to indicate if we export the full tree under the provided pageidreltoint?Export relative to page idreltopathstring?Export relative to uri pathdryrunbool?Used to indicate that a simulated run will be done. Default is falsetokenstringA token that specifies the location of the page that we want to exportpageidintThe page's idOnly logged in users can calls this methodThe request completed successfullypublicGET:pages/{pageid}/export/{token}Retrieve the mtarc tree export for the specific page using the tokenhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetExportPageTreerecursivebool?Used to indicate if we export the full tree under the provided pageidreltoint?Export relative to page idreltopathstring?Export relative to uri pathdryrunbool?Used to indicate that a simulated run will be done. Default is falsetokenstringA token that specifies the location of the page that we want to exportpageidintThe page's idOnly logged in users can calls this methodThe request completed successfullypublicPUT:pages/{pageid}/importImport a tree of pages (mtarc format) into an instance at pageid as the roothttp://developer.mindtouch.com/en/ref/MindTouch_APIPutImportPageTreebehaviorstringSpecify the semantics of the call between blocking and non-blocking. Valid values are sync and async, default value is sync.filenamestringThe name of the file being uploadedpageidintThe page's id of the page that we want to use as the root of the importThe provided pageid does not match an existent pageReturned when the caching server fails to add, replace or fetch objects, or an unexpected error happensReturned when the user is not logged in, the size of the file exceeds the limit, or we could not establish a connection to the caching serverThe upload and import were successful (sync), or the upload and the request to import the content was successful (async)publicGET:pages/{pageid}/import/status/{token}Poll the status of an import identified by token into pageidhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetImportStatus{token}stringA token returned as part of the url that PUT:pages/{pageid}/import returns{pageid}intA page's idThe import's status is found and returned successfullyThe provided token does not match a requested import jobpublicGET:pages/{pageid}/securityRetrieve page security infohttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPageSecurityauthenticatebool?Force authentication for request (default: false){pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleredirectsint?If zero, do not follow page redirects.Invalid input parameter or request bodyRequested page could not be foundThe request completed successfullyBrowse access to the page is requiredpublicDELETE:pages/{pageid}/securityReset page restricts and grantshttp://developer.mindtouch.com/en/ref/MindTouch_APIDeletePageSecurityauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleThe requested page could not be foundThe request completed successfullyChange permissions access to the page is requiredInvalid input parameter or request bodypublicPUT:pages/{pageid}/securitySet page security infohttp://developer.mindtouch.com/en/ref/MindTouch_APIPutPageSecurityredirectsint?If zero, do not follow page redirects.{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?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: noneChange permissions access to the page is requiredInvalid input parameter or request bodyRequested page could not be foundThe request completed successfullypublicPOST:pages/{pageid}/securityModify page security by adding and removing grantshttp://developer.mindtouch.com/en/ref/MindTouch_APIPostPageSecurity{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titlecascade{none, delta}Apply proposed security to child pages. default: noneredirectsint?If zero, do not follow page redirects.authenticatebool?Force authentication for request (default: false)Change permissions access to the page is requiredInvalid input parameter or request bodyThe request completed successfullyRequested page could not be foundpublicPOST:pages/{pageid}/message/*//*Post a custom page event into the pubsub bus (limited to 128KB)http://developer.mindtouch.com/en/ref/MindTouch_APIPostPageMessage{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleInvalid input parameter or request bodyA logged-in user is requiredThe request completed successfullypublicGET:pages/{pageid}/propertiesRetrieve the properties associated with a pagehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetResourcePropertiesPagesauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.namesstring?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}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titlecontentcutoffint?Only show property content shorter than this number of bytes. Default: 2048Requested page could not be foundREAD access is requiredInvalid input parameter or request bodyThe request completed successfullypublicGET:files/{fileid}/propertiesRetrieve the properties associated with a file attachmenthttp://developer.mindtouch.com/en/ref/MindTouch_APIGetResourcePropertiesFilesnamesstring?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 propertiescontentcutoffint?Only show property content shorter than this number of bytes. Default: 2048{fileid}intidentifies a file by IDredirectsint?If zero, do not follow page redirects.authenticatebool?Force authentication for request (default: false)Requested file could not be foundREAD access is requiredThe request completed successfullyInvalid input parameter or request bodypublicGET:users/{userid}/propertiesRetrieve the properties associated with a userhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetResourcePropertiesUsers{userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user nameauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.namesstring?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 propertiescontentcutoffint?Only show property content shorter than this number of bytes. Default: 2048Requested user could not be foundInvalid input parameter or request bodyThe request completed successfullyADMIN access is required to access other user's propertiespublicGET:site/propertiesRetrieve the properties associated with the sitehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetResourcePropertiesSitecontentcutoffint?Only show property content shorter than this number of bytes. Default: 2048namesstring?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 propertiesauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.ADMIN access is requiredThe request completed successfullyInvalid input parameterpublicGET:site/search/propertiesRetrieve all pages with a specified propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPagesWithPropertynamestringThe name of the property to search forauthenticatebool?Force authentication for request (default: false)verbosebool?Show verbose page output. default: trueThe request completed successfullyInvalid input parameter or request bodypublicGET:pages/{pageid}/properties/{key}Retrieve the content of a page propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetResourcePropertyPagesauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.{key}stringA unique identifier for a property that is obtained through GET:pages/{pageid}/properties{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleInvalid input parameter or request bodyRequested page and/or property could not be foundREAD access is requiredThe request completed successfullypublicGET:files/{fileid}/properties/{key}Retrieve the content of an attachment propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetResourcePropertyFilesauthenticatebool?Force authentication for request (default: false){key}stringA unique identifier for a property that is obtained through GET:files/{fileid}/properties{fileid}intidentifies a file by IDredirectsint?If zero, do not follow page redirects.Invalid input parameter or request bodyThe request completed successfullyREAD access is requiredRequested file and/or property could not be foundpublicGET:users/{userid}/properties/{key}Retrieve the content of a user propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetResourcePropertyUsersauthenticatebool?Force authentication for request (default: false){key}stringA unique identifier for a property that is obtained through GET:users/{userid}/properties{userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user nameredirectsint?If zero, do not follow page redirects.Invalid input parameter or request bodyADMIN access is required to access other user's propertiesThe request completed successfullyRequested user and/or property could not be foundpublicGET:site/properties/{key}Retrieve the content of a site propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetResourcePropertySiteauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.{key}stringA unique identifier for a property that is obtained through GET:site/propertiesInvalid input parameter or request bodyThe request completed successfullyRequested property could not be foundADMIN access is requiredpublicGET:pages/{pageid}/properties/{key}/infoRetrieve the metadata about a page propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetResourcePropertyContentsPagesauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.contentcutoffint?Only show property content shorter than this number of bytes. Default: 2048{key}stringA unique identifier for a property that is obtained through GET:pages/{pageid}/properties{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleInvalid input parameter or request bodyThe request completed successfullyREAD access is requiredRequested page and/or property could not be foundpublicGET:files/{fileid}/properties/{key}/infoRetrieve the metadata about an attachment propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetResourcePropertyContentsFilesredirectsint?If zero, do not follow page redirects.authenticatebool?Force authentication for request (default: false){key}stringA unique identifier for a property that is obtained through GET:files/{fileid}/properties{fileid}intidentifies a file by IDcontentcutoffint?Only show property content shorter than this number of bytes. Default: 2048Requested file and/or property could not be foundREAD access is requiredThe request completed successfullyInvalid input parameter or request bodypublicGET:users/{userid}/properties/{key}/infoRetrieve the metadata about a user propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetResourcePropertyContentsUsersauthenticatebool?Force authentication for request (default: false)contentcutoffint?Only show property content shorter than this number of bytes. Default: 2048redirectsint?If zero, do not follow page redirects.{userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user name{key}stringA unique identifier for a property that is obtained through GET:users/{userid}/propertiesRequested user and/or property could not be foundThe request completed successfullyInvalid input parameter or request bodyADMIN access is required to access other user's propertiespublicGET:site/properties/{key}/infoRetrieve the metadata about a site propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetResourcePropertyContentsSiteauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.contentcutoffint?Only show property content shorter than this number of bytes. Default: 2048{key}stringA unique identifier for a property that is obtained through GET:site/propertiesADMIN access is requiredInvalid input parameter or request bodyThe request completed successfullyRequested property could not be foundpublicPUT:pages/{pageid}/propertiesPerform changes on multiple page propertieshttp://developer.mindtouch.com/en/ref/MindTouch_APIPutResourcePropertiesPagesauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleInvalid input parameter or request bodyRequested page could not be foundUPDATE access is requiredThe request completed successfullypublicPUT:files/{fileid}/propertiesPerform changes on multiple attachment propertieshttp://developer.mindtouch.com/en/ref/MindTouch_APIPutResourcePropertiesFilesauthenticatebool?Force authentication for request (default: false){fileid}intidentifies a file by IDredirectsint?If zero, do not follow page redirects.Invalid input parameter or request bodyUPDATE access is requiredThe request completed successfullyRequested file could not be foundpublicPUT:users/{userid}/propertiesPerform changes on multiple user propertieshttp://developer.mindtouch.com/en/ref/MindTouch_APIPutResourcePropertiesUsersauthenticatebool?Force authentication for request (default: false){userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user nameredirectsint?If zero, do not follow page redirects.ADMIN access is required to access other user's propertiesRequested user could not be foundInvalid input parameter or request bodyThe request completed successfullypublicPUT:site/propertiesPerform changes on multiple site propertieshttp://developer.mindtouch.com/en/ref/MindTouch_APIPutResourcePropertiesSiteauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.The request completed successfullyInvalid input parameter or request bodyADMIN access is requiredpublicPOST:pages/{pageid}/propertiesCreate a page propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIPostResourcePropertyPagesauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.descriptionstring?Description of property{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleabort{never, modified, exists}?Specifies condition under which to prevent the creation; default is exists.Invalid input parameter or request bodyThe request completed successfullyRequested page could not be foundUPDATE access is requiredpublicPOST:files/{fileid}/propertiesCreate an attachment propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIPostResourcePropertyFilesabort{never, modified, exists}?Specifies condition under which to prevent the creation; default is exists.authenticatebool?Force authentication for request (default: false)descriptionstring?Description of property{fileid}intidentifies a file by IDredirectsint?If zero, do not follow page redirects.UPDATE access is requiredInvalid input parameter or request bodyThe request completed successfullyRequested file could not be foundpublicPOST:users/{userid}/propertiesCreate a user propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIPostResourcePropertyUsersauthenticatebool?Force authentication for request (default: false)abort{never, modified, exists}?Specifies condition under which to prevent the creation; default is exists.descriptionstring?Description of property{userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user nameredirectsint?If zero, do not follow page redirects.The request completed successfullyInvalid input parameter or request bodyRequested user could not be foundADMIN access is required to access other user's propertiespublicPOST:site/propertiesCreate a site propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIPostResourcePropertySitedescriptionstring?Description of propertyredirectsint?If zero, do not follow page redirects.abort{never, modified, exists}?Specifies condition under which to prevent the creation; default is exists.authenticatebool?Force authentication for request (default: false)Invalid input parameter or request bodyThe request completed successfullyADMIN access is requiredpublicPUT:pages/{pageid}/properties/{key}Update an existing page propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIPutResourcePropertyPagesabort{never, modified, exists}?Specifies condition under which to prevent the update; default is modified.redirectsint?If zero, do not follow page redirects.etagstring?Etag of the current version of the property. Can alternatively be provided via ETag header.descriptionstring?Description of propertyauthenticatebool?Force authentication for request (default: false){pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page title{key}stringA unique identifier for a property that is obtained through GET:pages/{pageid}/propertiesRequested page and/or property could not be foundThe request completed successfullyInvalid input parameter or request bodyUPDATE access is requiredpublicPUT:pages/{pageid}/files/{filename}/properties/{key}Update an existing attachment propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIPutResourcePropertyFiles{key}stringA unique identifier for a property that is obtained through GET:files/{fileid}/properties{fileid}intidentifies a file by IDdescriptionstring?Description of propertyauthenticatebool?Force authentication for request (default: false)abort{never, modified, exists}?Specifies condition under which to prevent the update; default is modified.redirectsint?If zero, do not follow page redirects.etagstring?Etag of the current version of the property. Can alternatively be provided via ETag header.Requested file and/or property could not be foundUPDATE access is requiredThe request completed successfullyInvalid input parameter or request bodypublicPUT:files/{fileid}/properties/{key}Update an existing attachment propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIPutResourcePropertyFiles{key}stringA unique identifier for a property that is obtained through GET:files/{fileid}/properties{fileid}intidentifies a file by IDdescriptionstring?Description of propertyauthenticatebool?Force authentication for request (default: false)abort{never, modified, exists}?Specifies condition under which to prevent the update; default is modified.redirectsint?If zero, do not follow page redirects.etagstring?Etag of the current version of the property. Can alternatively be provided via ETag header.Requested file and/or property could not be foundUPDATE access is requiredThe request completed successfullyInvalid input parameter or request bodypublicPUT:users/{userid}/properties/{key}Update an existing user propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIPutResourcePropertyUsersetagstring?Etag of the current version of the property. Can alternatively be provided via ETag header.{key}stringA unique identifier for a property that is obtained through GET:users/{userid}/properties{userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user nameauthenticatebool?Force authentication for request (default: false)abort{never, modified, exists}?Specifies condition under which to prevent the update; default is modified.redirectsint?If zero, do not follow page redirects.descriptionstring?Description of propertyRequested user and/or property could not be foundADMIN access is required to access other user's propertiesInvalid input parameter or request bodyThe request completed successfullypublicPUT:site/properties/{key}Update an existing site propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIPutResourcePropertySiteabort{never, modified, exists}?Specifies condition under which to prevent the update; default is modified.{key}stringA unique identifier for a property that is obtained through GET:site/propertiesetagstring?Etag of the current version of the property. Can alternatively be provided via ETag header.authenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.descriptionstring?Description of propertyRequested property could not be foundADMIN access is requiredInvalid input parameter or request bodyThe request completed successfullypublicDELETE:pages/{pageid}/properties/{key}Remove a page propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIDeleteResourcePropertyPagesauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.{key}stringA unique identifier for a property that is obtained through GET:pages/{pageid}/properties{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleInvalid input parameter or request bodyUPDATE access is requiredRequested page and/or property could not be foundThe request completed successfullypublicDELETE:files/{fileid}/properties/{key}Remove an attachment propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIDeleteResourcePropertyFiles{fileid}intidentifies a file by IDauthenticatebool?Force authentication for request (default: false){key}stringA unique identifier for a property that is obtained through GET:files/{fileid}/propertiesredirectsint?If zero, do not follow page redirects.Requested file and/or property could not be foundUPDATE access is requiredInvalid input parameter or request bodyThe request completed successfullypublicDELETE:users/{userid}/properties/{key}Remove a user propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIDeleteResourcePropertyUsers{userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user nameauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.{key}stringA unique identifier for a property that is obtained through GET:users/{userid}/propertiesRequested user and/or property could not be foundADMIN access is required to access other user's propertiesInvalid input parameter or request bodyThe request completed successfullypublicDELETE:site/properties/{key}Remove a site propertyhttp://developer.mindtouch.com/en/ref/MindTouch_APIDeleteResourcePropertySiteredirectsint?If zero, do not follow page redirects.authenticatebool?Force authentication for request (default: false){userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user name{key}stringA unique identifier for a property that is obtained through GET:site/propertiesADMIN access is requiredRequested property could not be foundThe request completed successfullyInvalid input parameter or request bodypublicGET:pages/{pageid}/ratingsRetrieve the page ratinghttp://developer.mindtouch.com/en/ref/MindTouch_APIGetPageRatingauthenticatebool?Force authentication for request (default: false)redirectsint?If zero, do not follow page redirects.publicPOST:pages/{pageid}/ratingsRate the quality of a pagehttp://developer.mindtouch.com/en/ref/MindTouch_APIPostPageRatingredirectsint?If zero, do not follow page redirects.{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false)scoreintA '0' or '1' respectively indicating a poor or good rating. A value of '' will reset a rating.Requested page could not be foundThe request completed successfullyREAD access to the page is requiredInvalid input parameterpublicGET:site/rolesRetrieve list of defined roleshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetSiteRolesauthenticatebool?Force authentication for request (default: false)The request completed successfullypublicGET:site/roles/{roleid}Retrieve a rolehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetSiteRoleauthenticatebool?Force authentication for request (default: false){roleid}stringeither an integer role ID or "=" followed by a double uri-encoded role nameThe request completed successfullyRequested role could not be foundInvalid input parameter or request bodypublicPUT:site/roles/{roleid}Modify or add a rolehttp://developer.mindtouch.com/en/ref/MindTouch_APIPutSiteRoleauthenticatebool?Force authentication for request (default: false){roleid}stringeither an integer role ID or "=" followed by a double uri-encoded role nameRequested role could not be foundThe request completed successfullyAdministrator access is requiredInvalid input parameter or request bodypublicGET:site/operationsRetrieve all known security operationshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetSiteOperationsauthenticatebool?Force authentication for request (default: false)The request completed successfullypublicGET:pages/{pageid}/tagsRetrieve the tags on a page.http://developer.mindtouch.com/en/ref/MindTouch_APIGetPageTagsredirectsint?If zero, do not follow page redirects.authenticatebool?Force authentication for request (default: false){pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleThe request completed successfullyInvalid input parameter or request bodyRead access to the page is requiredThe requested page could not be foundpublicPUT:pages/{pageid}/tagsSets the tags on a page.http://developer.mindtouch.com/en/ref/MindTouch_APISetPageTagsredirectsint?If zero, do not follow page redirects.{pageid}stringeither an integer page ID, "home", or "=" followed by a double uri-encoded page titleauthenticatebool?Force authentication for request (default: false)The requested page could not be foundUpdate access to the page is requiredInvalid input parameter or request bodyThe request completed successfullypublicGET:site/tagsRetrieve all tagshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetTagsauthenticatebool?Force authentication for request (default: false)qstring?partial tag name to match (ex: tagprefix) (default none)pagesbool?show pages with each tag (default: false)tostring?end date for type=date (ex: 2008-12-30) (default: now + 30 days)fromstring?start date for type=date (ex: 2008-01-30) (default: now)typestring?type of the tag (text | date | user | define) (default: all types)Invalid input parameter or request bodyThe request completed successfullyRead access to the page is requiredThe requested page could not be foundpublicGET:site/tags/{tagid}Retrieve pages with taghttp://developer.mindtouch.com/en/ref/MindTouch_APIGetTaggedPages{tagid}stringeither an integer tag ID or "=" followed by a double uri-encoded tag namelanguagestring?filter pages by language (default: all languages)authenticatebool?Force authentication for request (default: false)Invalid input parameter or request bodyThe requested page could not be foundThe request completed successfullyRead access to the page is requiredpublicGET:archiveRetrieves a summary of available archive informationhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetArchiveauthenticatebool?Force authentication for request (default: false)The request completed successfullyAdministrator access is requiredpublicGET:archive/filesRetrieves file info for all deleted fileshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetArchiveFilesauthenticatebool?Force authentication for request (default: false)The request completed successfullyAdministrator access is requiredpublicGET:archive/files/{fileid}/{filename}Retrieve file attachment contenthttp://developer.mindtouch.com/en/ref/MindTouch_APIGetArchiveFile{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file nameauthenticatebool?Force authentication for request (default: false)The request completed successfullyInvalid input parameter or request bodyRequested file could not be found in the archiveAdministrator access is requiredpublicGET:archive/files/{fileid}Retrieves file content for a deleted filehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetArchiveFile{fileid}intidentifies a file by ID{filename}string"=" followed by a double uri-encoded file nameauthenticatebool?Force authentication for request (default: false)The request completed successfullyInvalid input parameter or request bodyRequested file could not be found in the archiveAdministrator access is requiredpublicGET:archive/files/{fileid}/infoRetrieves file info for a deleted filehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetArchiveFileInfo{fileid}intidentifies a file by IDauthenticatebool?Force authentication for request (default: false)Administrator access is requiredThe request completed successfullyRequested file could not be found in the archiveInvalid input parameter or request bodypublicDELETE:archive/files/{fileid}Remove a file from the archive (wipe)http://developer.mindtouch.com/en/ref/MindTouch_APIDeleteArchiveFileauthenticatebool?Force authentication for request (default: false){fileid}intidentifies a file by IDRequested file could not be found in the archiveAdministrator access is requiredInvalid input parameter or request bodyRequest completed successfullypublicDELETE:archive/filesRemoves all files from the archive (wipe)http://developer.mindtouch.com/en/ref/MindTouch_APIDeleteArchiveFilesauthenticatebool?Force authentication for request (default: false)The request completed successfullyAdministrator access is requiredpublicPOST:archive/files/restore/{fileid}Restores a deleted file back to its pagehttp://developer.mindtouch.com/en/ref/MindTouch_APIPostArchiveFilesRestoretostring?Optional restore-to page to override a removed file's original parent id{fileid}intidentifies a file by IDauthenticatebool?Force authentication for request (default: false)Administrator access is requiredThe request completed successfullyRequested file could not be found in the archiveInvalid input parameter or request bodypublicGET:archive/pagesRetrieve the pages that can be potentially restored from deletion.http://developer.mindtouch.com/en/ref/MindTouch_APIGetArchivePagesauthenticatebool?Force authentication for request (default: false)offsetint?Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)limitstring?Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100)titlestring?Show deleted pages matching the given title. (default: all pages)The request completed successfullyAdministrator access is requiredpublicGET:archive/pages/{pageid}Retrieve basic page information for the deleted pagehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetArchivePagesInfoauthenticatebool?Force authentication for request (default: false){pageid}stringAn integer page ID of a deleted pageThe request completed successfullyAdministrator access is requiredpublicGET:archive/pages/{pageid}/infoRetrieve basic page information for the deleted pagehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetArchivePagesInfoauthenticatebool?Force authentication for request (default: false){pageid}stringAn integer page ID of a deleted pageThe request completed successfullyAdministrator access is requiredpublicGET:archive/pages/{pageid}/subpagesRetrieve the child pages that were deleted as well from deleting the given pagehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetArchivePageSubpages{pageid}stringAn integer page ID of a deleted pageauthenticatebool?Force authentication for request (default: false)The request completed successfullyAdministrator access is requiredpublicGET:archive/pages/{pageid}/contentsRetrieve the contents of a deleted page for previewinghttp://developer.mindtouch.com/en/ref/MindTouch_APIGetArchivePageContentsauthenticatebool?Force authentication for request (default: false){pageid}stringAn integer page ID of a deleted pageAdministrator access is requiredThe request completed successfullypublicPOST:archive/pages/{pageid}/restoreRestore all revisions of a given pagehttp://developer.mindtouch.com/en/ref/MindTouch_APIPostArchivePagesPageIdRestore{pageid}intAn integer page ID from GET: archive/pagesreasonstring?Reason for revertingtostringnew page titleauthenticatebool?Force authentication for request (default: false)A title with the same path already exists. To restoring to a different path with '?to='Unable to find the page to deleteAdministrator access is requiredThe request completed successfullypublicGET:site/servicesRetrieve list of services.http://developer.mindtouch.com/en/ref/MindTouch_APIGetServicessortby{description, type, init, sid, uri}?Sort field. Prefix value with '-' to sort descending. default: No sortingauthenticatebool?Force authentication for request (default: false)offsetint?Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)limitstring?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 allMindTouch API key or Administrator access is required.Invalid input parameter or request bodyThe request completed successfullypublicGET:site/services/{id}Retrieve service.http://developer.mindtouch.com/en/ref/MindTouch_APIGetServiceById{id}stringidentifies a service by ID or ={namespace}authenticatebool?Force authentication for request (default: false)The request completed successfullyRequested service could not be foundMindTouch API key or Administrator access is required.Invalid input parameter or request bodypublic*:site/services/{id}/proxy//*Proxy requets to a service.http://developer.mindtouch.com/en/ref/MindTouch_APIProxyToServiceauthenticatebool?Force authentication for request (default: false){id}stringidentifies a service by ID or ={namespace}Invalid input parameter or request bodyRequested service could not be foundMindTouch API key or Administrator access is required.The request completed successfullypublicPOST:site/services/{id}Restart a service (backwards compatibility)http://developer.mindtouch.com/en/ref/MindTouch_APIPostServicesIdauthenticatebool?Force authentication for request (default: false){id}intidentifies a service by IDMindTouch API key or Administrator access is required.Invalid input parameter or request bodyThe request completed successfullyRequested service could not be foundinternalPUT:site/services/{id}Update a servicehttp://developer.mindtouch.com/en/ref/MindTouch_APIPostServicesIdauthenticatebool?Force authentication for request (default: false){id}intidentifies a service by IDMindTouch API key or Administrator access is required.Invalid input parameter or request bodyThe request completed successfullyRequested service could not be foundinternalPOST:site/servicesAdd a service (backward compatibility: empty body will restart all services)http://developer.mindtouch.com/en/ref/MindTouch_APIPostServicesauthenticatebool?Force authentication for request (default: false)MindTouch API key or Administrator access is required.The request completed successfullyinternalDELETE:site/services/{id}Delete a servicehttp://developer.mindtouch.com/en/ref/MindTouch_APIDeleteSiteServiceauthenticatebool?Force authentication for request (default: false)The request completed successfullyMindTouch API key or Administrator access is required.internalPOST:site/services/{id}/startStart or restart a servicehttp://developer.mindtouch.com/en/ref/MindTouch_APIPostServiceIdStartauthenticatebool?Force authentication for request (default: false)MindTouch API key or Administrator access is required.The request completed successfullyinternalPOST:site/services/{id}/stopStop a servicehttp://developer.mindtouch.com/en/ref/MindTouch_APIPostServiceIdStopauthenticatebool?Force authentication for request (default: false)MindTouch API key or Administrator access is required.The request completed successfullyinternalGET:site/statusGet mindtouch instance status informationhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetSiteStatusThe request completed successfullyUser must be logged inInvalid input parameter or request bodypublicGET:site/functionsGet list of available extensionshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetSiteFunctionsauthenticatebool?Force authentication for request (default: false)format{html, body, xml}?output format (default: html)Invalid input parameter or request bodyThe request completed successfullyUser must be logged inpublicGET:site/localizationRetrieve a resource string localized for the current user, or provided culturehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetLocalizedStringresourcestringresource name to retrievelangstring?Optional language code to use for resource localizationCould not find requested resourceInvalid input parameter or request bodyThe request completed successfullypublicGET:site/settingsRetrieve all configuration settingshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetSiteSettingsincludestringOptional parameter used to include anonymous user and license information (possible values: anonymous, license). By default we do not include them.authenticatebool?Force authentication for request (default: false)MindTouch API key or Administrator access is required.The request completed successfullyinternalPUT:site/settingsSet all configuration settingshttp://developer.mindtouch.com/en/ref/MindTouch_APIPutSiteSettingsauthenticatebool?Force authentication for request (default: false)The request completed successfullyInvalid input parameter or request bodyMindTouch API key or Administrator access is required.internalPOST:site/exportGenerates export informationhttp://developer.mindtouch.com/en/ref/MindTouch_APISiteExportreltoint?Page used for path normalization (default: home page)reltopathstring?Page used for path normalization. Ignored if relto parameter is defined.The request completed successfullyInvalid input parameter or request bodypublicPOST:site/importGenerates import informationhttp://developer.mindtouch.com/en/ref/MindTouch_APISiteImportreltopathstring?Page used for path normalization. Ignored if relto parameter is defined.reltoint?Page used for path normalization (default: home page)forceoverwritebool?Force overwrite of destination, even if import content is older.The request completed successfullyInvalid input parameter or request bodypublicGET:site/logoRetrieve the site logo imagehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetSiteLogoauthenticatebool?Force authentication for request (default: false)defaultstring?Absolute uri for default imagepublicGET:site/logo.pngRetrieve the site logo imagehttp://developer.mindtouch.com/en/ref/MindTouch_APIGetSiteLogoauthenticatebool?Force authentication for request (default: false)defaultstring?Absolute uri for default imagepublicPUT:site/logo.pngSave a new site logo imagehttp://developer.mindtouch.com/en/ref/MindTouch_APIPutSiteLogoauthenticatebool?Force authentication for request (default: false)internalPUT:site/logoSave a new site logo imagehttp://developer.mindtouch.com/en/ref/MindTouch_APIPutSiteLogoauthenticatebool?Force authentication for request (default: false)internalDELETE:site/logoRemove the site logohttp://developer.mindtouch.com/en/ref/MindTouch_APIDeleteSiteLogoauthenticatebool?Force authentication for request (default: false)internalDELETE:site/logo.pngRemove the site logohttp://developer.mindtouch.com/en/ref/MindTouch_APIDeleteSiteLogoauthenticatebool?Force authentication for request (default: false)internalPOST:site/feedbackLogged in users can submit feedback to a site owner unless a feedback email is defined.http://developer.mindtouch.com/en/ref/MindTouch_APIPostFeedbackThe required elements were not provided ("email subject and body not provided")The request completed successfullyThe user must be logged in to be able to submit feedbackpublicPOST:users/authenticateAuthenticate 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.http://developer.mindtouch.com/en/ref/MindTouch_APIPostUserAuthcallbackstring?If specified, return response as a jsonp call using the provided callback.ssotokenstring?Token from remote auth service to be used for internal SSO authentication.authproviderint?Identifier for the external service to use for authentication.redirecturi?Redirect to the given URI upon authenticationUsername conflicts with an existing usernameLogin access is requiredThe request completed successfullyAuthentication failedInvalid input parameter or request bodypublicGET:users/authenticateAuthenticate a user given http header Credentials or an auth token. Response status 200 implies valid credentials and contains a new auth token.http://developer.mindtouch.com/en/ref/MindTouch_APIPostUserAuthcallbackstring?If specified, return response as a jsonp call using the provided callback.ssotokenstring?Token from remote auth service to be used for internal SSO authentication.authproviderint?Identifier for the external service to use for authentication.redirecturi?Redirect to the given URI upon authenticationUsername conflicts with an existing usernameLogin access is requiredThe request completed successfullyAuthentication failedInvalid input parameter or request bodypublicGET:usersRetrieve list of users.http://developer.mindtouch.com/en/ref/MindTouch_APIGetUsersrolefilterstring?Search for users by a role nameauthproviderint?Return users belonging to given authentication service idusernameemailfilterstring?Search for users by name and email or part of a name and emailfullnamefilterstring?Search for users full name starting with supplied textusernamefilterstring?Search for users name starting with supplied textverbosebool?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 sortingoffsetint?Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0)limitstring?Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100)seatfilterstring?Search for users with or without seats (one of "seated", "unseated", or "recommended"; default: none)activatedfilterbool?Search for users by their active statusauthenticatebool?Force authentication for request (default: false)Read access is requiredThe request completed successfullypublicGET:users/{userid}Retrieve information about a user.http://developer.mindtouch.com/en/ref/MindTouch_APIGetUserauthenticatebool?Force authentication for request (default: false){userid}stringEither an integer user ID, "current", or "=" followed by a double uri-encoded user nameexcludestring?Elements to exclude from response document (choice of "groups", "properties"; default: exclude nothing)Read access is requiredThe request completed successfullyInvalid input parameter or request bodyRequested user could not be foundpublicPOST:usersAdd or modify a userhttp://developer.mindtouch.com/en/ref/MindTouch_APIPostUserauthenticatebool?Force authentication for request (default: false)authpasswordstring?Password to use for verification with external authentication serviceauthusernamestring?Username to use for verification with external authentication serviceaccountpasswordstring?Account password to set (default: do not set/change password)Invalid input parameter or request bodyUsername conflicts with an existing usernameThe request completed successfullyAdministrator access, apikey, or account owner is requiredRequested user could not be foundpublicPUT:users/{userid}Modify an existing userhttp://developer.mindtouch.com/en/ref/MindTouch_APIPutUser{userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user nameauthenticatebool?Force authentication for request (default: false)authpasswordstring?Password to use for verification with external authentication serviceauthusernamestring?Username to use for verification with external authentication serviceUsername conflicts with an existing usernameAdministrator access or account owner is requiredInvalid input parameter or request bodyThe request completed successfullyRequested user could not be foundpublicPOST:users/{userid}/allowedCheck one or more resources if given operation is allowed.http://developer.mindtouch.com/en/ref/MindTouch_APIPostUsersAllowedoperationsstring?Comma separated list of operations to verify{userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user nameverbosebool?Return verbose information on permitted pages (default: trueauthenticatebool?Force authentication for request (default: false)invertbool?Return filtered instead of allowed pages. Sets verbose to false (default: falsemasklong?Permission bit mask required for the pagesInvalid input parameter or request bodyRequested user could not be foundThe request completed successfullypublicPUT:users/{userid}/seatGive a user a license seat.http://developer.mindtouch.com/en/ref/MindTouch_APIPutUserSeat{userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user nameauthenticatebool?Force authentication for request (default: false)Requested user could not be foundAdministrator access requiredThe request completed successfullyUser cannot be given a seat or seats depletedinternalDELETE:users/{userid}/seatRemove a license seat from a user.http://developer.mindtouch.com/en/ref/MindTouch_APIDeleteUserSeatauthenticatebool?Force authentication for request (default: false){userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user nameRequested user could not be foundAdministrator access requiredInvalid input parameter or request bodyThe request completed successfullyinternalPUT:users/{userid}/passwordSet password for a given user.http://developer.mindtouch.com/en/ref/MindTouch_APIPutPasswordChangeauthenticatebool?Force authentication for request (default: false)currentpasswordstring?Current password needed when changing your own password (without admin rights){userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user namealtpasswordbool?If true, the given password sets a secondary password that can be used for login. The main password is not overwritten. (default: false)Administrator access or account owner is requiredThe request completed successfullyRequested user could not be foundInvalid input parameter or request bodypublicGET:users/{userid}/favoritesDEPRECATED: Retrieves a list of favorite pages for a user.http://developer.mindtouch.com/en/ref/MindTouch_APIGetFavoritePagesForUserauthenticatebool?Force authentication for request (default: false){userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user nameBROWSE access is requiredThe request completed successfullyRequested user could not be foundpublicGET:users/{userid}/metricsRetrieve usage metrics for a userhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetMetricsForUserauthenticatebool?Force authentication for request (default: false){userid}stringeither an integer user ID, "current", or "=" followed by a double uri-encoded user nameRequested user could not be foundThe request completed successfullypublicGET:Retrieve extension descriptionhttp://developer.mindtouch.com/en/ref/MindTouch_APIGetExtensionLibrarypublicPOST:{function}Invoke extension functionhttp://developer.mindtouch.com/en/ref/MindTouch_APIPostExtensionFunctionpublicGET:$files/{name}Retrieve file contentshttp://developer.mindtouch.com/en/ref/MindTouch_APIGetLibraryFilespublicHEAD:$files/{name}Retrieve file headershttp://developer.mindtouch.com/en/ref/MindTouch_APIGetLibraryFilespublicGET:@configRetrieve service configurationhttp://developer.mindtouch.com/Dream/Reference/General/Generic_FeaturesGetConfigprivatePUT:@configInitialize servicehttp://developer.mindtouch.com/Dream/Reference/General/Generic_FeaturesPutConfigprivateDELETE:@configDeinitialize servicehttp://developer.mindtouch.com/Dream/Reference/General/Generic_FeaturesDeleteConfigprivateGET:@blueprintRetrieve service blueprinthttp://developer.mindtouch.com/Dream/Reference/General/Generic_FeaturesGetServiceBlueprintpublicGET:@aboutRetrieve service descriptionhttp://developer.mindtouch.com/Dream/Reference/General/Generic_FeaturesGetServiceInfopublicDELETE:Stop servicehttp://developer.mindtouch.com/Dream/Reference/General/Generic_FeaturesDeleteServiceRequest completed successfullyInsufficient permissionprivatePOST:@grantsAdds a grant to this service for accessing another service.http://developer.mindtouch.com/Dream/Reference/General/Generic_FeaturesPostGrantinternal