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 the Resource Documentation in the Scroll Versions 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:

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

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":[]
}

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:

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

{
  "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

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