artifact-keeper-client 1.1.6

Rust client for the Artifact Keeper 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
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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445

# \SbomApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**check_license_compliance**](SbomApi.md#check_license_compliance) | **POST** /api/v1/sbom/check-compliance | Check license compliance against policies
[**convert_sbom**](SbomApi.md#convert_sbom) | **POST** /api/v1/sbom/{id}/convert | Convert an SBOM to a different format
[**delete_license_policy**](SbomApi.md#delete_license_policy) | **DELETE** /api/v1/sbom/license-policies/{id} | Delete a license policy
[**delete_sbom**](SbomApi.md#delete_sbom) | **DELETE** /api/v1/sbom/{id} | Delete an SBOM
[**generate_sbom**](SbomApi.md#generate_sbom) | **POST** /api/v1/sbom | Generate an SBOM for an artifact
[**get_cve_history**](SbomApi.md#get_cve_history) | **GET** /api/v1/sbom/cve/history/{artifact_id} | Get CVE history for an artifact
[**get_cve_trends**](SbomApi.md#get_cve_trends) | **GET** /api/v1/sbom/cve/trends | Get CVE trends and statistics
[**get_license_policy**](SbomApi.md#get_license_policy) | **GET** /api/v1/sbom/license-policies/{id} | Get a license policy by ID
[**get_sbom**](SbomApi.md#get_sbom) | **GET** /api/v1/sbom/{id} | Get SBOM by ID with full content
[**get_sbom_by_artifact**](SbomApi.md#get_sbom_by_artifact) | **GET** /api/v1/sbom/by-artifact/{artifact_id} | Get SBOM by artifact ID
[**get_sbom_components**](SbomApi.md#get_sbom_components) | **GET** /api/v1/sbom/{id}/components | Get components of an SBOM
[**list_license_policies**](SbomApi.md#list_license_policies) | **GET** /api/v1/sbom/license-policies | List all license policies
[**list_sboms**](SbomApi.md#list_sboms) | **GET** /api/v1/sbom | List SBOMs with optional filters
[**update_cve_status**](SbomApi.md#update_cve_status) | **POST** /api/v1/sbom/cve/status/{id} | Update CVE status
[**upsert_license_policy**](SbomApi.md#upsert_license_policy) | **POST** /api/v1/sbom/license-policies | Create or update a license policy



## check_license_compliance

> models::LicenseCheckResult check_license_compliance(check_license_compliance_request)
Check license compliance against policies

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**check_license_compliance_request** | [**CheckLicenseComplianceRequest**](CheckLicenseComplianceRequest.md) |  | [required] |

### Return type

[**models::LicenseCheckResult**](LicenseCheckResult.md)

### Authorization

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

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


## convert_sbom

> models::SbomResponse convert_sbom(id, convert_sbom_request)
Convert an SBOM to a different format

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | SBOM ID | [required] |
**convert_sbom_request** | [**ConvertSbomRequest**](ConvertSbomRequest.md) |  | [required] |

### Return type

[**models::SbomResponse**](SbomResponse.md)

### Authorization

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

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

> serde_json::Value delete_license_policy(id)
Delete a license policy

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | License policy ID | [required] |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

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

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


## delete_sbom

> serde_json::Value delete_sbom(id)
Delete an SBOM

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | SBOM ID | [required] |

### Return type

[**serde_json::Value**](serde_json::Value.md)

### Authorization

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

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


## generate_sbom

> models::SbomResponse generate_sbom(generate_sbom_request)
Generate an SBOM for an artifact

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**generate_sbom_request** | [**GenerateSbomRequest**](GenerateSbomRequest.md) |  | [required] |

### Return type

[**models::SbomResponse**](SbomResponse.md)

### Authorization

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

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


## get_cve_history

> Vec<models::CveHistoryEntry> get_cve_history(artifact_id)
Get CVE history for an artifact

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**artifact_id** | **uuid::Uuid** | Artifact ID | [required] |

### Return type

[**Vec<models::CveHistoryEntry>**](CveHistoryEntry.md)

### Authorization

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

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

> models::CveTrends get_cve_trends(repository_id, days)
Get CVE trends and statistics

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**repository_id** | Option<**uuid::Uuid**> |  |  |
**days** | Option<**i32**> |  |  |

### Return type

[**models::CveTrends**](CveTrends.md)

### Authorization

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

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

> models::LicensePolicyResponse get_license_policy(id)
Get a license policy by ID

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | License policy ID | [required] |

### Return type

[**models::LicensePolicyResponse**](LicensePolicyResponse.md)

### Authorization

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

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

> models::SbomContentResponse get_sbom(id)
Get SBOM by ID with full content

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | SBOM ID | [required] |

### Return type

[**models::SbomContentResponse**](SbomContentResponse.md)

### Authorization

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

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

> models::SbomContentResponse get_sbom_by_artifact(artifact_id)
Get SBOM by artifact ID

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**artifact_id** | **uuid::Uuid** | Artifact ID | [required] |

### Return type

[**models::SbomContentResponse**](SbomContentResponse.md)

### Authorization

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

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

> Vec<models::ComponentResponse> get_sbom_components(id)
Get components of an SBOM

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | SBOM ID | [required] |

### Return type

[**Vec<models::ComponentResponse>**](ComponentResponse.md)

### Authorization

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

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

> Vec<models::LicensePolicyResponse> list_license_policies()
List all license policies

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::LicensePolicyResponse>**](LicensePolicyResponse.md)

### Authorization

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

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

> Vec<models::SbomResponse> list_sboms(artifact_id, repository_id, format)
List SBOMs with optional filters

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**artifact_id** | Option<**uuid::Uuid**> |  |  |
**repository_id** | Option<**uuid::Uuid**> |  |  |
**format** | Option<**String**> |  |  |

### Return type

[**Vec<models::SbomResponse>**](SbomResponse.md)

### Authorization

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

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

> models::CveHistoryEntry update_cve_status(id, update_cve_status_request)
Update CVE status

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | CVE history entry ID | [required] |
**update_cve_status_request** | [**UpdateCveStatusRequest**](UpdateCveStatusRequest.md) |  | [required] |

### Return type

[**models::CveHistoryEntry**](CveHistoryEntry.md)

### Authorization

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

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


## upsert_license_policy

> models::LicensePolicyResponse upsert_license_policy(upsert_license_policy_request)
Create or update a license policy

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**upsert_license_policy_request** | [**UpsertLicensePolicyRequest**](UpsertLicensePolicyRequest.md) |  | [required] |

### Return type

[**models::LicensePolicyResponse**](LicensePolicyResponse.md)

### Authorization

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

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