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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
|
.. -*- rst -*-
==============
Address groups
==============
Lists, creates, shows details for, updates, and deletes address groups.
Show address group
==================
.. rest_method:: GET /v2.0/address-groups/{address_group_id}
Shows information for an address group.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404
Request
-------
.. rest_parameters:: parameters.yaml
- address_group_id: address_group_id-path
- fields: fields
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- address_group: address_group
- id: address_group_id_body
- name: name
- description: description
- tenant_id: project_id
- project_id: project_id
- addresses: addresses
Response Example
----------------
.. literalinclude:: samples/address-groups/address-group-show-response.json
:language: javascript
Update an address group
=======================
.. rest_method:: PUT /v2.0/address-groups/{address_group_id}
Updates an address group.
Normal response codes: 200
Error response codes: 400, 401, 403, 404, 412
Request
-------
.. rest_parameters:: parameters.yaml
- address_group_id: address_group_id-path
- address_group: address_group
- name: name-request
- description: description
Request Example
---------------
.. literalinclude:: samples/address-groups/address-group-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- address_group: address_group
- id: address_group_id_body
- name: name
- description: description
- tenant_id: project_id
- project_id: project_id
- addresses: addresses
Response Example
----------------
.. literalinclude:: samples/address-groups/address-group-update-response.json
:language: javascript
Delete an address group
=======================
.. rest_method:: DELETE /v2.0/address-groups/{address_group_id}
Deletes an address group.
Normal response codes: 204
Error response codes: 401, 404, 412
Request
-------
.. rest_parameters:: parameters.yaml
- address_group_id: address_group_id-path
Response
--------
There is no body content for the response of a successful DELETE request.
List address groups
===================
.. rest_method:: GET /v2.0/address-groups
Lists address groups that the project has access to.
Default policy settings return only the address groups owned by
the project of the user submitting the request, unless the
user has administrative role.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401
Request
-------
.. rest_parameters:: parameters.yaml
- id: id-query
- name: name-query
- tenant_id: project_id-query
- project_id: project_id-query
- sort_key: address_group-sort_key
- fields: fields
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- address_groups: address_groups
- id: address_group_id_body
- name: name
- tenant_id: project_id
- project_id: project_id
- addresses: addresses
Response Example
----------------
.. literalinclude:: samples/address-groups/address-groups-list-response.json
:language: javascript
Create address group
====================
.. rest_method:: POST /v2.0/address-groups
Creates an address group.
Normal response codes: 201
Error response codes: 400, 401, 403, 404
Request
-------
.. rest_parameters:: parameters.yaml
- address_group_id: address_group_id-path
- address_group: address_group
- name: name-request
- description: description
- addresses: addresses
Request Example
---------------
.. literalinclude:: samples/address-groups/address-group-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- address_group: address_group
- id: address_group_id_body
- name: name
- description: description
- tenant_id: project_id
- project_id: project_id
- addresses: addresses
Response Example
----------------
.. literalinclude:: samples/address-groups/address-group-create-response.json
:language: javascript
Add IP addresses to address group
=================================
.. rest_method:: PUT /v2.0/address-group/{address_group_id}/add_addresses
Atomically adds a set of IP addresses to the address group's already existing
addresses.
Normal response codes: 200
Error response codes: 400, 401, 404, 412
Request
-------
.. rest_parameters:: parameters.yaml
- address_group_id: address_group_id-path
- addresses: addresses
Request Example
---------------
.. literalinclude:: samples/address-groups/address-group-add-addresses-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- address_group: address_group
- id: address_group_id_body
- name: name
- description: description
- tenant_id: project_id
- project_id: project_id
- addresses: addresses
Response Example
----------------
.. literalinclude:: samples/address-groups/address-group-add-addresses-response.json
:language: javascript
Remove IP addresses to address group
====================================
.. rest_method:: PUT /v2.0/address-group/{address_group_id}/remove_addresses
Atomically removes a set of IP addresses from the address group's already
existing addresses.
Normal response codes: 200
Error response codes: 400, 401, 404, 412
Request
-------
.. rest_parameters:: parameters.yaml
- address_group_id: address_group_id-path
- addresses: addresses
Request Example
---------------
.. literalinclude:: samples/address-groups/address-group-remove-addresses-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- address_group: address_group
- id: address_group_id_body
- name: name
- description: description
- tenant_id: project_id
- project_id: project_id
- addresses: addresses
Response Example
----------------
.. literalinclude:: samples/address-groups/address-group-remove-addresses-response.json
:language: javascript
|
