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

# \PrivateNetworksApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_private_network**](PrivateNetworksApi.md#create_private_network) | **POST** /vpc/v1/zones/{zone}/private-networks | Create a private network
[**delete_private_network**](PrivateNetworksApi.md#delete_private_network) | **DELETE** /vpc/v1/zones/{zone}/private-networks/{private_network_id} | Delete a private network
[**get_private_network**](PrivateNetworksApi.md#get_private_network) | **GET** /vpc/v1/zones/{zone}/private-networks/{private_network_id} | Get a private network
[**list_private_networks**](PrivateNetworksApi.md#list_private_networks) | **GET** /vpc/v1/zones/{zone}/private-networks | List private networks
[**update_private_network**](PrivateNetworksApi.md#update_private_network) | **PATCH** /vpc/v1/zones/{zone}/private-networks/{private_network_id} | Update private network



## create_private_network

> crate::models::ScalewayPeriodVpcPeriodV1PeriodPrivateNetwork create_private_network(zone, create_private_network_request)
Create a private network

### Parameters


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

### Return type

[**crate::models::ScalewayPeriodVpcPeriodV1PeriodPrivateNetwork**](scaleway.vpc.v1.PrivateNetwork.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_private_network

> delete_private_network(zone, private_network_id)
Delete a private network

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**private_network_id** | **String** | The private network ID | [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_private_network

> crate::models::ScalewayPeriodVpcPeriodV1PeriodPrivateNetwork get_private_network(zone, private_network_id)
Get a private network

### Parameters


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

### Return type

[**crate::models::ScalewayPeriodVpcPeriodV1PeriodPrivateNetwork**](scaleway.vpc.v1.PrivateNetwork.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_private_networks

> crate::models::ScalewayPeriodVpcPeriodV1PeriodListPrivateNetworksResponse list_private_networks(zone, order_by, page, page_size, name, tags, organization_id, project_id, private_network_ids)
List private networks

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**order_by** | Option<**String**> | The sort order of the returned private networks |  |[default to created_at_asc]
**page** | Option<**i32**> | The page number for the returned private networks |  |[default to 1]
**page_size** | Option<**i32**> | The maximum number of private networks per page |  |[default to 20]
**name** | Option<**String**> | Filter private networks with names containing this string |  |
**tags** | Option<[**Vec<String>**](String.md)> | Filter private networks with one or more matching tags |  |
**organization_id** | Option<**String**> | The organization ID on which to filter the returned private networks |  |
**project_id** | Option<**String**> | The project ID on which to filter the returned private networks |  |
**private_network_ids** | Option<[**Vec<String>**](String.md)> | The PrivateNetwork IDs on which to filter the returned private networks (UUID format) |  |

### Return type

[**crate::models::ScalewayPeriodVpcPeriodV1PeriodListPrivateNetworksResponse**](scaleway.vpc.v1.ListPrivateNetworksResponse.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)


## update_private_network

> crate::models::ScalewayPeriodVpcPeriodV1PeriodPrivateNetwork update_private_network(zone, private_network_id, update_private_network_request)
Update private network

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**private_network_id** | **String** | The private network ID | [required] |
**update_private_network_request** | [**UpdatePrivateNetworkRequest**](UpdatePrivateNetworkRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodVpcPeriodV1PeriodPrivateNetwork**](scaleway.vpc.v1.PrivateNetwork.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)