.. -*- rst -*-

=====================================
Configuration groups (configurations)
=====================================

Creates and lists all configuration groups.


Create configuration group
==========================

.. rest_method::  POST /v1.0/{accountId}/configurations

Creates a configuration group.


Normal response codes: 200
Error response codes:413,405,404,403,401,400,422,503,500,501,


Request
-------

.. rest_parameters:: parameters.yaml

   - datastore: datastore
   - values: values
   - name: name
   - accountId: accountId

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

.. literalinclude:: samples/db-create-config-grp-request.json
   :language: javascript





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

.. literalinclude:: samples/db-create-config-grp-response.json
   :language: javascript














List configuration groups
=========================

.. rest_method::  GET /v1.0/{accountId}/configurations

Lists all configuration groups.

The list includes the associated data store and data store version
for each configuration group.


Normal response codes: 200
Error response codes:413,405,404,403,401,400,422,503,500,501,


Request
-------

.. rest_parameters:: parameters.yaml

   - accountId: accountId




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

.. literalinclude:: samples/db-list-cfg-groups-response.json
   :language: javascript














List configuration group instances
==================================

.. rest_method::  GET /v1.0/{accountId}/configurations/{configId}/instances

Lists the instances associated with the specified configuration group.


Normal response codes: 200
Error response codes:413,405,404,403,401,400,422,503,500,501,


Request
-------

.. rest_parameters:: parameters.yaml

   - configId: configId
   - accountId: accountId




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

.. literalinclude:: samples/db-config-group-instances-response.json
   :language: javascript














Delete configuration group
==========================

.. rest_method::  DELETE /v1.0/{accountId}/configurations/{configId}

Deletes a configuration group.

Error response codes:202,413,405,404,403,401,400,422,503,500,501,


Request
-------

.. rest_parameters:: parameters.yaml

   - configId: configId
   - accountId: accountId
















Patch configuration group
=========================

.. rest_method::  PATCH /v1.0/{accountId}/configurations/{configId}

Sets new values for a configuration group.


Normal response codes: 200
Error response codes:413,405,404,403,401,400,422,503,500,501,


Request
-------

.. rest_parameters:: parameters.yaml

   - values: values
   - configId: configId
   - accountId: accountId

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

.. literalinclude:: samples/db-patch-config-grp-request.json
   :language: javascript





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

.. literalinclude:: samples/db-patch-config-grp-response-json-http.txt
   :language: javascript














Show configuration group details
================================

.. rest_method::  GET /v1.0/{accountId}/configurations/{configId}

Lists details about a configuration group, including its values.


Normal response codes: 200
Error response codes:413,405,404,403,401,400,422,503,500,501,


Request
-------

.. rest_parameters:: parameters.yaml

   - configId: configId
   - accountId: accountId




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

.. literalinclude:: samples/db-config-group-details-response.json
   :language: javascript














Update configuration group
==========================

.. rest_method::  PUT /v1.0/{accountId}/configurations/{configId}

Sets new values for a configuration group. Also lets you change the name and description of the configuration group.

Error response codes:202,413,405,404,403,401,400,422,503,500,501,


Request
-------

.. rest_parameters:: parameters.yaml

   - values: values
   - description: description
   - name: name
   - configId: configId
   - accountId: accountId

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

.. literalinclude:: samples/db-update-config-grp-request.json
   :language: javascript