You can use the REST API to retrieve (and edit) multiple settings on how Scroll Translations is configured in a space.

REST functionality is not officially supported

The REST API functionality described on this page is not officially supported, and may change in the future.

Retrieve information on Scroll Translations configuration in a space

You can get space information about enabled/disabled Scroll Translation modules by sending a GET request to the following URL:

Resource
http://<host>:<port>/rest/scroll-versions/latest/config/<space-key>
CODE
HTTP MethodGET
HTTP HeaderAuthorization via Basic Auth

This request returns a JSON document containing all relevant information:

{
  "enableVersionManagement":true,
  "enableTheme":true,
  "enableWorkflow":false,
  "enableTranslation":false,
  "enableVariants":false,
  "enablePermalinks":true,
  "reviewers":[],
  "authors":[],
  "docadmins":["confluence-administrators"],
  "translators":[]
}
JS

Modify Scroll Translations configuration in a space

Scroll Translations modules can be enabled/disabled and permissions can be set by sending a POST request to the following URL:

Resource
http://<host>:<port>/rest/scroll-versions/latest/config/<space-key>
CODE
HTTP Method

POST

HTTP Header

Authorization via Basic-Auth

Content-Type

application/json

JSON Document
{
  "enableVersionManagement":true,
  "enableTheme":true,
  "enableWorkflow":false,
  "enableTranslation":false,
  "enableVariants":false,
  "enablePermalinks":true,
  "reviewers":["doc-reviewers"],
  "authors":["doc-authors"],
  "docadmins":["confluence-administrators"],
  "translators":[]
}
JS

Remove translation from a page and mark it as not translated

Resource
http://<host>:<port>/rest/scroll-versions/1.0/translation/{pageId}/{languageKey}
CODE
HTTP Method

DELETE

HTTP Header

Authorization via Basic-Auth

URL Parameters
  • pageId in the Confluence Page ID that can be found out by accessing Page Tools → Page Information. The id will be visible in the URL.
  • languageKey is the key of the language (e.g. en for English)