Skip to content

Latest commit

 

History

History
148 lines (97 loc) · 12 KB

delete-schematics-data.md

File metadata and controls

148 lines (97 loc) · 12 KB
Raw
copyright lastupdated keywords subcollection
years
2017, 2024
2024-11-13
schematics objects, delete schematics objects, schematics object backup
schematics

{{site.data.keyword.attribute-definition-list}}

Deleting {{site.data.keyword.bpshort}} data

{: #delete-schematics-data-intro}

{{site.data.keyword.bplong}} 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 {{site.data.keyword.cos_short}}. This data-at-rest is encrypted using AES GCM 256 with an envelope encryption technique. As the {{site.data.keyword.cloud_notm}} account owner, you can control access to the {{site.data.keyword.bplong}} objects in your account. You can choose to delete your data, by using the {{site.data.keyword.bpshort}} API, UI, or CLI as described.

When you delete these {{site.data.keyword.bpshort}} objects, the corresponding data in {{site.data.keyword.cos_short}} is marked for deletion. The soft delete option enable you to recover the {{site.data.keyword.bpshort}} data by raising a support ticket. Further, your data are automatically purged after 7 days of soft delete.  

Also, {{site.data.keyword.bpshort}} service maintains a backup copy of your data in a separate {{site.data.keyword.cos_short}} 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 {{site.data.keyword.bpshort}} objects, if the {{site.data.keyword.bpshort}} services fails to delete the objects in your account. You need to raise a {{site.data.keyword.bpshort}} support ticket to completely remove from the resource controller. {: note}

Scope

{: #delete-schematics-data-scope}

The scope of deletion is limited to data stored in {{site.data.keyword.bpshort}} service and its backup.

Following points does not include in the scope of deletion of {{site.data.keyword.bpshort}} objects.

  • The deletion or removal of the {{site.data.keyword.cloud_notm}} resources that were provisioned by using {{site.data.keyword.bpshort}}.
  • The data stored by the {{site.data.keyword.cloud_notm}} resources provisioned by the {{site.data.keyword.bpshort}}.  
  • At the time of {{site.data.keyword.bpshort}} 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 {{site.data.keyword.cloud_notm}} resource list{: external} page.

Deleting {{site.data.keyword.bpshort}} objects from UI

{: #delete-schematics-data-ui} {: ui}

You can delete {{site.data.keyword.bpshort}} objects by using {{site.data.keyword.cloud_notm}} console. Following {{site.data.keyword.bpshort}} objects are used to store your data and helps to delete the {{site.data.keyword.bplong}} objects.

You must have Manager role to delete from these {{site.data.keyword.bplong}} objects. {: important}

Workspaces

{: #delete-schematics-data-wkscategory}

You can follow these steps to delete the {{site.data.keyword.bpshort}} objects by using {{site.data.keyword.cloud_notm}} console.

  1. From the {{site.data.keyword.bpshort}} workspaces dashboard{: external}, select the workspace that you want to delete.
  2. Click actions tab and select Delete workspace option.
  3. Type your workspace name in Type workspace_name to confirm text box.
  4. Click Delete button.

Actions

{: #delete-schematics-data-actionscategory}

You can follow these steps to delete the {{site.data.keyword.bpshort}} objects by using {{site.data.keyword.cloud_notm}} Console.

  1. From the {{site.data.keyword.bpshort}} workspaces dashboard{: external}, select the actions that you want to delete.
  2. Click Select the Actions drop down list and select Delete option.
  3. Type your actions name in Type action_name to confirm text box.
  4. Click Delete button.

Inventories

{: #delete-schematics-data-invcategory}

You can follow these steps to delete the {{site.data.keyword.bpshort}} objects by using {{site.data.keyword.cloud_notm}} Console.

  1. From the {{site.data.keyword.bpshort}} workspaces dashboard{: external}, select the inventories that you want to delete.
  2. Click ... dots against the inventory you want to delete and click Delete.
  3. Type your inventory name in Type Inventory_name to confirm text box.
  4. Click Delete button.

Deleting {{site.data.keyword.bpshort}} objects from CLI

{: #delete-schematics-data-cli} {: cli}

You can delete {{site.data.keyword.bpshort}} objects by using command-line. Following {{site.data.keyword.bpshort}} objects are used to store your data and helps to delete the {{site.data.keyword.bplong}} objects.

You must have Manager role to delete from these {{site.data.keyword.bplong}} objects. {: important}

Workspaces

{: #delete-schematics-data-cliwks}

You can follow these steps to delete the {{site.data.keyword.bpshort}} objects.

  1. Install the {{site.data.keyword.cloud_notm}} CLI and install the {{site.data.keyword.bplong}} plug-in
  2. 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 {{site.data.keyword.bpshort}} workspaces list command.
  3. Run ibmcloud schematics workspace delete --id WORKSPACE_ID [--force] to delete the workspace. For more information about workspace delete, see {{site.data.keyword.bpshort}} workspaces delete command.

Actions

{: #delete-schematics-data-cliactions}

You can follow these steps to delete the {{site.data.keyword.bpshort}} objects.

  1. Install the {{site.data.keyword.cloud_notm}} CLI and install the {{site.data.keyword.bplong}} plug-in
  2. 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 {{site.data.keyword.bpshort}} actions list command.
  3. Run ibmcloud schematics action delete --id ACTION_ID [--force] to delete an action. For more information about {{site.data.keyword.bpshort}} actions delete, see {{site.data.keyword.bpshort}} actions delete command.

Inventories

{: #delete-schematics-data-cliinvcategory}

You can follow these steps to delete the {{site.data.keyword.bpshort}} objects.

  1. Install the {{site.data.keyword.cloud_notm}} CLI and install the {{site.data.keyword.bplong}} plug-in
  2. 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 {{site.data.keyword.bpshort}} inventory list command.
  3. Run ibmcloud schematics inventory delete --id ACTION_ID to delete an inventory. For more information about {{site.data.keyword.bpshort}} inventory delete, see {{site.data.keyword.bpshort}} inventory delete command.

Deleting {{site.data.keyword.bpshort}} objects from API

{: #delete-schematics-data-api} {: api}

You can delete {{site.data.keyword.bpshort}} objects by using API. Following {{site.data.keyword.bpshort}} objects are used to store your data and helps to delete the {{site.data.keyword.bplong}} objects.

You must have Manager role to delete from these {{site.data.keyword.bplong}} objects. And select the {{site.data.keyword.bpshort}} endpoint to call the delete API. {: important}

Workspaces

{: #delete-schematics-data-apiwks}

You can follow these steps to delete the {{site.data.keyword.bpshort}} objects.

  1. Set up your REST client to execute {{site.data.keyword.bpshort}} API.
  2. 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 {{site.data.keyword.bpshort}} workspaces list API.
  3. 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 {{site.data.keyword.bpshort}} workspace delete API.

Actions

{: #delete-schematics-data-apiactions}

You can follow these steps to delete the {{site.data.keyword.bpshort}} objects.

  1. Set up your REST client to execute {{site.data.keyword.bpshort}} API.
  2. 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 {{site.data.keyword.bpshort}} actions list API.
  3. 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 {{site.data.keyword.bpshort}} actions delete, see {{site.data.keyword.bpshort}} actions delete API.

Inventories

{: #delete-schematics-data-apicategory}

You can follow these steps to delete the {{site.data.keyword.bpshort}} objects.

  1. Set up your REST client to execute {{site.data.keyword.bpshort}} API.
  2. 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 {{site.data.keyword.bpshort}} inventory list API.
  3. 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 {{site.data.keyword.bpshort}} inventory delete, see {{site.data.keyword.bpshort}} inventory delete API.