Disabling the Live Documentation - Cloud

Talend Cloud API Designer User Guide

Version
Cloud
Language
English (United States)
Product
Talend Cloud
Module
Talend API Designer
Content
Design and Development > Designing APIs

Disable your documentation and select whether you want to retain its subdomain.

Procedure

  1. Open your API and go to Settings.
  2. Toggle the Enabled button from On to Off.
  3. If you want to release the documentation subdomain, clear the Retain Live API documentation subdomain check box.
    By default, Talend Cloud API Designer saves the subdomain you defined when you enabled the Live Documentation. This allows you to keep the same URL if you enable it again later. If you want to use this subdomain for a different API, you first need to release it.
  4. Click Save.

Results

Your Live Documentation is disabled. If you retained the subdomain, you can enable it again at any time. If not, the subdomain can be used by another API and you will have to enter a subdomain if you want to enable this documentation again.