diff --git a/api-ref/source/v3/samples/snapshot-force-delete-request.json b/api-ref/source/v3/samples/snapshot-force-delete-request.json new file mode 100644 index 00000000000..5c56464d919 --- /dev/null +++ b/api-ref/source/v3/samples/snapshot-force-delete-request.json @@ -0,0 +1,3 @@ +{ + "os-force_delete": {} +} diff --git a/api-ref/source/v3/volumes-v3-snapshots-actions.inc b/api-ref/source/v3/volumes-v3-snapshots-actions.inc index 6835b67e9ad..4ba975ab7ce 100644 --- a/api-ref/source/v3/volumes-v3-snapshots-actions.inc +++ b/api-ref/source/v3/volumes-v3-snapshots-actions.inc @@ -71,3 +71,36 @@ Request Example .. literalinclude:: ./samples/snapshot-status-update-request.json :language: javascript + + +Force delete a snapshot +~~~~~~~~~~~~~~~~~~~~~~~ + +.. rest_method:: POST /v3/{project_id}/snapshots/{snapshot_id}/action + +Attempts to force delete a snapshot, regardless of state. Specify the +``os-force_delete`` action in the request body. + +Response codes +-------------- + +.. rest_status_code:: success ../status.yaml + + - 202 + + +Request +------- + +.. rest_parameters:: parameters.yaml + + - project_id: project_id_path + - snapshot_id: snapshot_id_path + - os-force_delete: os-force_delete + + +Request Example +--------------- + +.. literalinclude:: ./samples/snapshot-force-delete-request.json + :language: javascript