Skip to main content

Delete a system

Contributors netapp-aoife

You can delete an existing Cloud Volumes ONTAP system.

Choose the workflow to use based on the type of the Cloud Volumes ONTAP deployment:

Delete a system for a single node

You can use this workflow to delete a system for a single node system.

Step 1. Select the system

Perform the workflow Get systems and choose the publicId value of the system for the workingEnvironmentId path parameter.

Step 2. Delete the system

You can issue a REST API call to delete a system for a single node.

HTTP method and endpoint

This REST API call uses the following method and endpoint.

HTTP method Path

DELETE

/occm/api/vsa/working-environments/{workingEnvironmentId}
Curl example
curl --request DELETE \
--location "https://api.bluexp.netapp.com/occm/api/vsa/working-environments/<WORKING_ENV_ID>" \
--header "x-agent-id: <AGENT_ID>" \
--header "Authorization: Bearer <ACCESS_TOKEN>" \
--header "Content-Type: application/json" \
Additional input parameters

In addition to the parameters common with all REST API calls, the following parameters are also used in the curl examples for this step.

Parameter Type Required Description

workingEnvironmentId <WORKING_ENV_ID>

Path

Yes

Identifies the system ID

localDelete

Query

No

If true, the Cloud Volumes ONTAP instance in the cloud is not terminated, but the NetApp Console no longer manages it (default is false).

forceDelete

Query

No

If true the system is deleted even if it is part of one or more SnapMirror relationships (default is false).
JSON output example

None

Delete a system for a high availability pair

You can use this workflow to delete a system for an HA pair.

Step 1. Select the system

Perform the workflow Get systems and choose the publicId value of the system for the workingEnvironmentId path parameter.

Step 2. Delete the system

You can issue a REST API call to delete a system for a single node.

HTTP method Path

DELETE

/occm/api/aws/ha/working-environments/{workingEnvironmentId}
Curl example
curl --request DELETE \
--location "https://api.bluexp.netapp.com/occm/api/aws/ha/working-environments/<WORKING_ENV_ID>" \
--header "x-agent-id: <AGENT_ID>" \
--header "Authorization: Bearer <ACCESS_TOKEN>" \
--header "Content-Type: application/json"
Additional input parameters

In addition to the parameters common with all REST API calls, the following parameters are also used in the curl examples for this step.

Parameter Type Required Description

workingEnvironmentId <WORKING_ENV_ID>

Path

Yes

Identifies the system ID

localDelete

Query

No

If true, the Cloud Volumes ONTAP instance in the cloud is not terminated, but the Console no longer manages it (default is false).

forceDelete

Query

No

If true the system is deleted even if it is part of one or more SnapMirror relationships (default is false).
JSON output example

None