Skip to main content

Migrating from Existing Portal to the Docs as Code Workflow

APIMatic allows you to easily migrate from an existing Portal created using the UI workflow to the docs as code workflow via the build input. The build input corresponds to the published or unpublished version of the Portal and enables you to:

  • Create a backup for the Portal
  • Migrate from the UI workflow to the docs as code workflow

Furthermore, you can backup the build input in a Git repository and use it to restore the Portal if anything goes wrong. For details on description of the build input, go to APIMatic Build Input Documentation.

note

To get access to the API for generating a Portal via the docs as code workflow, please contact sales@apimatic.io.

Generate Build Input for Existing Portal​

You can generate a build input for any published or unpublished Portal created using the UI workflow and move to the docs as code workflow. The generated build input can be used to re-create the Portal via the docs as code workflow. For more information on the docs as code workflow, go to the APIMatic API Documentation.

  • On the APIMatic Dashboard, choose any API you want to generate a build input for.

    Choose API

  • Next, click on the kebab menu (three vertical dots) on the API tile and select API Integration Keys from the options.

    API Integration Key

  • The displayed keys contain API Group ID, API Key and API Entity ID along with the API version. Copy the API Group ID.

    Choose Key

  • Paste the API Group ID in the Generate Build Input for Published Portal Endpoint to generate a build input for the published version of the Portal and download it by clicking on the Download file button.

    Paste Key in endpoint

note

If you want to generate a build input for the unpublished version of the Portal, use the Generate Build Input for Unpublished Portal Endpoint.