.. -*- rst -*-

Group snapshots (group_snapshots)
=================================

Lists all, lists all with details, shows details for, creates, and
deletes group snapshots.


Delete group snapshot
~~~~~~~~~~~~~~~~~~~~~

.. rest_method::  DELETE /v3/{project_id}/group_snapshots/{group_snapshot_id}

Deletes a group snapshot.


Response codes
--------------

.. rest_status_code:: success ../status.yaml

   - 202

.. rest_status_code:: error ../status.yaml

   - 400
   - 404


Request
-------

.. rest_parameters:: parameters.yaml

   - project_id: project_id_path
   - group_snapshot_id: group_snapshot_id_path


Show group snapshot details
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. rest_method::  GET /v3/{project_id}/group_snapshots/{group_snapshot_id}

Shows details for a group snapshot.


Response codes
--------------

.. rest_status_code:: success ../status.yaml

   - 200

.. rest_status_code:: error ../status.yaml

   - 400
   - 404


Request
-------

.. rest_parameters:: parameters.yaml

   - project_id: project_id_path
   - group_snapshot_id: group_snapshot_id_path


Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - group_snapshot: group_snapshot
   - created_at: created_at
   - group_id: source_group_id_req
   - id: group_snapshot_id_req
   - name: name_group_snap_req
   - status: status_group_snap
   - description: description_group_snap_req
   - group_type_id: group_type_id
   - project_id: project_id_group_snapshot

Response Example
----------------

.. literalinclude:: ./samples/group-snapshots-show-response.json
   :language: javascript


List group snapshots with details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. rest_method::  GET /v3/{project_id}/group_snapshots/detail

Lists all group snapshots with details. Since v3.31 if non-admin
users specify invalid filters in the url, API will return bad request.


Response codes
--------------

.. rest_status_code:: success ../status.yaml

   - 200

.. rest_status_code:: error ../status.yaml

   - 400

Request
-------

.. rest_parameters:: parameters.yaml

   - project_id: project_id_path
   - all_tenants: all-tenants
   - sort: sort_group_snapshot
   - sort_key: sort_key_group_snapshot
   - sort_dir: sort_dir_group_snapshot
   - limit: limit_group_snapshot
   - offset: offset_group_snapshot
   - marker: marker_group_snapshot


Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - group_snapshots: group_snapshots
   - id: group_snapshot_id_req
   - name: name_group_snap_req
   - status: status_group_snap
   - description: description_group_snap_req
   - created_at: created_at
   - group_id: group_id
   - group_type_id: group_type_id
   - project_id: project_id_group_snapshot

Response Example
----------------

.. literalinclude:: ./samples/group-snapshots-list-detailed-response.json
   :language: javascript

List group snapshots
~~~~~~~~~~~~~~~~~~~~

.. rest_method::  GET /v3/{project_id}/group_snapshots

Lists all group snapshots, since v3.31 if non-admin users
specify invalid filters in the url, API will return bad request.


Response codes
--------------

.. rest_status_code:: success ../status.yaml

   - 200

.. rest_status_code:: error ../status.yaml

   - 400


Request
-------

.. rest_parameters:: parameters.yaml

   - project_id: project_id_path
   - all_tenants: all-tenants
   - sort: sort_group_snapshot
   - sort_key: sort_key_group_snapshot
   - sort_dir: sort_dir_group_snapshot
   - limit: limit_group_snapshot
   - offset: offset_group_snapshot
   - marker: marker_group_snapshot


Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - group_snapshots: group_snapshots
   - id: group_snapshot_id_req
   - name: name_group_snap_req


Response Example
----------------

.. literalinclude:: ./samples/group-snapshots-list-response.json
   :language: javascript


Create group snapshot
~~~~~~~~~~~~~~~~~~~~~

.. rest_method::  POST /v3/{project_id}/group_snapshots

Creates a group snapshot.

Response codes
--------------

.. rest_status_code:: success ../status.yaml

   - 202

.. rest_status_code:: error ../status.yaml

   - 400
   - 404


Request
-------

.. rest_parameters:: parameters.yaml

   - project_id: project_id_path
   - group_snapshot: group_snapshot
   - name: name_group_snap
   - description: description_group_snap
   - group_id: group_id

Request Example
---------------

.. literalinclude:: ./samples/group-snapshots-create-request.json
   :language: javascript

Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - group_snapshot: group_snapshot
   - id: group_snapshot_id_req
   - name: name_group_snap_req
   - group_type_id: group_type_id

Response Example
----------------

.. literalinclude:: ./samples/group-snapshots-create-response.json
   :language: javascript


Reset group snapshot status
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. rest_method::
   POST /v3/{project_id}/group_snapshots/{group_snapshot_id}/action

Resets the status for a group snapshot. Specifies the ``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

   - project_id: project_id_path
   - group_snapshot_id: group_snapshot_id_path
   - reset_status: reset_status
   - status: status_group_snap

Request Example
---------------

.. literalinclude:: ./samples/group-snapshot-reset-status-request.json
   :language: javascript
