summaryrefslogtreecommitdiff
path: root/api-ref/source/servers-action-deferred-delete.inc
blob: dd454551636b3e1d328c181bfe6dccc6f08fdfc3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
.. -*- rst -*-

Force-Delete Server (forceDelete Action)
========================================

.. rest_method:: POST /servers/{server_id}/action

Force-deletes a server before deferred cleanup.

Specify the ``forceDelete`` action in the request body.

Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.

Normal response codes: 202

Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409)

Request
-------

.. rest_parameters:: parameters.yaml


  - server_id: server_id_path
  - forceDelete: forceDelete

**Example Force-Delete Server (forceDelete Action): JSON request**

.. literalinclude:: ../../doc/api_samples/os-deferred-delete/force-delete-post-req.json
   :language: javascript

Response
--------

No body is returned on a successful submission.

Restore Soft-Deleted Instance (restore Action)
==============================================

.. rest_method:: POST /servers/{server_id}/action

Restores a previously soft-deleted server instance. You cannot use
this method to restore deleted instances.

Specify the ``restore`` action in the request body.

Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.

Normal response codes: 202

Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409)

Request
-------

.. rest_parameters:: parameters.yaml


  - server_id: server_id_path
  - restore: restore

**Example Restore Soft-Deleted Instance (restore Action): JSON request**

.. literalinclude:: ../../doc/api_samples/os-deferred-delete/restore-post-req.json
   :language: javascript

Response
--------

No body is returned on a successful submission.