Exporting an application or environment

Edit online

As needed, you can export an application or environment defined in your IBM® Sovereign Core Compliance center instance, and then import it into a new IBM Sovereign Core Compliance center instance as part of a migration or replication process. The output of the export will be a .tar file and is stored in the LZ bucket.

You can export the application SBOM, build SBOM, deploy SBOM, and package SBOM. For environments, the exported file includes basic environment details and related certificate data.

Attention: To ensure the security and integrity of your organization's data and resources, it is recommended that you get approval from your CISO or security team before exporting, storing, or sharing IBM Sovereign Core Compliance center data.

Before you begin

  • You must have Admin access to the IBM Sovereign Core Compliance center instance, as well as access to the specific application or environment you are exporting.

You can export an application or environment definition using the IBM Sovereign Core Compliance center API or from the user interface (UI).

Instructions: Exporting an application or environment definition using the API

To export an application definition using the IBM Sovereign Core Compliance center API:

You can export a single or multiple application definition by specifying its name in the URL path.

  1. Use the following command to export an application definition. You can specify multiple application names using a comma-separated list. 
    curl -vvv '<concert_domain>/core/api/v1/export_applications' \
  -H 'accept: application/json' \
  -H 'InstanceId: <instance_id>' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \ 
  -d '{
"names": ["<application_name>"],
"exclude_digest": true/false,
"exclude_commitsha": true/false
}' -k
    Note: Record the toc_id included in the response. You need this to download the exported file.
  2. Download the exported .tar file: 
    curl '<concert_domain>/core/api/v1/table_of_contents/job/<toc_id>/download' \
 -H 'accept: application/json' \
 -H 'InstanceId: <InstanceId>' \
 -H 'Authorization: Bearer <token>' -k -O -J -L

The exported file is located in the LZ bucket.

Note: The export operation is only supported for application definitions that were generated from uploaded ConcertDef SBOM files that use the version schema 1.0.2 or higher. Refer to Generating IBM Sovereign Core Compliance centerDef SBOMs
To export an environment definition using the IBM Sovereign Core Compliance center API:

You can export a single environment by specifying its name in the URL path.

  1. Export an environment: 
    curl -vvv '<concert_domain>/core/api/v1/environments/<env-name>/export' \
  -H 'accept: application/json' \
  -H 'InstanceId: <instance_id>' \
  -H 'Authorization: Bearer <token>' \
  -d '' -k
    Note: Record the toc_id included in the response. You need this to download the exported file.
  2. Download the exported .tar file: 
    curl '<concert_domain>/core/api/v1/table_of_contents/job/<toc_id>/download' \
 -H 'accept: application/json' \
 -H 'InstanceId: <InstanceId>' \
 -H 'Authorization: Bearer <token>' -k -O -J -L

The exported file is located in the LZ bucket.

Instructions: Exporting an application or environment definition from the UI

Note: You cannot export sample data.
To export an application definition from the IBM Sovereign Core Compliance center UI:
  1. In your IBM Sovereign Core Compliance center instance, select Inventory > Application inventory from the navigation.
  2. Click the Definitions tab in the sub-navigation to view a list of application definitions.
  3. Click to enable the check box(es) next to the relevant application definition(s).
  4. Click Export.
  5. Click View event status or select Administration > Event log to view the exported file. Click the refresh icon, if needed.
  6. Click the overflow menu icon next to the exported file and select Download. The output is a .tar file downloaded to your workstation.
To export an environment definition from the IBM Sovereign Core Compliance center UI:
  1. Navigate to Inventory > Environment inventory.
  2. Click the Definitions tab in the sub-navigation to view a list of environment definitions.
  3. Next to the desired environment definition, click the overflow menu icon and select Export.
  4. Click Administration > Event log to view the status of the exported file. Click the refresh icon, if needed.
  5. Click the overflow menu icon next to the exported file and select Download. The output is a .tar file downloaded to your workstation.