summaryrefslogtreecommitdiff
path: root/api-ref/source/configurations.inc
blob: d65ce5bbcb9fa864a83be4e35827bf29ace5874f (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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
.. -*- rst -*-

====================
Configuration groups
====================




List configuration groups
~~~~~~~~~~~~~~~~~~~~~~~~~

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

Lists all configuration groups.

Normal response codes: 200


Request
-------

.. rest_parameters:: parameters.yaml

   - project_id: project_id


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

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




Create configuration group
~~~~~~~~~~~~~~~~~~~~~~~~~~

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

Creates a configuration group.

Normal response codes: 200

Request
-------

.. rest_parameters:: parameters.yaml

   - project_id: project_id
   - datastore: datastore
   - name: name
   - values: values


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

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


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

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




Show configuration group details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

Lists details about a configuration group, including its values.

Normal response codes: 200


Request
-------

.. rest_parameters:: parameters.yaml

   - project_id: project_id
   - configId: configId


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

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




List instances applied the configuration group
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

Lists the instances associated with the specified configuration group.

Normal response codes: 200


Request
-------

.. rest_parameters:: parameters.yaml

   - project_id: project_id
   - configId: configId


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

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




Patch configuration group
~~~~~~~~~~~~~~~~~~~~~~~~~

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

Sets new values for a configuration group.

Normal response codes: 200


Request
-------

.. rest_parameters:: parameters.yaml

   - project_id: project_id
   - configId: configId
   - values: values


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

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




Update configuration group
~~~~~~~~~~~~~~~~~~~~~~~~~~

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

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

Normal response codes: 202


Request
-------

.. rest_parameters:: parameters.yaml

   - project_id: project_id
   - configId: configId
   - values: values
   - description: description
   - name: name


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

.. literalinclude:: samples/config-group-put-request.json
   :language: javascript




Delete configuration group
~~~~~~~~~~~~~~~~~~~~~~~~~~

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

Deletes a configuration group.

Normal response codes: 202


Request
-------

.. rest_parameters:: parameters.yaml

   - project_id: project_id
   - configId: configId