Deleting a snapshot group

Storage Advisor Embedded User Guide

Version
93-07-2x
88-08-12
Audience
anonymous
Part Number
MK-97HM85022-25

The following request deletes a snapshot group and all snapshots in the snapshot group for the specified snapshot group name.

Execution permission

Storage Administrator (Local Copy)

Request line

DELETE base-URL/simple/v1/objects/snapshot-groups/object-ID

Request message

Object ID

Specify a value for the name that was obtained by getting the list of snapshot group names.

Attribute

Type

Description

name

string

(Required) Snapshot group name

Note:

Do not specify a snapshot group name that contains a slash (/) or a backslash (\).

To delete a snapshot group with a name contains a slash (/) or a backslash (\), run the API request for deleting a snapshot.

If all snapshots in a snapshot group are deleted, the snapshot group is also deleted automatically.

Query parameters
None.
Body
None.

Response message

Body

Attribute

Type

Description

statusResource

string

URL used to obtain the results of the delete the snapshot group request

Note:

Run the API function for obtaining information about the status of the API function that performs asynchronous processing. For details, see Getting status information about an API function that performs asynchronous processing.

Status codes

See HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X DELETE https://192.0.2.100/ConfigurationManager/simple/v1/objects/snapshot-groups/snapshotGroup