Download OpenAPI specification:Download
Update app setting
| title | string site name show on page header and tilte of HTML |
| confidential | string confidential show on page header |
| globalLang | string language set when create user |
| isEmailPublishedForNewUser | boolean default email show/hide setting when create user |
| fileUpload | boolean enable upload file except image file |
Succeeded to update app setting
Update site url setting
| siteUrl | string Site URL. e.g. https://example.com, https://example.com:8080 |
| envSiteUrl | string environment variable 'APP_SITE_URL' |
Succeeded to update site url setting
Update smtp setting
| smtpHost | string host name of client's smtp server |
| smtpPort | string port of client's smtp server |
| smtpUser | string user name of client's smtp server |
| smtpPassword | string password of client's smtp server |
Succeeded to update smtp setting
Update ses setting
| accessKeyId | string accesskey id for authentification of AWS |
| secretAccessKey | string secret key for authentification of AWS |
Succeeded to update ses setting
Update fileUploadSetting
| fileUploadType | string fileUploadType |
| s3Region | string region of AWS S3 |
| s3CustomEndpoint | string custom endpoint of AWS S3 |
| s3Bucket | string AWS S3 bucket name |
| s3AccessKeyId | string accesskey id for authentification of AWS |
| s3SecretAccessKey | string secret key for authentification of AWS |
| s3ReferenceFileWithRelayMode | boolean is enable internal stream system for s3 file request |
| gcsApiKeyJsonPath | string apiKeyJsonPath of gcp |
| gcsBucket | string bucket name of gcs |
| gcsUploadNamespace | string name space of gcs |
| gcsReferenceFileWithRelayMode | boolean is enable internal stream system for gcs file request |
| envGcsApiKeyJsonPath | string Path of the JSON file that contains service account key to authenticate to GCP API |
| envGcsBucket | string Name of the GCS bucket |
| envGcsUploadNamespace | string Directory name to create in the bucket |
Succeeded to update fileUploadSetting
Get available capacity of uploaded file with GridFS
| fileSize required | number Example: fileSize=23175 file size |
Succeeded to get available capacity of uploaded file with GridFS.
Forbidden
Internal Server Error
Add attachment to the page
| page_id | string Nullable |
| path | string Nullable |
| file | string <binary> attachment data |
Succeeded to add attachment.
Forbidden
Internal Server Error
Get bookmarked info
| pageId | string page id |
Succeeded to get bookmark info.
Get my bookmarked status
| userId required | string user id |
| page | number selected page number |
| limit | number page item limit |
| offset | number page item offset |
Succeeded to get my bookmarked status.
Update bookmarked status
| pageId | string page ID |
| bool | boolean boolean for bookmark status |
Succeeded to update bookmarked status.
Update layout
| isContainerFluid | boolean |
Succeeded to update layout
Update theme
| themeType | string |
Succeeded to update theme
Update function
| isEnabledTimeline | boolean |
| isEnabledAttachTitleHeader | boolean |
| pageLimitationS | number |
| pageLimitationM | number |
| isEnabledStaleNotification | boolean |
| isAllReplyShown | boolean |
| isSearchScopeChildrenAsDefault | boolean |
Succeeded to update function
Update highlight
| styleName | string |
| styleBorder | boolean |
Succeeded to update highlight
Update customizeTitle
| customizeTitle | string |
Succeeded to update customizeTitle
Update customizeNoscript
| customizeNoscript | string |
Succeeded to update customize header
Update customizeCss
| customizeCss | string |
Succeeded to update customize css
Update customizeScript
| customizeScript | string |
Succeeded to update customize script
get properties of stored zip files for export
the zip file statuses
delete the file
| fileName required | string the file name of zip file |
the file is deleted
Check whether the server is healthy or not
| checkServices | Array of strings Items Enum: "mongo" "search" The list of services to check health |
| strictly | boolean Check services and responds 503 if either of these is unhealthy |
Healthy
Unhealthy
import a collection from a zipped json
| fileName | string the file name of zip file |
| collections | Array of strings collection names to import |
| optionsMap | object the map object of importing option that have collection name as the key |
Import process has requested
Get properties of stored zip files for import
the zip file statuses
Update lineBreak setting
| isEnabledLinebreaks | boolean enable lineBreak |
| isEnabledLinebreaksInComments | boolean enable lineBreak in comment |
Succeeded to update lineBreak setting
Update xss
| isEnabledPrevention | boolean enable xss |
| xssOption | number number of xss option |
| tagWhitelist | Array of strings array of tag whitelist |
| attrWhitelist | Array of strings array of attr whitelist |
Succeeded to update xss setting
add user notification setting
| pathPattern | string path name of wiki |
| channel | string slack channel name without '#' |
Succeeded to add user notification setting
delete user trigger notification pattern
| id required | string id of user trigger notification |
Succeeded to delete user trigger notification pattern
add global notification
| notifyType | string What is type for notify |
| toEmail | string email for notify |
| slackChannels | string channels for notify |
| triggerPath | string trigger path for notify |
| triggerEvents | Array of strings |
Succeeded to add global notification
update global notification
| id required | string global notification id for updated |
| notifyType | string What is type for notify |
| toEmail | string email for notify |
| slackChannels | string channels for notify |
| triggerPath | string trigger path for notify |
| triggerEvents | Array of strings |
Succeeded to update global notification
delete global notification pattern
| id required | string id of global notification |
Succeeded to delete global notification pattern
Update settings for notify for page grant
| isNotificationForOwnerPageEnabled | string Whether to notify on owner page |
| isNotificationForGroupPageEnabled | string Whether to notify on group page |
Succeeded to settings for notify for page grant
toggle enabled global notification
| id required | string notification id for updated |
| isEnabled | boolean is notification enabled |
Succeeded to delete global notification pattern
get page by pagePath or pageId
| pageId | string Example: pageId=5e07345972560e001761fa63 page id |
| path | string Example: path=%2F page path |
Page data
Create page
| body required | string Text of page |
| path required | string page path |
| grant | number grant |
| grantUserGroupId | string UserGroup ID |
| pageTags | Array of objects (Tag) |
| shouldGeneratePath | boolean Determine whether a new path should be generated |
Succeeded to create page.
page path is already existed
Update page
| body required | string content body |
| page_id required | string page ID |
| revision_id required | string revision ID |
| grant | number grant |
Succeeded to update page.
Forbidden
Internal Server Error
Update liked status
| pageId | string page ID |
| bool | boolean boolean for like status |
Succeeded to update liked status.
Retrieve current page info
| pageId required | string page ID |
Successfully retrieved current page info.
Internal server error.
Retrieve current page's isGrantNormalized value
| pageId | string Example: pageId=5e07345972560e001761fa63 page id |
Successfully retrieved current isGrantNormalized.
Bad request. Page is unreachable or empty.
Internal server error.
Get already exist paths
| fromPath | string old parent path |
| toPath | string new parent path |
Succeeded to retrieve pages.
Internal server error.
Update subscription status
| pageId | string page ID |
Succeeded to update subscription status.
Internal server error.
Rename page
| pageId required | string page ID |
| path | string page path |
| revisionId required | string revision ID |
| newPagePath | string new path |
| isRenameRedirect | boolean whether redirect page |
| updateMetadata | boolean whether update meta data |
| isRecursively | boolean whether rename page with descendants |
Succeeded to rename page.
page id is invalid
page path is already existed
Duplicate page
| pageId required | string page ID |
| pageNameInput | string page path |
| isRecursively | boolean whether duplicate page with descendants |
Succeeded to duplicate page.
Forbidden to duplicate page.
Internal server error.
Get subordinated pages
| path | string Parent path of search |
| limit | number Limit of acquisitions |
Succeeded to retrieve pages.
Internal server error.
Get page tag
| pageId | string Example: pageId=5e07345972560e001761fa63 page ID |
Succeeded to get page tags.
Forbidden
Internal Server Error
Get UpdatePost setting list
| path | string Example: path=%2F page path |
Succeeded to get UpdatePost setting list.
Forbidden
Internal Server Error
Update personal setting
| name | string |
string | |
| lang | string |
| isEmailPublished | boolean |
params of personal
Get whether a password has been set
Whether a password has been set
Update user image type
succeded to update user image type
Get external accounts that linked current user
external accounts
Update user password
| oldPassword | string |
| newPassword | string |
| newPasswordConfirm | string |
user password
associate Ldap account
| username | string |
| password | string |
succeded to associate Ldap account
disassociate Ldap account
| providerType | string |
| accountId | string |
succeded to disassociate Ldap account
Operate indices
| operation | string Enum: "normalize" "rebuild" Operation type against to indices > * |
Return 200
Update authentication isEnabled
| isEnabled | boolean |
| target | string |
Succeeded to enable authentication
Get setup strategies for passport
params of setup strategies
Update GeneralSetting
| restrictGuestMode | string type of restrictGuestMode |
| pageCompleteDeletionAuthority | string type of pageDeletionAuthority |
| hideRestrictedByOwner | boolean enable hide by owner |
| hideRestrictedByGroup | boolean enable hide by group |
Succeeded to update general Setting
Update LDAP setting
| serverUrl | string server url for ldap |
| isUserBind | boolean enable user bind |
| ldapBindDN | string the query used to bind with the directory service |
| ldapBindDNPassword | string the password that is entered in the login page will be used to bind |
| ldapSearchFilter | string the query used to locate the authenticated user |
| ldapAttrMapUsername | string specification of mappings for username when creating new users |
| isSameUsernameTreatedAsIdenticalUser | boolean local account automatically linked the user name matched |
| ldapAttrMapMail | string specification of mappings for mail address when creating new users |
| ldapAttrMapName | string Specification of mappings for full name address when creating new users |
| ldapGroupSearchBase | string the base DN from which to search for groups. |
| ldapGroupSearchFilter | string the query used to filter for groups |
| ldapGroupDnProperty | string The property of user object to use in dn interpolation of Group Search Filter |
Succeeded to update LDAP setting
Update SAML setting
| samlEntryPoint | string entry point for saml |
| samlIssuer | string issuer for saml |
| samlCert | string certificate for saml |
| samlAttrMapId | string attribute mapping id for saml |
| samlAttrMapUserName | string attribute mapping user name for saml |
| samlAttrMapMail | string attribute mapping mail for saml |
| samlAttrMapFirstName | string attribute mapping first name for saml |
| samlAttrMapLastName | string attribute mapping last name for saml |
| isSameUsernameTreatedAsIdenticalUser | boolean local account automatically linked the user name matched |
| isSameEmailTreatedAsIdenticalUser | boolean local account automatically linked the email matched |
| samlABLCRule | string ABLCRule for saml |
Succeeded to update SAML setting
Update OpenID Connect setting
| oidcProviderName | string provider name for oidc |
| oidcIssuerHost | string issuer host for oidc |
| oidcAuthorizationEndpoint | string authorization endpoint for oidc |
| oidcTokenEndpoint | string token endpoint for oidc |
| oidcRevocationEndpoint | string revocation endpoint for oidc |
| oidcIntrospectionEndpoint | string introspection endpoint for oidc |
| oidcUserInfoEndpoint | string userinfo endpoint for oidc |
| oidcEndSessionEndpoint | string end session endpoint for oidc |
| oidcRegistrationEndpoint | string registration endpoint for oidc |
| oidcJWKSUri | string JSON Web Key Set URI for oidc |
| oidcClientId | string client id for oidc |
| oidcClientSecret | string client secret for oidc |
| oidcAttrMapId | string attr map id for oidc |
| oidcAttrMapUserName | string attr map username for oidc |
| oidcAttrMapName | string attr map name for oidc |
| oidcAttrMapMail | string attr map mail for oidc |
| isSameUsernameTreatedAsIdenticalUser | boolean local account automatically linked the user name matched |
| isSameEmailTreatedAsIdenticalUser | boolean local account automatically linked the email matched |
Succeeded to update OpenID Connect setting
Update google OAuth
| googleClientId | string key of comsumer |
| googleClientSecret | string password of comsumer |
| isSameUsernameTreatedAsIdenticalUser | boolean local account automatically linked the email matched |
Succeeded to google OAuth
Update github OAuth
| githubClientId | string key of comsumer |
| githubClientSecret | string password of comsumer |
| isSameUsernameTreatedAsIdenticalUser | boolean local account automatically linked the email matched |
Succeeded to github OAuth
Get slack configuration setting
params of slack configuration setting
Update slack configuration setting
| webhookUrl | string incoming webhooks url |
| isIncomingWebhookPrioritized | boolean use incoming webhooks even if Slack App settings are enabled |
| slackToken | string OAuth access token |
Succeeded to update slack configuration setting
Adds userGroup
| name | string name of the userGroup trying to be added |
userGroup is added
Get selectable parent UserGroups
| groupId required | string id of userGroup |
userGroups are fetched
Get selectable child UserGroups
| groupId required | string id of userGroup |
userGroups are fetched
Get UserGroup from Group ID
| id required | string id of userGroup |
userGroup are fetched
Deletes userGroup
| id required | string id of userGroup |
| actionName | string name of action |
| transferToUserGroupId | string userGroup id that will be transferred to |
userGroup is removed
Update userGroup
| id required | string id of userGroup |
userGroup is updated
Get users related to the userGroup
| id required | string id of userGroup |
users are fetched
Add a user to the userGroup
| id required | string id of userGroup |
a user is added
remove a user from the userGroup
| id required | string id of userGroup |
a user was removed
Get the user group relations for the userGroup
| id required | string id of userGroup |
user group relations are fetched
Get closed pages for the userGroup
| id required | string id of userGroup |
pages are fetched
Select selected columns from users order by asc or desc
| page | number page number |
| selectedStatusList | string status list |
| searchText | string For incremental search value from input box |
| sortOrder | string asc or desc |
| sort | string sorting column |
users are fetched
| id required | string id of user |
users recent created pages are fetched
Create new users and send Emails
| shapedEmailList | object Invitation emailList |
| sendEmail | boolean Whether to send mail |
Inviting user success
Grant user admin
| id required | string id of user for admin |
Grant user admin success
Revoke user admin
| id required | string id of user for revoking admin |
Revoke user admin success
Grant user read only access
| id required | string id of user for read only access |
Grant user read only access success
Revoke user read only access
| id required | string id of user for removing read only access |
Revoke user read only access success
Activate user
| id required | string id of activate user |
Activationg user success
Deactivate user
| id required | string id of deactivate user |
Deactivationg user success
Get external-account
external-account are fetched
Delete ExternalAccount
| id required | string id of ExternalAccount |
External Account is removed
update imageUrlCache
| userIds | string user id list |
success creating imageUrlCached
update imageUrlCache
| newPassword | string |
| user | string user id for reset password |
success reset password
send new password email
| newPassword | string |
| user | string user id for send new password email |
success send new password email
send invitation email
| id | string user id for send invitation email |
success send invitation email
Get list of users
| userIds | string Example: userIds=5e06fcc7516d64004dbf4da6%2C5e098d53baa2ac004e7d24ad user IDs |
Succeeded to get list of users.
Forbidden
Internal Server Error
Upload profile image
| file | string <binary> attachment data |
| user | string user to set profile image |
Succeeded to add attachment.
Forbidden
Internal Server Error
Remove attachment
| attachment_id required | string attachment ID |
Succeeded to remove attachment.
Forbidden
Internal Server Error
Remove profile image
| user | string user to remove profile image |
Succeeded to add attachment.
Forbidden
Internal Server Error
Get comments of the page of the revision
| page_id | string Example: page_id=5e07345972560e001761fa63 page ID |
| revision_id | string Example: revision_id=5e0734e472560e001761fa68 revision ID |
Succeeded to get comments of the page of the revision.
Forbidden
Internal Server Error
Post comment for the page
| commentForm required | object |
Succeeded to post comment for the page.
Forbidden
Internal Server Error
Update comment dody
| form required | object |
Succeeded to update comment dody.
Forbidden
Internal Server Error
Remove specified comment
| comment_id required | string revision ID |
Succeeded to remove specified comment.
Forbidden
Internal Server Error
Add attachment to the page
| page_id | string Nullable |
| path | string Nullable |
| file | string <binary> attachment data |
Succeeded to add attachment.
Forbidden
Internal Server Error
Remove attachment
| attachment_id required | string attachment ID |
Succeeded to remove attachment.
Forbidden
Internal Server Error
Get comments of the page of the revision
| page_id | string Example: page_id=5e07345972560e001761fa63 page ID |
| revision_id | string Example: revision_id=5e0734e472560e001761fa68 revision ID |
Succeeded to get comments of the page of the revision.
Forbidden
Internal Server Error
Post comment for the page
| commentForm required | object |
Succeeded to post comment for the page.
Forbidden
Internal Server Error
Update comment dody
| form required | object |
Succeeded to update comment dody.
Forbidden
Internal Server Error
Remove specified comment
| comment_id required | string revision ID |
Succeeded to remove specified comment.
Forbidden
Internal Server Error
Get UpdatePost setting list
| path | string Example: path=%2F page path |
Succeeded to get UpdatePost setting list.
Forbidden
Internal Server Error
Put InAppNotificationSettings
params of InAppNotificationSettings
Get InAppNotificationSettings
params of InAppNotificationSettings
Update authentication isEnabled
| isEnabled | boolean |
| target | string |
Succeeded to enable authentication
Get setup strategies for passport
params of setup strategies
Update GeneralSetting
| restrictGuestMode | string type of restrictGuestMode |
| pageCompleteDeletionAuthority | string type of pageDeletionAuthority |
| hideRestrictedByOwner | boolean enable hide by owner |
| hideRestrictedByGroup | boolean enable hide by group |
Succeeded to update general Setting
Update LocalSetting
| isLocalEnabled | boolean local setting mode |
| registrationMode | string type of registrationMode |
| registrationWhitelist | Array of strings array of regsitrationList |
Succeeded to update local Setting
Update LDAP setting
| serverUrl | string server url for ldap |
| isUserBind | boolean enable user bind |
| ldapBindDN | string the query used to bind with the directory service |
| ldapBindDNPassword | string the password that is entered in the login page will be used to bind |
| ldapSearchFilter | string the query used to locate the authenticated user |
| ldapAttrMapUsername | string specification of mappings for username when creating new users |
| isSameUsernameTreatedAsIdenticalUser | boolean local account automatically linked the user name matched |
| ldapAttrMapMail | string specification of mappings for mail address when creating new users |
| ldapAttrMapName | string Specification of mappings for full name address when creating new users |
| ldapGroupSearchBase | string the base DN from which to search for groups. |
| ldapGroupSearchFilter | string the query used to filter for groups |
| ldapGroupDnProperty | string The property of user object to use in dn interpolation of Group Search Filter |
Succeeded to update LDAP setting
Update SAML setting
| samlEntryPoint | string entry point for saml |
| samlIssuer | string issuer for saml |
| samlCert | string certificate for saml |
| samlAttrMapId | string attribute mapping id for saml |
| samlAttrMapUserName | string attribute mapping user name for saml |
| samlAttrMapMail | string attribute mapping mail for saml |
| samlAttrMapFirstName | string attribute mapping first name for saml |
| samlAttrMapLastName | string attribute mapping last name for saml |
| isSameUsernameTreatedAsIdenticalUser | boolean local account automatically linked the user name matched |
| isSameEmailTreatedAsIdenticalUser | boolean local account automatically linked the email matched |
| samlABLCRule | string ABLCRule for saml |
Succeeded to update SAML setting
Update OpenID Connect setting
| oidcProviderName | string provider name for oidc |
| oidcIssuerHost | string issuer host for oidc |
| oidcAuthorizationEndpoint | string authorization endpoint for oidc |
| oidcTokenEndpoint | string token endpoint for oidc |
| oidcRevocationEndpoint | string revocation endpoint for oidc |
| oidcIntrospectionEndpoint | string introspection endpoint for oidc |
| oidcUserInfoEndpoint | string userinfo endpoint for oidc |
| oidcEndSessionEndpoint | string end session endpoint for oidc |
| oidcRegistrationEndpoint | string registration endpoint for oidc |
| oidcJWKSUri | string JSON Web Key Set URI for oidc |
| oidcClientId | string client id for oidc |
| oidcClientSecret | string client secret for oidc |
| oidcAttrMapId | string attr map id for oidc |
| oidcAttrMapUserName | string attr map username for oidc |
| oidcAttrMapName | string attr map name for oidc |
| oidcAttrMapMail | string attr map mail for oidc |
| isSameUsernameTreatedAsIdenticalUser | boolean local account automatically linked the user name matched |
| isSameEmailTreatedAsIdenticalUser | boolean local account automatically linked the email matched |
Succeeded to update OpenID Connect setting
Update google OAuth
| googleClientId | string key of comsumer |
| googleClientSecret | string password of comsumer |
| isSameUsernameTreatedAsIdenticalUser | boolean local account automatically linked the email matched |
Succeeded to google OAuth
Update github OAuth
| githubClientId | string key of comsumer |
| githubClientSecret | string password of comsumer |
| isSameUsernameTreatedAsIdenticalUser | boolean local account automatically linked the email matched |
Succeeded to github OAuth
Update LocalSetting
| isLocalEnabled | boolean local setting mode |
| registrationMode | string type of registrationMode |
| registrationWhitelist | Array of strings array of regsitrationList |
Succeeded to update local Setting
Put botType setting.
| currentBotType | string |
Succeeded to put botType setting.
Delete botType setting.
| currentBotType | string |
Succeeded to delete botType setting.
Test the connection with slack work space.
| testChannel | string |
Succeeded to connect to slack work space.
Update customBotWithoutProxy setting.
Succeeded to put CustomBotWithoutProxy setting.
Update customBotWithoutProxy permissions.
Succeeded to put CustomBotWithoutProxy permissions.
update supported commands
Succeeded to update supported commands
Search tags
| q | string Example: q=daily keyword to search |
Succeeded to tag list.
Forbidden
Internal Server Error
Update tag
| pageId | string page ID |
| revisionId | string revision ID |
| tags | Array of strings (Tags) Tags |
Succeeded to update tag.
Forbidden
Internal Server Error
Get tags
| limit | integer Example: limit=10 Limit that was used |
| offset | integer Example: offset=20 Only if specified or default page/offset values were used |
Succeeded to tag list.
Forbidden
Internal Server Error