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
|
.. -*- rst -*-
========
Segments
========
Lists, shows details for, creates, updates, and deletes segments. The
segments API is admin-only.
Resource timestamps
===================
The ``standard-attr-timestamp`` extension adds the ``created_at`` and
``updated_at`` attributes to all resources that have standard attributes.
Show segment details
====================
.. rest_method:: GET /v2.0/segments/{segment_id}
Shows details for a segment.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404
Request
-------
.. rest_parameters:: parameters.yaml
- segment_id: segment_id-path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: segment_id
- network_id: network_id
- physical_network: provider:physical_network
- network_type: network_type
- revision_number: revision_number
- segmentation_id: provider:segmentation_id
- name: name
- description: description
- created_at: created_at_resource
- updated_at: updated_at_resource
Response Example
----------------
.. literalinclude:: samples/segments/segment-show-response.json
:language: javascript
Update segment
==============
.. rest_method:: PUT /v2.0/segments/{segment_id}
Updates a segment.
Normal response codes: 200
Error response codes: 400, 401, 403, 404, 412
Request
-------
.. rest_parameters:: parameters.yaml
- segment_id: segment_id-path
- name: name-segment
- description: description-request
Request Example
---------------
.. literalinclude:: samples/segments/segment-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: segment_id
- network_id: network_id
- physical_network: provider:physical_network
- network_type: network_type
- revision_number: revision_number
- segmentation_id: provider:segmentation_id
- name: name
- description: description
- created_at: created_at_resource
- updated_at: updated_at_resource
Response Example
----------------
.. literalinclude:: samples/segments/segment-update-response.json
:language: javascript
Delete segment
==============
.. rest_method:: DELETE /v2.0/segments/{segment_id}
Deletes a segment and its associated resources.
Normal response codes: 204
Error response codes: 401, 404, 409, 412
Request
-------
.. rest_parameters:: parameters.yaml
- segment_id: segment_id-path
Response
--------
There is no body content for the response of a successful DELETE request.
List segments
=============
.. rest_method:: GET /v2.0/segments
Lists segments to which the project has access.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401
Request
-------
.. rest_parameters:: parameters.yaml
- id: id-query
- network_id: network_id-query
- physical_network: provider:physical_network-query
- network_type: provider:network_type-query
- revision_number: revision_number-query
- segmentation_id: provider:segmentation_id-query
- name: name-query
- description: description-query
- sort_dir: sort_dir
- sort_key: segment-sort_key
- fields: fields
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: segment_id
- network_id: network_id
- physical_network: provider:physical_network
- network_type: network_type
- revision_number: revision_number
- segmentation_id: provider:segmentation_id
- name: name
- description: description
- created_at: created_at_resource
- updated_at: updated_at_resource
Response Example
----------------
.. literalinclude:: samples/segments/segments-list-response.json
:language: javascript
Create segment
==============
.. rest_method:: POST /v2.0/segments
Creates a segment.
Normal response codes: 201
Error response codes: 400, 401
Request
-------
.. rest_parameters:: parameters.yaml
- network_id: network_id
- physical_network: provider:physical_network
- network_type: network_type
- segmentation_id: provider:segmentation_id
- name: name-segment
- description: description-request
Request Example
---------------
.. literalinclude:: samples/segments/segment-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: segment_id
- network_id: network_id
- physical_network: provider:physical_network
- network_type: network_type
- revision_number: revision_number
- segmentation_id: provider:segmentation_id
- name: name
- description: description
- created_at: created_at_resource
- updated_at: updated_at_resource
Response Example
----------------
.. literalinclude:: samples/segments/segment-create-response.json
:language: javascript
|
