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

# \UserDataApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_server_user_data**](UserDataApi.md#delete_server_user_data) | **DELETE** /instance/v1/zones/{zone}/servers/{server_id}/user_data/{key} | Delete user data
[**get_server_user_data**](UserDataApi.md#get_server_user_data) | **GET** /instance/v1/zones/{zone}/servers/{server_id}/user_data/{key} | Get user data
[**list_server_user_data**](UserDataApi.md#list_server_user_data) | **GET** /instance/v1/zones/{zone}/servers/{server_id}/user_data | List user data
[**set_server_user_data**](UserDataApi.md#set_server_user_data) | **PATCH** /instance/v1/zones/{zone}/servers/{server_id}/user_data/{key} | Add/Set user data



## delete_server_user_data

> delete_server_user_data(zone, server_id, key)
Delete user data

Delete the given key from a server user data.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**server_id** | **String** | UUID of the server | [required] |
**key** | **String** | Key of the user data 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)


## get_server_user_data

> crate::models::ScalewayPeriodStdPeriodFile get_server_user_data(zone, server_id, key)
Get user data

Get the content of a user data with the given key on a server.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**server_id** | **String** | UUID of the server | [required] |
**key** | **String** | Key of the user data to get | [required] |

### Return type

[**crate::models::ScalewayPeriodStdPeriodFile**](scaleway.std.File.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_server_user_data

> crate::models::ScalewayPeriodInstancePeriodV1PeriodListServerUserDataResponse list_server_user_data(zone, server_id)
List user data

List all user data keys registered on a given server.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**server_id** | **String** | UUID of the server | [required] |

### Return type

[**crate::models::ScalewayPeriodInstancePeriodV1PeriodListServerUserDataResponse**](scaleway.instance.v1.ListServerUserDataResponse.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_server_user_data

> set_server_user_data(zone, server_id, key, body)
Add/Set user data

Add or update a user data with the given key on a server.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**server_id** | **String** | UUID of the server | [required] |
**key** | **String** | Key of the user data to set | [required] |
**body** | **std::path::PathBuf** |  | [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)