Reference Guide

Deleting a resource instance
To delete a resource instance, use the following request components:
Headers
Accept: application/json
Authorization: <auth_cookie>
If a resource type has request arguments for the DELETE operation, you must also use the following header:
Content-Type: application/json
Operation
DELETE
URI
pattern
/api/rest/<resource_type>/<id>
where:
● <resource_type> is the resource type of the instance you want to delete.
● <id> is the unique identifier of the instance you want to delete.
For additional functionality, such as making the request an asynchronous request, you can append one or more
request parameters to the URI.
Body For most resource types, the body of a DELETE request is empty. However, if a resource type has request
arguments for the DELETE operation, they are passed as a comma-separated list of standard JSON name:value
pairs.
If the request succeeds, it returns a 204 No Content HTTP status code and an empty response body. If the request does not
succeed, the server returns a 4xx or 5xx HTTP status code in the response header and a message entity in the response body.
Deleting a volume_group instance
The following request deletes the volume_group instance that has an id of 23772434-6373-4748-aa1a-
f4197475812a:
Headers
Accept: application/json
Content-Type: application/json
Authorization: <auth_cookie>
Request
DELETE https://1.2.3.4/api/rest/volume_group/23772434-6373-4748-aa1a-
f4197475812a
Request
body
Empty.
Response
body
Empty.
Performing an instance-level resource-specific action
Some resource types have operations that let you perform resource-specific actions on resource instances beyond the standard
delete and modify actions. For example, you can use the volume resource type's refresh operation to refresh the contents of
a volume from another volume in the same family.
To perform a resource-specific action on a resource instance, use the following request components:
38
Creating other types of requests