edgegap 0.1.0

Auto-generated client library for the Edgegap API, used by the arbctl tool
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

# \EndpointStorageApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**endpoint_create**](EndpointStorageApi.md#endpoint_create) | **POST** /v1/storage/endpoint | Create a New Endpoint Storage
[**endpoint_delete**](EndpointStorageApi.md#endpoint_delete) | **DELETE** /v1/storage/endpoint/{endpoint_name} | Delete an Endpoint Storage
[**endpoint_get**](EndpointStorageApi.md#endpoint_get) | **GET** /v1/storage/endpoint/{endpoint_name} | Get an Endpoint Storage
[**endpoint_update**](EndpointStorageApi.md#endpoint_update) | **PATCH** /v1/storage/endpoint/{endpoint_name} | Update an Endpoint Storage
[**endpoints_list**](EndpointStorageApi.md#endpoints_list) | **GET** /v1/storage/endpoints | List All Endpoint Storage
[**pull_profile_create**](EndpointStorageApi.md#pull_profile_create) | **POST** /v1/storage/endpoint/{endpoint_name}/pull-profile | Create a New Pull Profile
[**pull_profile_delete**](EndpointStorageApi.md#pull_profile_delete) | **DELETE** /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name} | Delete a Pull Profile
[**pull_profile_get**](EndpointStorageApi.md#pull_profile_get) | **GET** /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name} | Get a Pull Profile
[**pull_profile_link_app_version**](EndpointStorageApi.md#pull_profile_link_app_version) | **PUT** /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}/app/{app_name}/version/{version_name} | Link a Pull Profile to an Application Version
[**pull_profile_list**](EndpointStorageApi.md#pull_profile_list) | **GET** /v1/storage/endpoint/{endpoint_name}/pull-profiles | List All Pull Profile of an Endpoint Storage
[**pull_profile_unlink_app_version**](EndpointStorageApi.md#pull_profile_unlink_app_version) | **DELETE** /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name}/app/{app_name}/version/{version_name} | Unlink a Pull Profile From an Application Version
[**pull_profile_update**](EndpointStorageApi.md#pull_profile_update) | **PATCH** /v1/storage/endpoint/{endpoint_name}/pull-profile/{pull_profile_name} | Update a Pull Profile



## endpoint_create

> models::EndpointStoragePostResponse endpoint_create(payload)
Create a New Endpoint Storage

Create an endpoint storage to store your container logs at the end of a deployment.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**payload** | [**EndpointStoragePostPayload**](EndpointStoragePostPayload.md) |  | [required] |

### Return type

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

### Authorization

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

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


## endpoint_delete

> models::EndpointStorageDeleteResponse endpoint_delete(endpoint_name)
Delete an Endpoint Storage

Delete an endpoint storage. All the application versions linked to it won't be able to store logs anymore.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**endpoint_name** | **String** |  | [required] |

### Return type

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

### Authorization

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

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


## endpoint_get

> models::EndpointStorageGetResponse endpoint_get(endpoint_name)
Get an Endpoint Storage

Retrieve an endpoint storage. The ```secret_access_key``` won't be displayed.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**endpoint_name** | **String** |  | [required] |

### Return type

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

### Authorization

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

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


## endpoint_update

> models::EndpointStoragePatchResponse endpoint_update(endpoint_name, payload)
Update an Endpoint Storage

Update an Endpoint Storage with new specifications.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**endpoint_name** | **String** |  | [required] |
**payload** | [**EndpointStoragePatchPayload**](EndpointStoragePatchPayload.md) |  | [required] |

### Return type

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

### Authorization

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

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


## endpoints_list

> models::EndpointStorageListResponse endpoints_list(page, limit, x_fields)
List All Endpoint Storage

List all endpoint storage.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page** | Option<**i32**> | Page number for pagination |  |[default to 1]
**limit** | Option<**i32**> | Limit of Fleet for each page |  |[default to 10]
**x_fields** | Option<**String**> | An optional fields mask |  |

### Return type

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

### Authorization

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

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


## pull_profile_create

> models::PullProfilePostResponse pull_profile_create(endpoint_name, payload)
Create a New Pull Profile

Create a pull profile. Pull profile will upload data from an endpoint storage to a deployment container on boot. You must link the application version to the pull profile first.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**endpoint_name** | **String** |  | [required] |
**payload** | [**PullProfilePostPayload**](PullProfilePostPayload.md) |  | [required] |

### Return type

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

### Authorization

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

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


## pull_profile_delete

> pull_profile_delete(endpoint_name, pull_profile_name)
Delete a Pull Profile

Delete a pull profile. All the application versions linked won't receive the data upload anymore. It will not delete your endpoint storage.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**endpoint_name** | **String** |  | [required] |
**pull_profile_name** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

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

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


## pull_profile_get

> models::PullProfileGetResponse pull_profile_get(endpoint_name, pull_profile_name)
Get a Pull Profile

Retrieve a pull profile and its specifications.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**endpoint_name** | **String** |  | [required] |
**pull_profile_name** | **String** |  | [required] |

### Return type

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

### Authorization

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

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


## pull_profile_link_app_version

> models::PullProfileAppVersionLinkResponse pull_profile_link_app_version(endpoint_name, pull_profile_name, app_name, version_name)
Link a Pull Profile to an Application Version

Link a pull profile to an app version. Without a link, the pull profile by itself will do nothing.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**endpoint_name** | **String** |  | [required] |
**pull_profile_name** | **String** |  | [required] |
**app_name** | **String** |  | [required] |
**version_name** | **String** |  | [required] |

### Return type

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

### Authorization

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

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


## pull_profile_list

> models::PullProfilesListResponse pull_profile_list(endpoint_name, page, limit)
List All Pull Profile of an Endpoint Storage

List all pull profiles of an endpoint storage.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**endpoint_name** | **String** |  | [required] |
**page** | Option<**i32**> | Page number for pagination |  |[default to 1]
**limit** | Option<**i32**> | Limit of pull profiles for each page |  |[default to 10]

### Return type

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

### Authorization

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

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


## pull_profile_unlink_app_version

> pull_profile_unlink_app_version(endpoint_name, pull_profile_name, app_name, version_name)
Unlink a Pull Profile From an Application Version

Unlink a pull profile from an app version. It will not delete the pull profile.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**endpoint_name** | **String** |  | [required] |
**pull_profile_name** | **String** |  | [required] |
**app_name** | **String** |  | [required] |
**version_name** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

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

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


## pull_profile_update

> models::PulloProfilePatchResponse pull_profile_update(endpoint_name, pull_profile_name, payload)
Update a Pull Profile

Update a pull profile with new specifications.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**endpoint_name** | **String** |  | [required] |
**pull_profile_name** | **String** |  | [required] |
**payload** | [**PullProfilePatchPayload**](PullProfilePatchPayload.md) |  | [required] |

### Return type

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

### Authorization

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

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