incus-client 0.1.0

Auto-generated Rust client for the Incus container and VM manager REST 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

# \ImagesApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**image_delete**](ImagesApi.md#image_delete) | **DELETE** /1.0/images/{fingerprint} | Delete the image
[**image_get**](ImagesApi.md#image_get) | **GET** /1.0/images/{fingerprint} | Get the image
[**image_patch**](ImagesApi.md#image_patch) | **PATCH** /1.0/images/{fingerprint} | Partially update the image
[**image_put**](ImagesApi.md#image_put) | **PUT** /1.0/images/{fingerprint} | Update the image
[**images_get**](ImagesApi.md#images_get) | **GET** /1.0/images | Get the images



## image_delete

> models::InstancesPut202Response image_delete(fingerprint, project)
Delete the image

Removes the image from the image store.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fingerprint** | **String** | Fingerprint | [required] |
**project** | Option<**String**> | Project name |  |

### Return type

[**models::InstancesPut202Response**](instances_put_202_response.md)

### Authorization

No authorization required

### 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)


## image_get

> models::ImageGet200Response image_get(fingerprint, project)
Get the image

Gets a specific image.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fingerprint** | **String** | Fingerprint | [required] |
**project** | Option<**String**> | Project name |  |

### Return type

[**models::ImageGet200Response**](image_get_200_response.md)

### Authorization

No authorization required

### 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)


## image_patch

> models::InstancePatch200Response image_patch(fingerprint, image, project)
Partially update the image

Updates a subset of the image definition.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fingerprint** | **String** | Fingerprint | [required] |
**image** | [**ImagePut**](ImagePut.md) | Image configuration | [required] |
**project** | Option<**String**> | Project name |  |

### Return type

[**models::InstancePatch200Response**](instance_patch_200_response.md)

### Authorization

No authorization required

### 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)


## image_put

> models::InstancePatch200Response image_put(fingerprint, image, project)
Update the image

Updates the entire image definition.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fingerprint** | **String** | Fingerprint | [required] |
**image** | [**ImagePut**](ImagePut.md) | Image configuration | [required] |
**project** | Option<**String**> | Project name |  |

### Return type

[**models::InstancePatch200Response**](instance_patch_200_response.md)

### Authorization

No authorization required

### 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)


## images_get

> models::ImagesGet200Response images_get(project, filter, all_projects)
Get the images

Returns a list of images (URLs).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project** | Option<**String**> | Project name |  |
**filter** | Option<**String**> | Collection filter |  |
**all_projects** | Option<**bool**> | Retrieve images from all projects |  |

### Return type

[**models::ImagesGet200Response**](images_get_200_response.md)

### Authorization

No authorization required

### 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)