Deleting Schematics data
IBM Cloud® Schematics stores your data in a highly available and secure environment. All your data such as automation code, input configuration data, input credentials, and the runtime data are stored in Object Storage. This data-at-rest is encrypted using AES GCM 256 with an envelope encryption technique. As the IBM Cloud account owner, you can control access to the IBM Cloud® Schematics objects in your account. You can choose to delete your data, by using the Schematics API, UI, or CLI as described.
When you delete these Schematics objects, the corresponding data in Object Storage is marked for deletion. The soft delete option enable you to recover the Schematics data by raising a support ticket. Further, your data are automatically purged after 7 days of soft delete.
Also, Schematics service maintains a backup copy of your data in a separate Object Storage bucket. This backup copy is automatically overwritten, every 30 days. Hence, all backup copy of your data are purged in 30 days.
After a soft or hard delete of the Schematics objects, if the Schematics services fails to delete the objects in your account. You need to raise a Schematics support ticket to completely remove from the resource controller.
Scope
The scope of deletion is limited to data stored in Schematics service and its backup.
Following points does not include in the scope of deletion of Schematics objects.
- The deletion or removal of the IBM Cloud resources that were provisioned by using Schematics.
- The data stored by the IBM Cloud resources provisioned by the Schematics.
- At the time of Schematics object deletion, you are provided with the option to destroy the cloud resources. However, it is suggested to independently confirm and destroy the Cloud resources from the cloud services. You can explore the list of Cloud resources, from the IBM Cloud resource list page.
Deleting Schematics objects from UI
You can delete Schematics objects by using IBM Cloud console. Following Schematics objects are used to store your data and helps to delete the IBM Cloud® Schematics objects.
You must have Manager role to delete from these IBM Cloud® Schematics objects.
Workspaces
You can follow these steps to delete the Schematics objects by using IBM Cloud console.
- From the Schematics workspaces dashboard, select the workspace that you want to delete.
- Click actions tab and select Delete workspace option.
- Type your workspace name in Type
workspace_name
to confirm text box. - Click Delete button.
Actions
You can follow these steps to delete the Schematics objects by using IBM Cloud Console.
- From the Schematics workspaces dashboard, select the actions that you want to delete.
- Click Select the Actions drop down list and select Delete option.
- Type your actions name in Type
action_name
to confirm text box. - Click Delete button.
Inventories
You can follow these steps to delete the Schematics objects by using IBM Cloud Console.
- From the Schematics workspaces dashboard, select the inventories that you want to delete.
- Click
...
dots against the inventory you want to delete and click Delete. - Type your inventory name in Type
Inventory_name
to confirm text box. - Click Delete button.
Deleting Schematics objects from CLI
You can delete Schematics objects by using command-line. Following Schematics objects are used to store your data and helps to delete the IBM Cloud® Schematics objects.
You must have Manager role to delete from these IBM Cloud® Schematics objects.
Workspaces
You can follow these steps to delete the Schematics objects.
- Install the IBM Cloud CLI and install the IBM Cloud® Schematics plug-in
- Run
ibmcloud schematics workspace list [--limit LIMIT] [--offset OFFSET] [--output] [--region]
to list and select the workspace ID that you want to delete. For more information about listing the workspace, see Schematics workspaces list command. - Run
ibmcloud schematics workspace delete --id WORKSPACE_ID [--force]
to delete the workspace. For more information about workspace delete, see Schematics workspaces delete command.
Actions
You can follow these steps to delete the Schematics objects.
- Install the IBM Cloud CLI and install the IBM Cloud® Schematics plug-in
- Run
ibmcloud schematics action list
to list and select an action ID that you want to delete. For more information about listing the actions, see Schematics actions list command. - Run
ibmcloud schematics action delete --id ACTION_ID [--force]
to delete an action. For more information about Schematics actions delete, see Schematics actions delete command.
Inventories
You can follow these steps to delete the Schematics objects.
- Install the IBM Cloud CLI and install the IBM Cloud® Schematics plug-in
- Run
ibmcloud schematics inventory list [--limit LIMIT] [--offset OFFSET] [--output OUTPUT]
to list and select the inventory ID that you want to delete. For more information about listing the inventories, see Schematics inventory list command. - Run
ibmcloud schematics inventory delete --id ACTION_ID
to delete an inventory. For more information about Schematics inventory delete, see Schematics inventory delete command.
Deleting Schematics objects from API
You can delete Schematics objects by using API. Following Schematics objects are used to store your data and helps to delete the IBM Cloud® Schematics objects.
You must have Manager role to delete from these IBM Cloud® Schematics objects. And select the Schematics endpoint to call the delete API.
Workspaces
You can follow these steps to delete the Schematics objects.
- Set up your REST client to execute Schematics API.
- Run
curl -X GET https://schematics.cloud.ibm.com/v1/workspaces -H "Authorization: <iam_token>"
to list and select the workspace ID that you want to delete. For more information about listing the workspace, see Schematics workspaces list API. - Run
curl -X DELETE https://schematics.cloud.ibm.com/v1/workspaces/{id} -H "Authorization: <iam_token>"
to delete the workspace. For more information about workspace delete, see Schematics workspace delete API.
Actions
You can follow these steps to delete the Schematics objects.
- Set up your REST client to execute Schematics API.
- Run
curl --location --request GET https://schematics.cloud.ibm.com/v2/actions/actions --header "Authorization: <access_token>"
to list and select an action ID that you want to delete. For more information about listing the actions, see Schematics actions list API. - Run
curl --location --request DELETE https://schematics.cloud.ibm.com/v2/actions/{action_id} --header "Authorization: <access_token> "
to delete an action. For more information about Schematics actions delete, see Schematics actions delete API.
Inventories
You can follow these steps to delete the Schematics objects.
- Set up your REST client to execute Schematics API.
- Run
curl --location --request GET https://schematics.cloud.ibm.com/v2/inventories --header "Content-Type: application/json" --header "Authorization: <access_token> " --data-raw "{"name": "dev-inventory538","description": "My dev env inventory","location": "us-east","resource_group": "Default",,"inventories_ini": "[windows] \n 158.177.7.181"}
to list and select the inventory ID that you want to delete. For more information about listing the inventories, see Schematics inventory list API. - Run
curl --location --request DELETE https://schematics.cloud.ibm.com/v2/inventories/us-east.INVENTORY.dev-inventory523.244223cf/ --header "Content-Type: application/json" --header "Authorization: <access_token> " --data-raw "{"name": "dev-inventory538","description": "My dev env inventory","location": "us-east","resource_group": "Default","resource_queries": ["default.RESOURCEQUERY.string.dxxx8a47"]}
to delete an inventory. For more information about Schematics inventory delete, see Schematics inventory delete API.