Skip to main content

Delete a volume

Contributors netapp-aoife

You can delete an existing volume.

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

Delete a volume for a single node

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

Step 1. Select the system

Perform the workflow Get systems and choose the publicId and svmName values of the system for the workingEnvironmentId and svmName path parameters.

Step 2. Select the volume

Perform the workflow Get volumes and choose the name of the required volume for the volumeName path parameter.

Step 3. Delete the volume

You can issue the REST API call to delete the volume.

HTTP method and endpoint

This REST API call uses the following method and endpoint.

HTTP method Path

DELETE

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

The JSON input example includes the minimum list of parameters.

Parameter Type Required Description

<SVM_NAME> (svmName)

Path

Yes

Identifies the SVM

workingEnvironmentId <WORKING_ENV_ID>

Path

Yes

Identifies the system ID

<VOLUME_NAME> (volumeName)

Path

Yes

Identifies the volume
Output

None

Delete a volume for a high availability pair

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

Step 1. Select the system

Perform the workflow Get systems and choose the publicId and svmName values of the system for the workingEnvironmentId and svmName path parameters.

Step 2. Select the volume

Perform the workflow Get volumes and choose the name of teh required volume for volumeName path parameter.

Step 3. Delete the volume

You can issue the REST API call to delete the volume.

HTTP method and endpoint

This REST API call uses the following method and endpoint.

HTTP method Path

DELETE

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

The JSON input example includes the minimum list of parameters.

Parameter Type Required Description

<SVM_NAME> (svmName)

Path

Yes

Identifies the SVM

workingEnvironmentId <WORKING_ENV_ID>

Path

Yes

Identifies the system ID

<VOLUME_NAME> (volumeName)

Path

Yes

Identifies the volume
Output

None