Manage Existing Products

It's very natural to want to manage an existing API product. The administrative APIs support editing the product settings, as well as the ability to add, edit, or delete API references and documentation pages. Should the need arise to delete a product completely, the APIs also cater for this use case.

Edit Product Settings

Use the PATCH Patch product endpoint to update product settings.

Edit API Reference, Documentation, or Table of Contents Order

Use the PATCH Patch table of contents entry endpoint to modify existing entries.

📌 You can have multiple API references and documents in one product. To learn more, see Add APIs to Product and Add Docs to Product.

Edit Document Content

To update the contents of a Markdown document, use the PATCH Document endpoint.

In this example, replace <DOCUMENT-ID> with the actual document ID you wish to edit, and update the content field with the new content you want to set for the document.

Change Document to external

Use the PATCH Update the contents of a document endpoint to change source property to external. This will disable editing in the Swagger Portal UI. It is possible only in a separate request, no other value can be updated at the same time.

❗ Note: This operation cannot be reverted. Update of document's source property to internal is not supported.

Restore Deleted Items

Use the PATCH Patch table of contents endpoint to retrieve deleted ToC entries and set status value to restored. 

Sample Request

❗ Note: Restoring a table of contents item does not restore its nested child pages.

Revert content to saved state

Use the PATCH Patch table of contents endpoint to revert content to last published state. 

Sample Request

❗ Note: No other property can be updated when the status field is set.