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
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
446
447
448
449
450
451
452

# \ApplicationsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**app_version_delete**](ApplicationsApi.md#app_version_delete) | **DELETE** /v1/app/{app_name}/version/{version_name} | Delete an Application Version
[**app_version_get**](ApplicationsApi.md#app_version_get) | **GET** /v1/app/{app_name}/version/{version_name} | Get an Application Version
[**app_version_post**](ApplicationsApi.md#app_version_post) | **POST** /v1/app/{app_name}/version | Create a New Application Version
[**app_version_whitelist_entry_delete**](ApplicationsApi.md#app_version_whitelist_entry_delete) | **DELETE** /v1/app/{app_name}/version/{version_name}/whitelist/{entry_id} | Delete an ACL Entry
[**app_version_whitelist_entry_get**](ApplicationsApi.md#app_version_whitelist_entry_get) | **GET** /v1/app/{app_name}/version/{version_name}/whitelist/{entry_id} | Get an ACL Entry
[**app_version_whitelist_get**](ApplicationsApi.md#app_version_whitelist_get) | **GET** /v1/app/{app_name}/version/{version_name}/whitelist | List All ACL Entries for an Application Version
[**app_version_whitelist_post**](ApplicationsApi.md#app_version_whitelist_post) | **POST** /v1/app/{app_name}/version/{version_name}/whitelist | Create an ACL Entry
[**app_versions_get**](ApplicationsApi.md#app_versions_get) | **GET** /v1/app/{app_name}/versions | List All Versions for an Application
[**app_versions_patch**](ApplicationsApi.md#app_versions_patch) | **PATCH** /v1/app/{app_name}/version/{version_name} | Update an Application Version
[**application_delete**](ApplicationsApi.md#application_delete) | **DELETE** /v1/app/{app_name} | Delete an Application
[**application_get**](ApplicationsApi.md#application_get) | **GET** /v1/app/{app_name} | Get an Application
[**application_patch**](ApplicationsApi.md#application_patch) | **PATCH** /v1/app/{app_name} | Update an Application
[**application_post**](ApplicationsApi.md#application_post) | **POST** /v1/app | Create a New Application
[**applications_get**](ApplicationsApi.md#applications_get) | **GET** /v1/apps | List All Applications



## app_version_delete

> models::AppVersionDelete app_version_delete(app_name, version_name)
Delete an Application Version

Delete a specific version of an application.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_name** | **String** | The name of the application | [required] |
**version_name** | **String** | The name of the application version | [required] |

### Return type

[**models::AppVersionDelete**](AppVersionDelete.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)


## app_version_get

> models::AppVersionPayload app_version_get(app_name, version_name)
Get an Application Version

Retrieve the specifications of an application version.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_name** | **String** | The name of the application | [required] |
**version_name** | **String** | The name of the application version | [required] |

### Return type

[**models::AppVersionPayload**](AppVersionPayload.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)


## app_version_post

> models::AppVersionCreateResponse app_version_post(app_name, payload)
Create a New Application Version

Create an application version associated with an application. The version contains all the specifications to create a deployment.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_name** | **String** | The name of the application associated | [required] |
**payload** | [**AppVersionPayload**](AppVersionPayload.md) |  | [required] |

### Return type

[**models::AppVersionCreateResponse**](AppVersionCreateResponse.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)


## app_version_whitelist_entry_delete

> models::AppVersionWhitelistEntrySuccess app_version_whitelist_entry_delete(app_name, version_name, entry_id)
Delete an ACL Entry

Delete an access control list entry for a specific application version

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_name** | **String** | The name of the application | [required] |
**version_name** | **String** | The name of the application version | [required] |
**entry_id** | **String** | The unique ID of the entry | [required] |

### Return type

[**models::AppVersionWhitelistEntrySuccess**](AppVersionWhitelistEntrySuccess.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)


## app_version_whitelist_entry_get

> models::AppVersionWhitelistEntry app_version_whitelist_entry_get(app_name, version_name, entry_id)
Get an ACL Entry

Retrieve a specific access control list entry for an application version.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_name** | **String** | The name of the application | [required] |
**version_name** | **String** | The name of the application version | [required] |
**entry_id** | **String** | The unique ID of the entry | [required] |

### Return type

[**models::AppVersionWhitelistEntry**](AppVersionWhitelistEntry.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)


## app_version_whitelist_get

> models::AppVersionWhitelistResponse app_version_whitelist_get(app_name, version_name)
List All ACL Entries for an Application Version

List all the access control list entries for a specific application version.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_name** | **String** | The name of the application | [required] |
**version_name** | **String** | The name of the application version | [required] |

### Return type

[**models::AppVersionWhitelistResponse**](AppVersionWhitelistResponse.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)


## app_version_whitelist_post

> models::AppVersionWhitelistEntrySuccess app_version_whitelist_post(app_name, version_name, payload)
Create an ACL Entry

Create an access control list entry for an app version. This will allow the specified CIDR to connect to the deployment. The option ```whitelisting_active``` must be activated in the application version.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_name** | **String** | The name of the application | [required] |
**version_name** | **String** | The name of the application version | [required] |
**payload** | [**AppVersionWhitelistEntryPayload**](AppVersionWhitelistEntryPayload.md) |  | [required] |

### Return type

[**models::AppVersionWhitelistEntrySuccess**](AppVersionWhitelistEntrySuccess.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)


## app_versions_get

> models::AppVersionList app_versions_get(app_name)
List All Versions for an Application

List all versions of a specific application.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_name** | **String** | The name of the application | [required] |

### Return type

[**models::AppVersionList**](AppVersionList.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)


## app_versions_patch

> models::AppVersionUpdateResponse app_versions_patch(app_name, version_name, payload)
Update an Application Version

Update an application version with new specifications.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_name** | **String** | The name of the application | [required] |
**version_name** | **String** | The name of the application version | [required] |
**payload** | [**AppVersionUpdatePayload**](AppVersionUpdatePayload.md) |  | [required] |

### Return type

[**models::AppVersionUpdateResponse**](AppVersionUpdateResponse.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)


## application_delete

> application_delete(app_name)
Delete an Application

Delete an application and all its current versions.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**app_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)


## application_get

> models::Application application_get(app_name)
Get an Application

Retrieve an application and its information.

### Parameters


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

### Return type

[**models::Application**](Application.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)


## application_patch

> models::Application application_patch(app_name, payload)
Update an Application

Update an application with new information.

### Parameters


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

### Return type

[**models::Application**](Application.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)


## application_post

> models::Application application_post(payload)
Create a New Application

Create an application that will regroup application versions.

### Parameters


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

### Return type

[**models::Application**](Application.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)


## applications_get

> models::Applications applications_get()
List All Applications

List all the applications that you own.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::Applications**](Applications.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)