Skip to main content
Skip table of contents

Scroll Translations Administration via REST API

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.

Resources

Scroll Translations and Scroll Versions are sharing the same REST API. For detailed resource documentation, please refer to Scroll Versions  REST API documentation. 

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


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


HTTP Method

GET

HTTP Header

Authorization via Basic Auth

This request returns a JSON document containing all relevant information:

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

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


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


HTTP Method

POST

HTTP Header

Authorization via Basic-Auth

Content-Type

application/json

JSON Document


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


Remove translation from a page and mark it as not translated

Resource


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


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)


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.