cinder/api-ref/source/v2/ext-backups-actions-v2.inc
Sean McGinnis d5b539be36
Doc8: Stop skipping D001: Line too long
This cleans up the cases where we had D001 violations so we can stop
skipping that check in doc8 runs.

Change-Id: Ie52f6ecac1a645fcbcc643b9ca63e033b622d830
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-02-19 16:51:56 -06:00

87 lines
1.5 KiB
ReStructuredText

.. -*- rst -*-
Backup actions (backups, action)
================================
Force-deletes a backup and reset status for a backup.
Force-delete backup
~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/{project_id}/backups/{backup_id}/action
Force-deletes a backup. Specify the ``os-force_delete`` action in the request
body.
This operation deletes the backup and any backup data.
The backup driver returns the ``405`` status code if it does not
support this operation.
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 202
.. rest_status_code:: error ../status.yaml
- 404
- 405
Request
-------
.. rest_parameters:: parameters.yaml
- os-force_delete: os-force_delete
- project_id: project_id_path
- backup_id: backup_id
Request Example
---------------
.. literalinclude:: ./samples/backup-force-delete-request.json
:language: javascript
Reset backup's status
~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/{project_id}/backups/{backup_id}/action
Reset a backup's status. Specify the ``os-reset_status`` action in the request
body.
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 202
.. rest_status_code:: error ../status.yaml
- 400
- 404
Request
-------
.. rest_parameters:: parameters.yaml
- status: status_7
- os-reset_status: os-reset_status
- project_id: project_id_path
- backup_id: backup_id
Request Example
---------------
.. literalinclude:: ./samples/backup-reset-status-request.json
:language: javascript