Deleting an EVS Snapshot

Function

This API is used to delete an EVS snapshot.

Constraints

  • A snapshot can be deleted only when it is in the available or error state.

URI

  • URI format

    DELETE /v3/{project_id}/snapshots/{snapshot_id}

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

    snapshot_id

    Yes

    Specifies the snapshot ID.

Request

  • Example request

    DELETE https://{endpoint}/v3/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995
    

Response

  • Parameter description

    Parameter

    Type

    Description

    error

    Object

    Specifies the error message returned when an error occurs. For details, see Parameters in the error field.

  • Parameters in the error field

    Parameter

    Type

    Description

    message

    String

    The error message returned if an error occurs.

    code

    String

    The error code returned if an error occurs.

    For details about the error code, see Error Codes.

  • Example response

    None

    or

    {
        "error": {
            "message": "XXXX",
            "code": "XXX"
        }
    }
    

    In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:

    {
        "itemNotFound": {
            "message": "XXXX",
            "code": "XXX"
        }
    }
    

Status Codes

  • Normal

    202

Error Codes

For details, see Error Codes.