Skip to main content
ONTAP REST API reference

Delete a consistency group snapshot

Contributors
PDFs

DELETE /application/consistency-groups/{consistency_group.uuid}/snapshots/{uuid}

Introduced In: 9.10

Deletes a snapshot of a consistency group.

Examples

Parameters

Name Type In Required Description

consistency_group.uuid

string

path

True

The unique identifier of the snapshot of the consistency group to delete.

uuid

string

path

True

Snapshot UUID

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

Response

Status: 200, Ok

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

53412007

Failed to delete the snapshot because it has not expired or is locked.

53412008

Failed to delete the consistency group snapshot because it is currently used as a reference for a replication relationship.

Also see the table of common errors in the Response body overview section of this documentation.

Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.