scaleway_api_rs 0.1.8

Generated library to interact with Scaleway API.
Documentation 
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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396

# \SecurityGroupsApi

All URIs are relative to *https://api.scaleway.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_security_group**](SecurityGroupsApi.md#create_security_group) | **POST** /instance/v1/zones/{zone}/security_groups | Create a security group
[**create_security_group_rule**](SecurityGroupsApi.md#create_security_group_rule) | **POST** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules | Create rule
[**delete_security_group**](SecurityGroupsApi.md#delete_security_group) | **DELETE** /instance/v1/zones/{zone}/security_groups/{security_group_id} | Delete a security group
[**delete_security_group_rule**](SecurityGroupsApi.md#delete_security_group_rule) | **DELETE** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules/{security_group_rule_id} | Delete rule
[**get_security_group**](SecurityGroupsApi.md#get_security_group) | **GET** /instance/v1/zones/{zone}/security_groups/{security_group_id} | Get a security group
[**get_security_group_rule**](SecurityGroupsApi.md#get_security_group_rule) | **GET** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules/{security_group_rule_id} | Get rule
[**list_default_security_group_rules**](SecurityGroupsApi.md#list_default_security_group_rules) | **GET** /instance/v1/zones/{zone}/security_groups/default/rules | Get default rules
[**list_security_group_rules**](SecurityGroupsApi.md#list_security_group_rules) | **GET** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules | List rules
[**list_security_groups**](SecurityGroupsApi.md#list_security_groups) | **GET** /instance/v1/zones/{zone}/security_groups | List security groups
[**set_security_group**](SecurityGroupsApi.md#set_security_group) | **PUT** /instance/v1/zones/{zone}/security_groups/{id} | Update a security group
[**set_security_group_rule**](SecurityGroupsApi.md#set_security_group_rule) | **PUT** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules/{security_group_rule_id} | Update security group rule
[**set_security_group_rules**](SecurityGroupsApi.md#set_security_group_rules) | **PUT** /instance/v1/zones/{zone}/security_groups/{security_group_id}/rules | Update all the rules of a security group



## create_security_group

> crate::models::ScalewayPeriodInstancePeriodV1PeriodCreateSecurityGroupResponse create_security_group(zone, create_security_group_request)
Create a security group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**create_security_group_request** | [**CreateSecurityGroupRequest**](CreateSecurityGroupRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodCreateSecurityGroupResponse**](scaleway.instance.v1.CreateSecurityGroupResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_security_group_rule

> crate::models::ScalewayPeriodInstancePeriodV1PeriodCreateSecurityGroupRuleResponse create_security_group_rule(zone, security_group_id, create_security_group_rule_request)
Create rule

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**security_group_id** | **String** | UUID of the security group | [required] |
**create_security_group_rule_request** | [**CreateSecurityGroupRuleRequest**](CreateSecurityGroupRuleRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodCreateSecurityGroupRuleResponse**](scaleway.instance.v1.CreateSecurityGroupRuleResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_security_group

> delete_security_group(zone, security_group_id)
Delete a security group

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**security_group_id** | **String** | UUID of the security group you want to delete | [required] |

### Return type

 (empty response body)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_security_group_rule

> delete_security_group_rule(zone, security_group_id, security_group_rule_id)
Delete rule

Delete a security group rule with the given ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**security_group_id** | **String** |  | [required] |
**security_group_rule_id** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_security_group

> crate::models::ScalewayPeriodInstancePeriodV1PeriodGetSecurityGroupResponse get_security_group(zone, security_group_id)
Get a security group

Get the details of a Security Group with the given ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**security_group_id** | **String** | UUID of the security group you want to get | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodGetSecurityGroupResponse**](scaleway.instance.v1.GetSecurityGroupResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_security_group_rule

> crate::models::ScalewayPeriodInstancePeriodV1PeriodGetSecurityGroupRuleResponse get_security_group_rule(zone, security_group_id, security_group_rule_id)
Get rule

Get details of a security group rule with the given ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**security_group_id** | **String** |  | [required] |
**security_group_rule_id** | **String** |  | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodGetSecurityGroupRuleResponse**](scaleway.instance.v1.GetSecurityGroupRuleResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_default_security_group_rules

> crate::models::ScalewayPeriodInstancePeriodV1PeriodListSecurityGroupRulesResponse list_default_security_group_rules(zone)
Get default rules

Lists the default rules applied to all the security groups.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodListSecurityGroupRulesResponse**](scaleway.instance.v1.ListSecurityGroupRulesResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_security_group_rules

> crate::models::ScalewayPeriodInstancePeriodV1PeriodListSecurityGroupRulesResponse list_security_group_rules(zone, security_group_id, per_page, page)
List rules

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**security_group_id** | **String** | UUID of the security group | [required] |
**per_page** | Option<**i32**> | A positive integer lower or equal to 100 to select the number of items to return |  |
**page** | Option<**i32**> | A positive integer to choose the page to return |  |[default to 1]

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodListSecurityGroupRulesResponse**](scaleway.instance.v1.ListSecurityGroupRulesResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_security_groups

> crate::models::ScalewayPeriodInstancePeriodV1PeriodListSecurityGroupsResponse list_security_groups(zone, name, organization, project, tags, project_default, per_page, page)
List security groups

List all security groups available in an account.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**name** | Option<**String**> | Name of the security group |  |
**organization** | Option<**String**> | The security group organization ID |  |
**project** | Option<**String**> | The security group project ID |  |
**tags** | Option<**String**> | List security groups with these exact tags (to filter with several tags, use commas to separate them) |  |
**project_default** | Option<**bool**> | Filter security groups with this value for project_default |  |
**per_page** | Option<**i32**> | A positive integer lower or equal to 100 to select the number of items to return |  |
**page** | Option<**i32**> | A positive integer to choose the page to return |  |[default to 1]

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodListSecurityGroupsResponse**](scaleway.instance.v1.ListSecurityGroupsResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## set_security_group

> crate::models::ScalewayPeriodInstancePeriodV1PeriodSetSecurityGroupResponse set_security_group(zone, id, set_security_group_request)
Update a security group

Replace all security group properties with a security group message.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**id** | **String** | The ID of the security group (will be ignored) | [required] |
**set_security_group_request** | [**SetSecurityGroupRequest**](SetSecurityGroupRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodSetSecurityGroupResponse**](scaleway.instance.v1.SetSecurityGroupResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## set_security_group_rule

> crate::models::ScalewayPeriodInstancePeriodV1PeriodSetSecurityGroupRuleResponse set_security_group_rule(zone, security_group_id, security_group_rule_id, set_security_group_rule_request)
Update security group rule

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**security_group_id** | **String** |  | [required] |
**security_group_rule_id** | **String** |  | [required] |
**set_security_group_rule_request** | [**SetSecurityGroupRuleRequest**](SetSecurityGroupRuleRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodSetSecurityGroupRuleResponse**](scaleway.instance.v1.SetSecurityGroupRuleResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## set_security_group_rules

> crate::models::ScalewayPeriodInstancePeriodV1PeriodSetSecurityGroupRulesResponse set_security_group_rules(zone, security_group_id, set_security_group_rules_request)
Update all the rules of a security group

Replaces the rules of the security group with the rules provided. This endpoint supports the update of existing rules, creation of new rules and deletion of existing rules when they are not passed in the request.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**security_group_id** | **String** | UUID of the security group to update the rules on | [required] |
**set_security_group_rules_request** | [**SetSecurityGroupRulesRequest**](SetSecurityGroupRulesRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodSetSecurityGroupRulesResponse**](scaleway.instance.v1.SetSecurityGroupRulesResponse.md)

### Authorization

[scaleway](../README.md#scaleway)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)