Admin APIs: Blueprint import and export
You can export a blueprint to back it up, or export and import a blueprint to move it from one CPQ environment to another.
The CPQ blueprint admin APIs provide the import and export API calls for working with blueprints. Common use cases include migrating blueprints across CPQ environments and backing up blueprints. To view the CPQ blueprint admin APIs, see:
For a comprehensive list of all CPQ APIs, see the CPQ API Reference:
https://api-docs.logik.io/#introduction
You can also view the CPQ open source API documentation on Github:
https://github.com/logikioopensource/API-Documentation
To learn how to set up admin API keys for calling blueprint APIs, see:
Blueprint export APIs
To export a blueprint via the APIs, the Export blueprint call passes the variable name of the blueprint to start the export job. In response, the call receives a Job ID that can be queried to retrieve the status and to download the blueprint as a ZIP file.
The sequence of API calls to export and download a blueprint is:
- Export the blueprint
Use the blueprint variable in the payload to initiate the export. The Job ID can be polled for the status of the export.
- Check the job status
To check the status, use the Job ID that is returned after the export call. When the status is COMPLETED, proceed to step 3.
- Download the export
Use the same Job ID to download a ZIP file that contains the blueprint.
To view the source code for the Export blueprint call, see:
Blueprint import APIs
To import a blueprint, the Import blueprint call passes a ZIP file of the blueprint to begin an import job.
The sequence of API calls to import a blueprint is:
- Import the blueprint
Select the ZIP file that includes the blueprint. The Job ID can be polled for the status of the import.
- Checkthe job status
To check the status, use the Job ID that is returned after the import call. When the status is SUCCESS, the job is complete.
To view the source code for the Import blueprint call, see: