@pidginhost/sdk 0.6.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +39 -0
- package/CHANGELOG.md +7 -0
- package/README.md +115 -2
- package/api.ts +9095 -3388
- package/dist/api.d.ts +2569 -62
- package/dist/api.js +8153 -3040
- package/dist/esm/api.d.ts +2569 -62
- package/dist/esm/api.js +8135 -3026
- package/docs/ApiCredential.md +32 -0
- package/docs/Bucket.md +40 -0
- package/docs/CloudApi.md +1315 -134
- package/docs/DnsSourceEnum.md +13 -0
- package/docs/DomainAdd.md +28 -0
- package/docs/EmailApi.md +2828 -0
- package/docs/EmailService.md +44 -0
- package/docs/FloatingIPAuthorization.md +27 -0
- package/docs/FloatingIPAuthorizeRequest.md +20 -0
- package/docs/FloatingIPv4.md +32 -0
- package/docs/FloatingIPv4AuthorizeResponse.md +20 -0
- package/docs/FloatingIPv4Create.md +20 -0
- package/docs/FloatingIPv4UnauthorizeResponse.md +20 -0
- package/docs/FloatingIPv6.md +32 -0
- package/docs/FloatingIPv6AuthorizeResponse.md +20 -0
- package/docs/FloatingIPv6Create.md +20 -0
- package/docs/FloatingIPv6UnauthorizeResponse.md +20 -0
- package/docs/InboundRoute.md +34 -0
- package/docs/ModeEnum.md +11 -0
- package/docs/PaginatedApiCredentialList.md +26 -0
- package/docs/PaginatedEmailServiceList.md +26 -0
- package/docs/PaginatedFloatingIPAuthorizationList.md +26 -0
- package/docs/PaginatedFloatingIPv4List.md +26 -0
- package/docs/PaginatedFloatingIPv6List.md +26 -0
- package/docs/PaginatedInboundRouteList.md +26 -0
- package/docs/PaginatedSandboxAddressList.md +26 -0
- package/docs/PaginatedSendingDomainList.md +26 -0
- package/docs/PaginatedSmtpCredentialList.md +26 -0
- package/docs/PaginatedSuppressionEntryList.md +26 -0
- package/docs/PatchedEmailService.md +44 -0
- package/docs/PatchedInboundRoute.md +34 -0
- package/docs/PatchedSubscribe.md +20 -0
- package/docs/ReasonEnum.md +15 -0
- package/docs/SandboxAddress.md +26 -0
- package/docs/SendingDomain.md +42 -0
- package/docs/SendingDomainStatusEnum.md +17 -0
- package/docs/ServerProduct.md +8 -0
- package/docs/SmtpCredential.md +30 -0
- package/docs/Subscribe.md +20 -0
- package/docs/SuppressionEntry.md +28 -0
- package/docs/TierEnum.md +13 -0
- package/package.json +1 -1
package/docs/CloudApi.md
CHANGED
|
@@ -4,6 +4,14 @@ All URIs are relative to *https://www.pidginhost.com*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**cloudBucketsCreate**](#cloudbucketscreate) | **POST** /api/cloud/buckets/ | |
|
|
8
|
+
|[**cloudBucketsCredentialsRevealCreate**](#cloudbucketscredentialsrevealcreate) | **POST** /api/cloud/buckets/{id}/credentials/reveal/ | |
|
|
9
|
+
|[**cloudBucketsCredentialsRotateCreate**](#cloudbucketscredentialsrotatecreate) | **POST** /api/cloud/buckets/{id}/credentials/rotate/ | |
|
|
10
|
+
|[**cloudBucketsDestroy**](#cloudbucketsdestroy) | **DELETE** /api/cloud/buckets/{id}/ | |
|
|
11
|
+
|[**cloudBucketsList**](#cloudbucketslist) | **GET** /api/cloud/buckets/ | |
|
|
12
|
+
|[**cloudBucketsResizeCreate**](#cloudbucketsresizecreate) | **POST** /api/cloud/buckets/{id}/resize/ | |
|
|
13
|
+
|[**cloudBucketsRetrieve**](#cloudbucketsretrieve) | **GET** /api/cloud/buckets/{id}/ | |
|
|
14
|
+
|[**cloudBucketsVisibilityCreate**](#cloudbucketsvisibilitycreate) | **POST** /api/cloud/buckets/{id}/visibility/ | |
|
|
7
15
|
|[**cloudFirewallRulesSetCreate**](#cloudfirewallrulessetcreate) | **POST** /api/cloud/firewall-rules-set/ | |
|
|
8
16
|
|[**cloudFirewallRulesSetDestroy**](#cloudfirewallrulessetdestroy) | **DELETE** /api/cloud/firewall-rules-set/{id}/ | |
|
|
9
17
|
|[**cloudFirewallRulesSetList**](#cloudfirewallrulessetlist) | **GET** /api/cloud/firewall-rules-set/ | |
|
|
@@ -16,6 +24,20 @@ All URIs are relative to *https://www.pidginhost.com*
|
|
|
16
24
|
|[**cloudFirewallRulesSetRulesRetrieve**](#cloudfirewallrulessetrulesretrieve) | **GET** /api/cloud/firewall-rules-set/{rules_set_id}/rules/{rule_id}/ | |
|
|
17
25
|
|[**cloudFirewallRulesSetRulesUpdate**](#cloudfirewallrulessetrulesupdate) | **PUT** /api/cloud/firewall-rules-set/{rules_set_id}/rules/{rule_id}/ | |
|
|
18
26
|
|[**cloudFirewallRulesSetUpdate**](#cloudfirewallrulessetupdate) | **PUT** /api/cloud/firewall-rules-set/{id}/ | |
|
|
27
|
+
|[**cloudFloatingIpv4AuthorizationsList**](#cloudfloatingipv4authorizationslist) | **GET** /api/cloud/floating-ipv4/{id}/authorizations/ | |
|
|
28
|
+
|[**cloudFloatingIpv4AuthorizeCreate**](#cloudfloatingipv4authorizecreate) | **POST** /api/cloud/floating-ipv4/{id}/authorize/ | |
|
|
29
|
+
|[**cloudFloatingIpv4Create**](#cloudfloatingipv4create) | **POST** /api/cloud/floating-ipv4/ | |
|
|
30
|
+
|[**cloudFloatingIpv4Destroy**](#cloudfloatingipv4destroy) | **DELETE** /api/cloud/floating-ipv4/{id}/ | |
|
|
31
|
+
|[**cloudFloatingIpv4List**](#cloudfloatingipv4list) | **GET** /api/cloud/floating-ipv4/ | |
|
|
32
|
+
|[**cloudFloatingIpv4Retrieve**](#cloudfloatingipv4retrieve) | **GET** /api/cloud/floating-ipv4/{id}/ | |
|
|
33
|
+
|[**cloudFloatingIpv4UnauthorizeCreate**](#cloudfloatingipv4unauthorizecreate) | **POST** /api/cloud/floating-ipv4/{id}/unauthorize/ | |
|
|
34
|
+
|[**cloudFloatingIpv6AuthorizationsList**](#cloudfloatingipv6authorizationslist) | **GET** /api/cloud/floating-ipv6/{id}/authorizations/ | |
|
|
35
|
+
|[**cloudFloatingIpv6AuthorizeCreate**](#cloudfloatingipv6authorizecreate) | **POST** /api/cloud/floating-ipv6/{id}/authorize/ | |
|
|
36
|
+
|[**cloudFloatingIpv6Create**](#cloudfloatingipv6create) | **POST** /api/cloud/floating-ipv6/ | |
|
|
37
|
+
|[**cloudFloatingIpv6Destroy**](#cloudfloatingipv6destroy) | **DELETE** /api/cloud/floating-ipv6/{id}/ | |
|
|
38
|
+
|[**cloudFloatingIpv6List**](#cloudfloatingipv6list) | **GET** /api/cloud/floating-ipv6/ | |
|
|
39
|
+
|[**cloudFloatingIpv6Retrieve**](#cloudfloatingipv6retrieve) | **GET** /api/cloud/floating-ipv6/{id}/ | |
|
|
40
|
+
|[**cloudFloatingIpv6UnauthorizeCreate**](#cloudfloatingipv6unauthorizecreate) | **POST** /api/cloud/floating-ipv6/{id}/unauthorize/ | |
|
|
19
41
|
|[**cloudGenerationsList**](#cloudgenerationslist) | **GET** /api/cloud/generations/ | List hardware generations|
|
|
20
42
|
|[**cloudGenerationsRetrieve**](#cloudgenerationsretrieve) | **GET** /api/cloud/generations/{slug}/ | |
|
|
21
43
|
|[**cloudImagesList**](#cloudimageslist) | **GET** /api/cloud/images/ | |
|
|
@@ -86,8 +108,8 @@ All URIs are relative to *https://www.pidginhost.com*
|
|
|
86
108
|
|[**cloudVolumesRetrieve**](#cloudvolumesretrieve) | **GET** /api/cloud/volumes/{id}/ | |
|
|
87
109
|
|[**cloudVolumesUpdate**](#cloudvolumesupdate) | **PUT** /api/cloud/volumes/{id}/ | |
|
|
88
110
|
|
|
89
|
-
# **
|
|
90
|
-
>
|
|
111
|
+
# **cloudBucketsCreate**
|
|
112
|
+
> Bucket cloudBucketsCreate()
|
|
91
113
|
|
|
92
114
|
Require complete user profile for provisioning (create) API actions.
|
|
93
115
|
|
|
@@ -97,16 +119,16 @@ Require complete user profile for provisioning (create) API actions.
|
|
|
97
119
|
import {
|
|
98
120
|
CloudApi,
|
|
99
121
|
Configuration,
|
|
100
|
-
|
|
122
|
+
Bucket
|
|
101
123
|
} from '@pidginhost/sdk';
|
|
102
124
|
|
|
103
125
|
const configuration = new Configuration();
|
|
104
126
|
const apiInstance = new CloudApi(configuration);
|
|
105
127
|
|
|
106
|
-
let
|
|
128
|
+
let bucket: Bucket; // (optional)
|
|
107
129
|
|
|
108
|
-
const { status, data } = await apiInstance.
|
|
109
|
-
|
|
130
|
+
const { status, data } = await apiInstance.cloudBucketsCreate(
|
|
131
|
+
bucket
|
|
110
132
|
);
|
|
111
133
|
```
|
|
112
134
|
|
|
@@ -114,12 +136,12 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetCreate(
|
|
|
114
136
|
|
|
115
137
|
|Name | Type | Description | Notes|
|
|
116
138
|
|------------- | ------------- | ------------- | -------------|
|
|
117
|
-
| **
|
|
139
|
+
| **bucket** | **Bucket**| | |
|
|
118
140
|
|
|
119
141
|
|
|
120
142
|
### Return type
|
|
121
143
|
|
|
122
|
-
**
|
|
144
|
+
**Bucket**
|
|
123
145
|
|
|
124
146
|
### Authorization
|
|
125
147
|
|
|
@@ -138,8 +160,8 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetCreate(
|
|
|
138
160
|
|
|
139
161
|
[[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)
|
|
140
162
|
|
|
141
|
-
# **
|
|
142
|
-
>
|
|
163
|
+
# **cloudBucketsCredentialsRevealCreate**
|
|
164
|
+
> Bucket cloudBucketsCredentialsRevealCreate()
|
|
143
165
|
|
|
144
166
|
Require complete user profile for provisioning (create) API actions.
|
|
145
167
|
|
|
@@ -148,16 +170,19 @@ Require complete user profile for provisioning (create) API actions.
|
|
|
148
170
|
```typescript
|
|
149
171
|
import {
|
|
150
172
|
CloudApi,
|
|
151
|
-
Configuration
|
|
173
|
+
Configuration,
|
|
174
|
+
Bucket
|
|
152
175
|
} from '@pidginhost/sdk';
|
|
153
176
|
|
|
154
177
|
const configuration = new Configuration();
|
|
155
178
|
const apiInstance = new CloudApi(configuration);
|
|
156
179
|
|
|
157
|
-
let id: number; //A unique integer value identifying this
|
|
180
|
+
let id: number; //A unique integer value identifying this S3 bucket. (default to undefined)
|
|
181
|
+
let bucket: Bucket; // (optional)
|
|
158
182
|
|
|
159
|
-
const { status, data } = await apiInstance.
|
|
160
|
-
id
|
|
183
|
+
const { status, data } = await apiInstance.cloudBucketsCredentialsRevealCreate(
|
|
184
|
+
id,
|
|
185
|
+
bucket
|
|
161
186
|
);
|
|
162
187
|
```
|
|
163
188
|
|
|
@@ -165,12 +190,13 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetDestroy(
|
|
|
165
190
|
|
|
166
191
|
|Name | Type | Description | Notes|
|
|
167
192
|
|------------- | ------------- | ------------- | -------------|
|
|
168
|
-
| **
|
|
193
|
+
| **bucket** | **Bucket**| | |
|
|
194
|
+
| **id** | [**number**] | A unique integer value identifying this S3 bucket. | defaults to undefined|
|
|
169
195
|
|
|
170
196
|
|
|
171
197
|
### Return type
|
|
172
198
|
|
|
173
|
-
|
|
199
|
+
**Bucket**
|
|
174
200
|
|
|
175
201
|
### Authorization
|
|
176
202
|
|
|
@@ -178,19 +204,19 @@ void (empty response body)
|
|
|
178
204
|
|
|
179
205
|
### HTTP request headers
|
|
180
206
|
|
|
181
|
-
- **Content-Type**:
|
|
182
|
-
- **Accept**:
|
|
207
|
+
- **Content-Type**: application/json
|
|
208
|
+
- **Accept**: application/json
|
|
183
209
|
|
|
184
210
|
|
|
185
211
|
### HTTP response details
|
|
186
212
|
| Status code | Description | Response headers |
|
|
187
213
|
|-------------|-------------|------------------|
|
|
188
|
-
|**
|
|
214
|
+
|**200** | | - |
|
|
189
215
|
|
|
190
216
|
[[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)
|
|
191
217
|
|
|
192
|
-
# **
|
|
193
|
-
>
|
|
218
|
+
# **cloudBucketsCredentialsRotateCreate**
|
|
219
|
+
> Bucket cloudBucketsCredentialsRotateCreate()
|
|
194
220
|
|
|
195
221
|
Require complete user profile for provisioning (create) API actions.
|
|
196
222
|
|
|
@@ -199,22 +225,33 @@ Require complete user profile for provisioning (create) API actions.
|
|
|
199
225
|
```typescript
|
|
200
226
|
import {
|
|
201
227
|
CloudApi,
|
|
202
|
-
Configuration
|
|
228
|
+
Configuration,
|
|
229
|
+
Bucket
|
|
203
230
|
} from '@pidginhost/sdk';
|
|
204
231
|
|
|
205
232
|
const configuration = new Configuration();
|
|
206
233
|
const apiInstance = new CloudApi(configuration);
|
|
207
234
|
|
|
208
|
-
|
|
235
|
+
let id: number; //A unique integer value identifying this S3 bucket. (default to undefined)
|
|
236
|
+
let bucket: Bucket; // (optional)
|
|
237
|
+
|
|
238
|
+
const { status, data } = await apiInstance.cloudBucketsCredentialsRotateCreate(
|
|
239
|
+
id,
|
|
240
|
+
bucket
|
|
241
|
+
);
|
|
209
242
|
```
|
|
210
243
|
|
|
211
244
|
### Parameters
|
|
212
|
-
|
|
245
|
+
|
|
246
|
+
|Name | Type | Description | Notes|
|
|
247
|
+
|------------- | ------------- | ------------- | -------------|
|
|
248
|
+
| **bucket** | **Bucket**| | |
|
|
249
|
+
| **id** | [**number**] | A unique integer value identifying this S3 bucket. | defaults to undefined|
|
|
213
250
|
|
|
214
251
|
|
|
215
252
|
### Return type
|
|
216
253
|
|
|
217
|
-
**
|
|
254
|
+
**Bucket**
|
|
218
255
|
|
|
219
256
|
### Authorization
|
|
220
257
|
|
|
@@ -222,7 +259,7 @@ This endpoint does not have any parameters.
|
|
|
222
259
|
|
|
223
260
|
### HTTP request headers
|
|
224
261
|
|
|
225
|
-
- **Content-Type**:
|
|
262
|
+
- **Content-Type**: application/json
|
|
226
263
|
- **Accept**: application/json
|
|
227
264
|
|
|
228
265
|
|
|
@@ -233,8 +270,8 @@ This endpoint does not have any parameters.
|
|
|
233
270
|
|
|
234
271
|
[[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)
|
|
235
272
|
|
|
236
|
-
# **
|
|
237
|
-
>
|
|
273
|
+
# **cloudBucketsDestroy**
|
|
274
|
+
> cloudBucketsDestroy()
|
|
238
275
|
|
|
239
276
|
Require complete user profile for provisioning (create) API actions.
|
|
240
277
|
|
|
@@ -243,19 +280,16 @@ Require complete user profile for provisioning (create) API actions.
|
|
|
243
280
|
```typescript
|
|
244
281
|
import {
|
|
245
282
|
CloudApi,
|
|
246
|
-
Configuration
|
|
247
|
-
PatchedFirewallRulesSet
|
|
283
|
+
Configuration
|
|
248
284
|
} from '@pidginhost/sdk';
|
|
249
285
|
|
|
250
286
|
const configuration = new Configuration();
|
|
251
287
|
const apiInstance = new CloudApi(configuration);
|
|
252
288
|
|
|
253
|
-
let id: number; //A unique integer value identifying this
|
|
254
|
-
let patchedFirewallRulesSet: PatchedFirewallRulesSet; // (optional)
|
|
289
|
+
let id: number; //A unique integer value identifying this S3 bucket. (default to undefined)
|
|
255
290
|
|
|
256
|
-
const { status, data } = await apiInstance.
|
|
257
|
-
id
|
|
258
|
-
patchedFirewallRulesSet
|
|
291
|
+
const { status, data } = await apiInstance.cloudBucketsDestroy(
|
|
292
|
+
id
|
|
259
293
|
);
|
|
260
294
|
```
|
|
261
295
|
|
|
@@ -263,13 +297,12 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetPartialUpdate(
|
|
|
263
297
|
|
|
264
298
|
|Name | Type | Description | Notes|
|
|
265
299
|
|------------- | ------------- | ------------- | -------------|
|
|
266
|
-
| **
|
|
267
|
-
| **id** | [**number**] | A unique integer value identifying this firewall rules set. | defaults to undefined|
|
|
300
|
+
| **id** | [**number**] | A unique integer value identifying this S3 bucket. | defaults to undefined|
|
|
268
301
|
|
|
269
302
|
|
|
270
303
|
### Return type
|
|
271
304
|
|
|
272
|
-
|
|
305
|
+
void (empty response body)
|
|
273
306
|
|
|
274
307
|
### Authorization
|
|
275
308
|
|
|
@@ -277,19 +310,19 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetPartialUpdate(
|
|
|
277
310
|
|
|
278
311
|
### HTTP request headers
|
|
279
312
|
|
|
280
|
-
- **Content-Type**:
|
|
281
|
-
- **Accept**:
|
|
313
|
+
- **Content-Type**: Not defined
|
|
314
|
+
- **Accept**: Not defined
|
|
282
315
|
|
|
283
316
|
|
|
284
317
|
### HTTP response details
|
|
285
318
|
| Status code | Description | Response headers |
|
|
286
319
|
|-------------|-------------|------------------|
|
|
287
|
-
|**
|
|
320
|
+
|**204** | No response body | - |
|
|
288
321
|
|
|
289
322
|
[[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)
|
|
290
323
|
|
|
291
|
-
# **
|
|
292
|
-
>
|
|
324
|
+
# **cloudBucketsList**
|
|
325
|
+
> Array<Bucket> cloudBucketsList()
|
|
293
326
|
|
|
294
327
|
Require complete user profile for provisioning (create) API actions.
|
|
295
328
|
|
|
@@ -304,23 +337,16 @@ import {
|
|
|
304
337
|
const configuration = new Configuration();
|
|
305
338
|
const apiInstance = new CloudApi(configuration);
|
|
306
339
|
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
const { status, data } = await apiInstance.cloudFirewallRulesSetRetrieve(
|
|
310
|
-
id
|
|
311
|
-
);
|
|
340
|
+
const { status, data } = await apiInstance.cloudBucketsList();
|
|
312
341
|
```
|
|
313
342
|
|
|
314
343
|
### Parameters
|
|
315
|
-
|
|
316
|
-
|Name | Type | Description | Notes|
|
|
317
|
-
|------------- | ------------- | ------------- | -------------|
|
|
318
|
-
| **id** | [**number**] | A unique integer value identifying this firewall rules set. | defaults to undefined|
|
|
344
|
+
This endpoint does not have any parameters.
|
|
319
345
|
|
|
320
346
|
|
|
321
347
|
### Return type
|
|
322
348
|
|
|
323
|
-
**
|
|
349
|
+
**Array<Bucket>**
|
|
324
350
|
|
|
325
351
|
### Authorization
|
|
326
352
|
|
|
@@ -339,8 +365,8 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetRetrieve(
|
|
|
339
365
|
|
|
340
366
|
[[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)
|
|
341
367
|
|
|
342
|
-
# **
|
|
343
|
-
>
|
|
368
|
+
# **cloudBucketsResizeCreate**
|
|
369
|
+
> Bucket cloudBucketsResizeCreate()
|
|
344
370
|
|
|
345
371
|
Require complete user profile for provisioning (create) API actions.
|
|
346
372
|
|
|
@@ -350,18 +376,18 @@ Require complete user profile for provisioning (create) API actions.
|
|
|
350
376
|
import {
|
|
351
377
|
CloudApi,
|
|
352
378
|
Configuration,
|
|
353
|
-
|
|
379
|
+
Bucket
|
|
354
380
|
} from '@pidginhost/sdk';
|
|
355
381
|
|
|
356
382
|
const configuration = new Configuration();
|
|
357
383
|
const apiInstance = new CloudApi(configuration);
|
|
358
384
|
|
|
359
|
-
let
|
|
360
|
-
let
|
|
385
|
+
let id: number; //A unique integer value identifying this S3 bucket. (default to undefined)
|
|
386
|
+
let bucket: Bucket; // (optional)
|
|
361
387
|
|
|
362
|
-
const { status, data } = await apiInstance.
|
|
363
|
-
|
|
364
|
-
|
|
388
|
+
const { status, data } = await apiInstance.cloudBucketsResizeCreate(
|
|
389
|
+
id,
|
|
390
|
+
bucket
|
|
365
391
|
);
|
|
366
392
|
```
|
|
367
393
|
|
|
@@ -369,13 +395,13 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetRulesCreate(
|
|
|
369
395
|
|
|
370
396
|
|Name | Type | Description | Notes|
|
|
371
397
|
|------------- | ------------- | ------------- | -------------|
|
|
372
|
-
| **
|
|
373
|
-
| **
|
|
398
|
+
| **bucket** | **Bucket**| | |
|
|
399
|
+
| **id** | [**number**] | A unique integer value identifying this S3 bucket. | defaults to undefined|
|
|
374
400
|
|
|
375
401
|
|
|
376
402
|
### Return type
|
|
377
403
|
|
|
378
|
-
**
|
|
404
|
+
**Bucket**
|
|
379
405
|
|
|
380
406
|
### Authorization
|
|
381
407
|
|
|
@@ -390,12 +416,12 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetRulesCreate(
|
|
|
390
416
|
### HTTP response details
|
|
391
417
|
| Status code | Description | Response headers |
|
|
392
418
|
|-------------|-------------|------------------|
|
|
393
|
-
|**
|
|
419
|
+
|**200** | | - |
|
|
394
420
|
|
|
395
421
|
[[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)
|
|
396
422
|
|
|
397
|
-
# **
|
|
398
|
-
>
|
|
423
|
+
# **cloudBucketsRetrieve**
|
|
424
|
+
> Bucket cloudBucketsRetrieve()
|
|
399
425
|
|
|
400
426
|
Require complete user profile for provisioning (create) API actions.
|
|
401
427
|
|
|
@@ -410,12 +436,10 @@ import {
|
|
|
410
436
|
const configuration = new Configuration();
|
|
411
437
|
const apiInstance = new CloudApi(configuration);
|
|
412
438
|
|
|
413
|
-
let
|
|
414
|
-
let rulesSetId: string; // (default to undefined)
|
|
439
|
+
let id: number; //A unique integer value identifying this S3 bucket. (default to undefined)
|
|
415
440
|
|
|
416
|
-
const { status, data } = await apiInstance.
|
|
417
|
-
|
|
418
|
-
rulesSetId
|
|
441
|
+
const { status, data } = await apiInstance.cloudBucketsRetrieve(
|
|
442
|
+
id
|
|
419
443
|
);
|
|
420
444
|
```
|
|
421
445
|
|
|
@@ -423,13 +447,12 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetRulesDestroy(
|
|
|
423
447
|
|
|
424
448
|
|Name | Type | Description | Notes|
|
|
425
449
|
|------------- | ------------- | ------------- | -------------|
|
|
426
|
-
| **
|
|
427
|
-
| **rulesSetId** | [**string**] | | defaults to undefined|
|
|
450
|
+
| **id** | [**number**] | A unique integer value identifying this S3 bucket. | defaults to undefined|
|
|
428
451
|
|
|
429
452
|
|
|
430
453
|
### Return type
|
|
431
454
|
|
|
432
|
-
|
|
455
|
+
**Bucket**
|
|
433
456
|
|
|
434
457
|
### Authorization
|
|
435
458
|
|
|
@@ -438,18 +461,18 @@ void (empty response body)
|
|
|
438
461
|
### HTTP request headers
|
|
439
462
|
|
|
440
463
|
- **Content-Type**: Not defined
|
|
441
|
-
- **Accept**:
|
|
464
|
+
- **Accept**: application/json
|
|
442
465
|
|
|
443
466
|
|
|
444
467
|
### HTTP response details
|
|
445
468
|
| Status code | Description | Response headers |
|
|
446
469
|
|-------------|-------------|------------------|
|
|
447
|
-
|**
|
|
470
|
+
|**200** | | - |
|
|
448
471
|
|
|
449
472
|
[[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)
|
|
450
473
|
|
|
451
|
-
# **
|
|
452
|
-
>
|
|
474
|
+
# **cloudBucketsVisibilityCreate**
|
|
475
|
+
> Bucket cloudBucketsVisibilityCreate()
|
|
453
476
|
|
|
454
477
|
Require complete user profile for provisioning (create) API actions.
|
|
455
478
|
|
|
@@ -458,16 +481,19 @@ Require complete user profile for provisioning (create) API actions.
|
|
|
458
481
|
```typescript
|
|
459
482
|
import {
|
|
460
483
|
CloudApi,
|
|
461
|
-
Configuration
|
|
484
|
+
Configuration,
|
|
485
|
+
Bucket
|
|
462
486
|
} from '@pidginhost/sdk';
|
|
463
487
|
|
|
464
488
|
const configuration = new Configuration();
|
|
465
489
|
const apiInstance = new CloudApi(configuration);
|
|
466
490
|
|
|
467
|
-
let
|
|
491
|
+
let id: number; //A unique integer value identifying this S3 bucket. (default to undefined)
|
|
492
|
+
let bucket: Bucket; // (optional)
|
|
468
493
|
|
|
469
|
-
const { status, data } = await apiInstance.
|
|
470
|
-
|
|
494
|
+
const { status, data } = await apiInstance.cloudBucketsVisibilityCreate(
|
|
495
|
+
id,
|
|
496
|
+
bucket
|
|
471
497
|
);
|
|
472
498
|
```
|
|
473
499
|
|
|
@@ -475,12 +501,13 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetRulesList(
|
|
|
475
501
|
|
|
476
502
|
|Name | Type | Description | Notes|
|
|
477
503
|
|------------- | ------------- | ------------- | -------------|
|
|
478
|
-
| **
|
|
504
|
+
| **bucket** | **Bucket**| | |
|
|
505
|
+
| **id** | [**number**] | A unique integer value identifying this S3 bucket. | defaults to undefined|
|
|
479
506
|
|
|
480
507
|
|
|
481
508
|
### Return type
|
|
482
509
|
|
|
483
|
-
**
|
|
510
|
+
**Bucket**
|
|
484
511
|
|
|
485
512
|
### Authorization
|
|
486
513
|
|
|
@@ -488,7 +515,7 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetRulesList(
|
|
|
488
515
|
|
|
489
516
|
### HTTP request headers
|
|
490
517
|
|
|
491
|
-
- **Content-Type**:
|
|
518
|
+
- **Content-Type**: application/json
|
|
492
519
|
- **Accept**: application/json
|
|
493
520
|
|
|
494
521
|
|
|
@@ -499,8 +526,8 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetRulesList(
|
|
|
499
526
|
|
|
500
527
|
[[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)
|
|
501
528
|
|
|
502
|
-
# **
|
|
503
|
-
>
|
|
529
|
+
# **cloudFirewallRulesSetCreate**
|
|
530
|
+
> FirewallRulesSet cloudFirewallRulesSetCreate(firewallRulesSet)
|
|
504
531
|
|
|
505
532
|
Require complete user profile for provisioning (create) API actions.
|
|
506
533
|
|
|
@@ -510,20 +537,16 @@ Require complete user profile for provisioning (create) API actions.
|
|
|
510
537
|
import {
|
|
511
538
|
CloudApi,
|
|
512
539
|
Configuration,
|
|
513
|
-
|
|
540
|
+
FirewallRulesSet
|
|
514
541
|
} from '@pidginhost/sdk';
|
|
515
542
|
|
|
516
543
|
const configuration = new Configuration();
|
|
517
544
|
const apiInstance = new CloudApi(configuration);
|
|
518
545
|
|
|
519
|
-
let
|
|
520
|
-
let rulesSetId: string; // (default to undefined)
|
|
521
|
-
let patchedFirewallRule: PatchedFirewallRule; // (optional)
|
|
546
|
+
let firewallRulesSet: FirewallRulesSet; //
|
|
522
547
|
|
|
523
|
-
const { status, data } = await apiInstance.
|
|
524
|
-
|
|
525
|
-
rulesSetId,
|
|
526
|
-
patchedFirewallRule
|
|
548
|
+
const { status, data } = await apiInstance.cloudFirewallRulesSetCreate(
|
|
549
|
+
firewallRulesSet
|
|
527
550
|
);
|
|
528
551
|
```
|
|
529
552
|
|
|
@@ -531,14 +554,12 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetRulesPartialUpda
|
|
|
531
554
|
|
|
532
555
|
|Name | Type | Description | Notes|
|
|
533
556
|
|------------- | ------------- | ------------- | -------------|
|
|
534
|
-
| **
|
|
535
|
-
| **ruleId** | [**string**] | | defaults to undefined|
|
|
536
|
-
| **rulesSetId** | [**string**] | | defaults to undefined|
|
|
557
|
+
| **firewallRulesSet** | **FirewallRulesSet**| | |
|
|
537
558
|
|
|
538
559
|
|
|
539
560
|
### Return type
|
|
540
561
|
|
|
541
|
-
**
|
|
562
|
+
**FirewallRulesSet**
|
|
542
563
|
|
|
543
564
|
### Authorization
|
|
544
565
|
|
|
@@ -553,12 +574,12 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetRulesPartialUpda
|
|
|
553
574
|
### HTTP response details
|
|
554
575
|
| Status code | Description | Response headers |
|
|
555
576
|
|-------------|-------------|------------------|
|
|
556
|
-
|**
|
|
577
|
+
|**201** | | - |
|
|
557
578
|
|
|
558
579
|
[[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)
|
|
559
580
|
|
|
560
|
-
# **
|
|
561
|
-
>
|
|
581
|
+
# **cloudFirewallRulesSetDestroy**
|
|
582
|
+
> cloudFirewallRulesSetDestroy()
|
|
562
583
|
|
|
563
584
|
Require complete user profile for provisioning (create) API actions.
|
|
564
585
|
|
|
@@ -573,12 +594,10 @@ import {
|
|
|
573
594
|
const configuration = new Configuration();
|
|
574
595
|
const apiInstance = new CloudApi(configuration);
|
|
575
596
|
|
|
576
|
-
let
|
|
577
|
-
let rulesSetId: string; // (default to undefined)
|
|
597
|
+
let id: number; //A unique integer value identifying this firewall rules set. (default to undefined)
|
|
578
598
|
|
|
579
|
-
const { status, data } = await apiInstance.
|
|
580
|
-
|
|
581
|
-
rulesSetId
|
|
599
|
+
const { status, data } = await apiInstance.cloudFirewallRulesSetDestroy(
|
|
600
|
+
id
|
|
582
601
|
);
|
|
583
602
|
```
|
|
584
603
|
|
|
@@ -586,13 +605,56 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetRulesRetrieve(
|
|
|
586
605
|
|
|
587
606
|
|Name | Type | Description | Notes|
|
|
588
607
|
|------------- | ------------- | ------------- | -------------|
|
|
589
|
-
| **
|
|
590
|
-
| **rulesSetId** | [**string**] | | defaults to undefined|
|
|
608
|
+
| **id** | [**number**] | A unique integer value identifying this firewall rules set. | defaults to undefined|
|
|
591
609
|
|
|
592
610
|
|
|
593
611
|
### Return type
|
|
594
612
|
|
|
595
|
-
|
|
613
|
+
void (empty response body)
|
|
614
|
+
|
|
615
|
+
### Authorization
|
|
616
|
+
|
|
617
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
618
|
+
|
|
619
|
+
### HTTP request headers
|
|
620
|
+
|
|
621
|
+
- **Content-Type**: Not defined
|
|
622
|
+
- **Accept**: Not defined
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
### HTTP response details
|
|
626
|
+
| Status code | Description | Response headers |
|
|
627
|
+
|-------------|-------------|------------------|
|
|
628
|
+
|**204** | No response body | - |
|
|
629
|
+
|
|
630
|
+
[[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)
|
|
631
|
+
|
|
632
|
+
# **cloudFirewallRulesSetList**
|
|
633
|
+
> Array<FirewallRulesSet> cloudFirewallRulesSetList()
|
|
634
|
+
|
|
635
|
+
Require complete user profile for provisioning (create) API actions.
|
|
636
|
+
|
|
637
|
+
### Example
|
|
638
|
+
|
|
639
|
+
```typescript
|
|
640
|
+
import {
|
|
641
|
+
CloudApi,
|
|
642
|
+
Configuration
|
|
643
|
+
} from '@pidginhost/sdk';
|
|
644
|
+
|
|
645
|
+
const configuration = new Configuration();
|
|
646
|
+
const apiInstance = new CloudApi(configuration);
|
|
647
|
+
|
|
648
|
+
const { status, data } = await apiInstance.cloudFirewallRulesSetList();
|
|
649
|
+
```
|
|
650
|
+
|
|
651
|
+
### Parameters
|
|
652
|
+
This endpoint does not have any parameters.
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
### Return type
|
|
656
|
+
|
|
657
|
+
**Array<FirewallRulesSet>**
|
|
596
658
|
|
|
597
659
|
### Authorization
|
|
598
660
|
|
|
@@ -611,8 +673,8 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetRulesRetrieve(
|
|
|
611
673
|
|
|
612
674
|
[[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)
|
|
613
675
|
|
|
614
|
-
# **
|
|
615
|
-
>
|
|
676
|
+
# **cloudFirewallRulesSetPartialUpdate**
|
|
677
|
+
> FirewallRulesSet cloudFirewallRulesSetPartialUpdate()
|
|
616
678
|
|
|
617
679
|
Require complete user profile for provisioning (create) API actions.
|
|
618
680
|
|
|
@@ -622,20 +684,18 @@ Require complete user profile for provisioning (create) API actions.
|
|
|
622
684
|
import {
|
|
623
685
|
CloudApi,
|
|
624
686
|
Configuration,
|
|
625
|
-
|
|
687
|
+
PatchedFirewallRulesSet
|
|
626
688
|
} from '@pidginhost/sdk';
|
|
627
689
|
|
|
628
690
|
const configuration = new Configuration();
|
|
629
691
|
const apiInstance = new CloudApi(configuration);
|
|
630
692
|
|
|
631
|
-
let
|
|
632
|
-
let
|
|
633
|
-
let firewallRule: FirewallRule; //
|
|
693
|
+
let id: number; //A unique integer value identifying this firewall rules set. (default to undefined)
|
|
694
|
+
let patchedFirewallRulesSet: PatchedFirewallRulesSet; // (optional)
|
|
634
695
|
|
|
635
|
-
const { status, data } = await apiInstance.
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
firewallRule
|
|
696
|
+
const { status, data } = await apiInstance.cloudFirewallRulesSetPartialUpdate(
|
|
697
|
+
id,
|
|
698
|
+
patchedFirewallRulesSet
|
|
639
699
|
);
|
|
640
700
|
```
|
|
641
701
|
|
|
@@ -643,14 +703,13 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetRulesUpdate(
|
|
|
643
703
|
|
|
644
704
|
|Name | Type | Description | Notes|
|
|
645
705
|
|------------- | ------------- | ------------- | -------------|
|
|
646
|
-
| **
|
|
647
|
-
| **
|
|
648
|
-
| **rulesSetId** | [**string**] | | defaults to undefined|
|
|
706
|
+
| **patchedFirewallRulesSet** | **PatchedFirewallRulesSet**| | |
|
|
707
|
+
| **id** | [**number**] | A unique integer value identifying this firewall rules set. | defaults to undefined|
|
|
649
708
|
|
|
650
709
|
|
|
651
710
|
### Return type
|
|
652
711
|
|
|
653
|
-
**
|
|
712
|
+
**FirewallRulesSet**
|
|
654
713
|
|
|
655
714
|
### Authorization
|
|
656
715
|
|
|
@@ -669,8 +728,8 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetRulesUpdate(
|
|
|
669
728
|
|
|
670
729
|
[[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)
|
|
671
730
|
|
|
672
|
-
# **
|
|
673
|
-
> FirewallRulesSet
|
|
731
|
+
# **cloudFirewallRulesSetRetrieve**
|
|
732
|
+
> FirewallRulesSet cloudFirewallRulesSetRetrieve()
|
|
674
733
|
|
|
675
734
|
Require complete user profile for provisioning (create) API actions.
|
|
676
735
|
|
|
@@ -679,19 +738,16 @@ Require complete user profile for provisioning (create) API actions.
|
|
|
679
738
|
```typescript
|
|
680
739
|
import {
|
|
681
740
|
CloudApi,
|
|
682
|
-
Configuration
|
|
683
|
-
FirewallRulesSet
|
|
741
|
+
Configuration
|
|
684
742
|
} from '@pidginhost/sdk';
|
|
685
743
|
|
|
686
744
|
const configuration = new Configuration();
|
|
687
745
|
const apiInstance = new CloudApi(configuration);
|
|
688
746
|
|
|
689
747
|
let id: number; //A unique integer value identifying this firewall rules set. (default to undefined)
|
|
690
|
-
let firewallRulesSet: FirewallRulesSet; //
|
|
691
748
|
|
|
692
|
-
const { status, data } = await apiInstance.
|
|
693
|
-
id
|
|
694
|
-
firewallRulesSet
|
|
749
|
+
const { status, data } = await apiInstance.cloudFirewallRulesSetRetrieve(
|
|
750
|
+
id
|
|
695
751
|
);
|
|
696
752
|
```
|
|
697
753
|
|
|
@@ -699,7 +755,6 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetUpdate(
|
|
|
699
755
|
|
|
700
756
|
|Name | Type | Description | Notes|
|
|
701
757
|
|------------- | ------------- | ------------- | -------------|
|
|
702
|
-
| **firewallRulesSet** | **FirewallRulesSet**| | |
|
|
703
758
|
| **id** | [**number**] | A unique integer value identifying this firewall rules set. | defaults to undefined|
|
|
704
759
|
|
|
705
760
|
|
|
@@ -711,6 +766,1129 @@ const { status, data } = await apiInstance.cloudFirewallRulesSetUpdate(
|
|
|
711
766
|
|
|
712
767
|
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
713
768
|
|
|
769
|
+
### HTTP request headers
|
|
770
|
+
|
|
771
|
+
- **Content-Type**: Not defined
|
|
772
|
+
- **Accept**: application/json
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
### HTTP response details
|
|
776
|
+
| Status code | Description | Response headers |
|
|
777
|
+
|-------------|-------------|------------------|
|
|
778
|
+
|**200** | | - |
|
|
779
|
+
|
|
780
|
+
[[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)
|
|
781
|
+
|
|
782
|
+
# **cloudFirewallRulesSetRulesCreate**
|
|
783
|
+
> FirewallRule cloudFirewallRulesSetRulesCreate(firewallRule)
|
|
784
|
+
|
|
785
|
+
Require complete user profile for provisioning (create) API actions.
|
|
786
|
+
|
|
787
|
+
### Example
|
|
788
|
+
|
|
789
|
+
```typescript
|
|
790
|
+
import {
|
|
791
|
+
CloudApi,
|
|
792
|
+
Configuration,
|
|
793
|
+
FirewallRule
|
|
794
|
+
} from '@pidginhost/sdk';
|
|
795
|
+
|
|
796
|
+
const configuration = new Configuration();
|
|
797
|
+
const apiInstance = new CloudApi(configuration);
|
|
798
|
+
|
|
799
|
+
let rulesSetId: string; // (default to undefined)
|
|
800
|
+
let firewallRule: FirewallRule; //
|
|
801
|
+
|
|
802
|
+
const { status, data } = await apiInstance.cloudFirewallRulesSetRulesCreate(
|
|
803
|
+
rulesSetId,
|
|
804
|
+
firewallRule
|
|
805
|
+
);
|
|
806
|
+
```
|
|
807
|
+
|
|
808
|
+
### Parameters
|
|
809
|
+
|
|
810
|
+
|Name | Type | Description | Notes|
|
|
811
|
+
|------------- | ------------- | ------------- | -------------|
|
|
812
|
+
| **firewallRule** | **FirewallRule**| | |
|
|
813
|
+
| **rulesSetId** | [**string**] | | defaults to undefined|
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
### Return type
|
|
817
|
+
|
|
818
|
+
**FirewallRule**
|
|
819
|
+
|
|
820
|
+
### Authorization
|
|
821
|
+
|
|
822
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
823
|
+
|
|
824
|
+
### HTTP request headers
|
|
825
|
+
|
|
826
|
+
- **Content-Type**: application/json
|
|
827
|
+
- **Accept**: application/json
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
### HTTP response details
|
|
831
|
+
| Status code | Description | Response headers |
|
|
832
|
+
|-------------|-------------|------------------|
|
|
833
|
+
|**201** | | - |
|
|
834
|
+
|
|
835
|
+
[[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)
|
|
836
|
+
|
|
837
|
+
# **cloudFirewallRulesSetRulesDestroy**
|
|
838
|
+
> cloudFirewallRulesSetRulesDestroy()
|
|
839
|
+
|
|
840
|
+
Require complete user profile for provisioning (create) API actions.
|
|
841
|
+
|
|
842
|
+
### Example
|
|
843
|
+
|
|
844
|
+
```typescript
|
|
845
|
+
import {
|
|
846
|
+
CloudApi,
|
|
847
|
+
Configuration
|
|
848
|
+
} from '@pidginhost/sdk';
|
|
849
|
+
|
|
850
|
+
const configuration = new Configuration();
|
|
851
|
+
const apiInstance = new CloudApi(configuration);
|
|
852
|
+
|
|
853
|
+
let ruleId: string; // (default to undefined)
|
|
854
|
+
let rulesSetId: string; // (default to undefined)
|
|
855
|
+
|
|
856
|
+
const { status, data } = await apiInstance.cloudFirewallRulesSetRulesDestroy(
|
|
857
|
+
ruleId,
|
|
858
|
+
rulesSetId
|
|
859
|
+
);
|
|
860
|
+
```
|
|
861
|
+
|
|
862
|
+
### Parameters
|
|
863
|
+
|
|
864
|
+
|Name | Type | Description | Notes|
|
|
865
|
+
|------------- | ------------- | ------------- | -------------|
|
|
866
|
+
| **ruleId** | [**string**] | | defaults to undefined|
|
|
867
|
+
| **rulesSetId** | [**string**] | | defaults to undefined|
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
### Return type
|
|
871
|
+
|
|
872
|
+
void (empty response body)
|
|
873
|
+
|
|
874
|
+
### Authorization
|
|
875
|
+
|
|
876
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
877
|
+
|
|
878
|
+
### HTTP request headers
|
|
879
|
+
|
|
880
|
+
- **Content-Type**: Not defined
|
|
881
|
+
- **Accept**: Not defined
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
### HTTP response details
|
|
885
|
+
| Status code | Description | Response headers |
|
|
886
|
+
|-------------|-------------|------------------|
|
|
887
|
+
|**204** | No response body | - |
|
|
888
|
+
|
|
889
|
+
[[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)
|
|
890
|
+
|
|
891
|
+
# **cloudFirewallRulesSetRulesList**
|
|
892
|
+
> Array<FirewallRule> cloudFirewallRulesSetRulesList()
|
|
893
|
+
|
|
894
|
+
Require complete user profile for provisioning (create) API actions.
|
|
895
|
+
|
|
896
|
+
### Example
|
|
897
|
+
|
|
898
|
+
```typescript
|
|
899
|
+
import {
|
|
900
|
+
CloudApi,
|
|
901
|
+
Configuration
|
|
902
|
+
} from '@pidginhost/sdk';
|
|
903
|
+
|
|
904
|
+
const configuration = new Configuration();
|
|
905
|
+
const apiInstance = new CloudApi(configuration);
|
|
906
|
+
|
|
907
|
+
let rulesSetId: string; // (default to undefined)
|
|
908
|
+
|
|
909
|
+
const { status, data } = await apiInstance.cloudFirewallRulesSetRulesList(
|
|
910
|
+
rulesSetId
|
|
911
|
+
);
|
|
912
|
+
```
|
|
913
|
+
|
|
914
|
+
### Parameters
|
|
915
|
+
|
|
916
|
+
|Name | Type | Description | Notes|
|
|
917
|
+
|------------- | ------------- | ------------- | -------------|
|
|
918
|
+
| **rulesSetId** | [**string**] | | defaults to undefined|
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
### Return type
|
|
922
|
+
|
|
923
|
+
**Array<FirewallRule>**
|
|
924
|
+
|
|
925
|
+
### Authorization
|
|
926
|
+
|
|
927
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
928
|
+
|
|
929
|
+
### HTTP request headers
|
|
930
|
+
|
|
931
|
+
- **Content-Type**: Not defined
|
|
932
|
+
- **Accept**: application/json
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
### HTTP response details
|
|
936
|
+
| Status code | Description | Response headers |
|
|
937
|
+
|-------------|-------------|------------------|
|
|
938
|
+
|**200** | | - |
|
|
939
|
+
|
|
940
|
+
[[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)
|
|
941
|
+
|
|
942
|
+
# **cloudFirewallRulesSetRulesPartialUpdate**
|
|
943
|
+
> FirewallRule cloudFirewallRulesSetRulesPartialUpdate()
|
|
944
|
+
|
|
945
|
+
Require complete user profile for provisioning (create) API actions.
|
|
946
|
+
|
|
947
|
+
### Example
|
|
948
|
+
|
|
949
|
+
```typescript
|
|
950
|
+
import {
|
|
951
|
+
CloudApi,
|
|
952
|
+
Configuration,
|
|
953
|
+
PatchedFirewallRule
|
|
954
|
+
} from '@pidginhost/sdk';
|
|
955
|
+
|
|
956
|
+
const configuration = new Configuration();
|
|
957
|
+
const apiInstance = new CloudApi(configuration);
|
|
958
|
+
|
|
959
|
+
let ruleId: string; // (default to undefined)
|
|
960
|
+
let rulesSetId: string; // (default to undefined)
|
|
961
|
+
let patchedFirewallRule: PatchedFirewallRule; // (optional)
|
|
962
|
+
|
|
963
|
+
const { status, data } = await apiInstance.cloudFirewallRulesSetRulesPartialUpdate(
|
|
964
|
+
ruleId,
|
|
965
|
+
rulesSetId,
|
|
966
|
+
patchedFirewallRule
|
|
967
|
+
);
|
|
968
|
+
```
|
|
969
|
+
|
|
970
|
+
### Parameters
|
|
971
|
+
|
|
972
|
+
|Name | Type | Description | Notes|
|
|
973
|
+
|------------- | ------------- | ------------- | -------------|
|
|
974
|
+
| **patchedFirewallRule** | **PatchedFirewallRule**| | |
|
|
975
|
+
| **ruleId** | [**string**] | | defaults to undefined|
|
|
976
|
+
| **rulesSetId** | [**string**] | | defaults to undefined|
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
### Return type
|
|
980
|
+
|
|
981
|
+
**FirewallRule**
|
|
982
|
+
|
|
983
|
+
### Authorization
|
|
984
|
+
|
|
985
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
986
|
+
|
|
987
|
+
### HTTP request headers
|
|
988
|
+
|
|
989
|
+
- **Content-Type**: application/json
|
|
990
|
+
- **Accept**: application/json
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
### HTTP response details
|
|
994
|
+
| Status code | Description | Response headers |
|
|
995
|
+
|-------------|-------------|------------------|
|
|
996
|
+
|**200** | | - |
|
|
997
|
+
|
|
998
|
+
[[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)
|
|
999
|
+
|
|
1000
|
+
# **cloudFirewallRulesSetRulesRetrieve**
|
|
1001
|
+
> FirewallRule cloudFirewallRulesSetRulesRetrieve()
|
|
1002
|
+
|
|
1003
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1004
|
+
|
|
1005
|
+
### Example
|
|
1006
|
+
|
|
1007
|
+
```typescript
|
|
1008
|
+
import {
|
|
1009
|
+
CloudApi,
|
|
1010
|
+
Configuration
|
|
1011
|
+
} from '@pidginhost/sdk';
|
|
1012
|
+
|
|
1013
|
+
const configuration = new Configuration();
|
|
1014
|
+
const apiInstance = new CloudApi(configuration);
|
|
1015
|
+
|
|
1016
|
+
let ruleId: string; // (default to undefined)
|
|
1017
|
+
let rulesSetId: string; // (default to undefined)
|
|
1018
|
+
|
|
1019
|
+
const { status, data } = await apiInstance.cloudFirewallRulesSetRulesRetrieve(
|
|
1020
|
+
ruleId,
|
|
1021
|
+
rulesSetId
|
|
1022
|
+
);
|
|
1023
|
+
```
|
|
1024
|
+
|
|
1025
|
+
### Parameters
|
|
1026
|
+
|
|
1027
|
+
|Name | Type | Description | Notes|
|
|
1028
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1029
|
+
| **ruleId** | [**string**] | | defaults to undefined|
|
|
1030
|
+
| **rulesSetId** | [**string**] | | defaults to undefined|
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
### Return type
|
|
1034
|
+
|
|
1035
|
+
**FirewallRule**
|
|
1036
|
+
|
|
1037
|
+
### Authorization
|
|
1038
|
+
|
|
1039
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1040
|
+
|
|
1041
|
+
### HTTP request headers
|
|
1042
|
+
|
|
1043
|
+
- **Content-Type**: Not defined
|
|
1044
|
+
- **Accept**: application/json
|
|
1045
|
+
|
|
1046
|
+
|
|
1047
|
+
### HTTP response details
|
|
1048
|
+
| Status code | Description | Response headers |
|
|
1049
|
+
|-------------|-------------|------------------|
|
|
1050
|
+
|**200** | | - |
|
|
1051
|
+
|
|
1052
|
+
[[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)
|
|
1053
|
+
|
|
1054
|
+
# **cloudFirewallRulesSetRulesUpdate**
|
|
1055
|
+
> FirewallRule cloudFirewallRulesSetRulesUpdate(firewallRule)
|
|
1056
|
+
|
|
1057
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1058
|
+
|
|
1059
|
+
### Example
|
|
1060
|
+
|
|
1061
|
+
```typescript
|
|
1062
|
+
import {
|
|
1063
|
+
CloudApi,
|
|
1064
|
+
Configuration,
|
|
1065
|
+
FirewallRule
|
|
1066
|
+
} from '@pidginhost/sdk';
|
|
1067
|
+
|
|
1068
|
+
const configuration = new Configuration();
|
|
1069
|
+
const apiInstance = new CloudApi(configuration);
|
|
1070
|
+
|
|
1071
|
+
let ruleId: string; // (default to undefined)
|
|
1072
|
+
let rulesSetId: string; // (default to undefined)
|
|
1073
|
+
let firewallRule: FirewallRule; //
|
|
1074
|
+
|
|
1075
|
+
const { status, data } = await apiInstance.cloudFirewallRulesSetRulesUpdate(
|
|
1076
|
+
ruleId,
|
|
1077
|
+
rulesSetId,
|
|
1078
|
+
firewallRule
|
|
1079
|
+
);
|
|
1080
|
+
```
|
|
1081
|
+
|
|
1082
|
+
### Parameters
|
|
1083
|
+
|
|
1084
|
+
|Name | Type | Description | Notes|
|
|
1085
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1086
|
+
| **firewallRule** | **FirewallRule**| | |
|
|
1087
|
+
| **ruleId** | [**string**] | | defaults to undefined|
|
|
1088
|
+
| **rulesSetId** | [**string**] | | defaults to undefined|
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
### Return type
|
|
1092
|
+
|
|
1093
|
+
**FirewallRule**
|
|
1094
|
+
|
|
1095
|
+
### Authorization
|
|
1096
|
+
|
|
1097
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1098
|
+
|
|
1099
|
+
### HTTP request headers
|
|
1100
|
+
|
|
1101
|
+
- **Content-Type**: application/json
|
|
1102
|
+
- **Accept**: application/json
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
### HTTP response details
|
|
1106
|
+
| Status code | Description | Response headers |
|
|
1107
|
+
|-------------|-------------|------------------|
|
|
1108
|
+
|**200** | | - |
|
|
1109
|
+
|
|
1110
|
+
[[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)
|
|
1111
|
+
|
|
1112
|
+
# **cloudFirewallRulesSetUpdate**
|
|
1113
|
+
> FirewallRulesSet cloudFirewallRulesSetUpdate(firewallRulesSet)
|
|
1114
|
+
|
|
1115
|
+
Require complete user profile for provisioning (create) API actions.
|
|
1116
|
+
|
|
1117
|
+
### Example
|
|
1118
|
+
|
|
1119
|
+
```typescript
|
|
1120
|
+
import {
|
|
1121
|
+
CloudApi,
|
|
1122
|
+
Configuration,
|
|
1123
|
+
FirewallRulesSet
|
|
1124
|
+
} from '@pidginhost/sdk';
|
|
1125
|
+
|
|
1126
|
+
const configuration = new Configuration();
|
|
1127
|
+
const apiInstance = new CloudApi(configuration);
|
|
1128
|
+
|
|
1129
|
+
let id: number; //A unique integer value identifying this firewall rules set. (default to undefined)
|
|
1130
|
+
let firewallRulesSet: FirewallRulesSet; //
|
|
1131
|
+
|
|
1132
|
+
const { status, data } = await apiInstance.cloudFirewallRulesSetUpdate(
|
|
1133
|
+
id,
|
|
1134
|
+
firewallRulesSet
|
|
1135
|
+
);
|
|
1136
|
+
```
|
|
1137
|
+
|
|
1138
|
+
### Parameters
|
|
1139
|
+
|
|
1140
|
+
|Name | Type | Description | Notes|
|
|
1141
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1142
|
+
| **firewallRulesSet** | **FirewallRulesSet**| | |
|
|
1143
|
+
| **id** | [**number**] | A unique integer value identifying this firewall rules set. | defaults to undefined|
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
### Return type
|
|
1147
|
+
|
|
1148
|
+
**FirewallRulesSet**
|
|
1149
|
+
|
|
1150
|
+
### Authorization
|
|
1151
|
+
|
|
1152
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1153
|
+
|
|
1154
|
+
### HTTP request headers
|
|
1155
|
+
|
|
1156
|
+
- **Content-Type**: application/json
|
|
1157
|
+
- **Accept**: application/json
|
|
1158
|
+
|
|
1159
|
+
|
|
1160
|
+
### HTTP response details
|
|
1161
|
+
| Status code | Description | Response headers |
|
|
1162
|
+
|-------------|-------------|------------------|
|
|
1163
|
+
|**200** | | - |
|
|
1164
|
+
|
|
1165
|
+
[[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)
|
|
1166
|
+
|
|
1167
|
+
# **cloudFloatingIpv4AuthorizationsList**
|
|
1168
|
+
> PaginatedFloatingIPAuthorizationList cloudFloatingIpv4AuthorizationsList()
|
|
1169
|
+
|
|
1170
|
+
Manage floating IPv4 addresses. A floating IP can be authorized on multiple VMs simultaneously; the customer asserts ownership inside the guest via keepalived/VRRP.
|
|
1171
|
+
|
|
1172
|
+
### Example
|
|
1173
|
+
|
|
1174
|
+
```typescript
|
|
1175
|
+
import {
|
|
1176
|
+
CloudApi,
|
|
1177
|
+
Configuration
|
|
1178
|
+
} from '@pidginhost/sdk';
|
|
1179
|
+
|
|
1180
|
+
const configuration = new Configuration();
|
|
1181
|
+
const apiInstance = new CloudApi(configuration);
|
|
1182
|
+
|
|
1183
|
+
let id: number; //A unique integer value identifying this floating IPv4. (default to undefined)
|
|
1184
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1185
|
+
|
|
1186
|
+
const { status, data } = await apiInstance.cloudFloatingIpv4AuthorizationsList(
|
|
1187
|
+
id,
|
|
1188
|
+
page
|
|
1189
|
+
);
|
|
1190
|
+
```
|
|
1191
|
+
|
|
1192
|
+
### Parameters
|
|
1193
|
+
|
|
1194
|
+
|Name | Type | Description | Notes|
|
|
1195
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1196
|
+
| **id** | [**number**] | A unique integer value identifying this floating IPv4. | defaults to undefined|
|
|
1197
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1198
|
+
|
|
1199
|
+
|
|
1200
|
+
### Return type
|
|
1201
|
+
|
|
1202
|
+
**PaginatedFloatingIPAuthorizationList**
|
|
1203
|
+
|
|
1204
|
+
### Authorization
|
|
1205
|
+
|
|
1206
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1207
|
+
|
|
1208
|
+
### HTTP request headers
|
|
1209
|
+
|
|
1210
|
+
- **Content-Type**: Not defined
|
|
1211
|
+
- **Accept**: application/json
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
### HTTP response details
|
|
1215
|
+
| Status code | Description | Response headers |
|
|
1216
|
+
|-------------|-------------|------------------|
|
|
1217
|
+
|**200** | | - |
|
|
1218
|
+
|
|
1219
|
+
[[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)
|
|
1220
|
+
|
|
1221
|
+
# **cloudFloatingIpv4AuthorizeCreate**
|
|
1222
|
+
> FloatingIPv4AuthorizeResponse cloudFloatingIpv4AuthorizeCreate(floatingIPAuthorizeRequest)
|
|
1223
|
+
|
|
1224
|
+
Manage floating IPv4 addresses. A floating IP can be authorized on multiple VMs simultaneously; the customer asserts ownership inside the guest via keepalived/VRRP.
|
|
1225
|
+
|
|
1226
|
+
### Example
|
|
1227
|
+
|
|
1228
|
+
```typescript
|
|
1229
|
+
import {
|
|
1230
|
+
CloudApi,
|
|
1231
|
+
Configuration,
|
|
1232
|
+
FloatingIPAuthorizeRequest
|
|
1233
|
+
} from '@pidginhost/sdk';
|
|
1234
|
+
|
|
1235
|
+
const configuration = new Configuration();
|
|
1236
|
+
const apiInstance = new CloudApi(configuration);
|
|
1237
|
+
|
|
1238
|
+
let id: number; //A unique integer value identifying this floating IPv4. (default to undefined)
|
|
1239
|
+
let floatingIPAuthorizeRequest: FloatingIPAuthorizeRequest; //
|
|
1240
|
+
|
|
1241
|
+
const { status, data } = await apiInstance.cloudFloatingIpv4AuthorizeCreate(
|
|
1242
|
+
id,
|
|
1243
|
+
floatingIPAuthorizeRequest
|
|
1244
|
+
);
|
|
1245
|
+
```
|
|
1246
|
+
|
|
1247
|
+
### Parameters
|
|
1248
|
+
|
|
1249
|
+
|Name | Type | Description | Notes|
|
|
1250
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1251
|
+
| **floatingIPAuthorizeRequest** | **FloatingIPAuthorizeRequest**| | |
|
|
1252
|
+
| **id** | [**number**] | A unique integer value identifying this floating IPv4. | defaults to undefined|
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
### Return type
|
|
1256
|
+
|
|
1257
|
+
**FloatingIPv4AuthorizeResponse**
|
|
1258
|
+
|
|
1259
|
+
### Authorization
|
|
1260
|
+
|
|
1261
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1262
|
+
|
|
1263
|
+
### HTTP request headers
|
|
1264
|
+
|
|
1265
|
+
- **Content-Type**: application/json
|
|
1266
|
+
- **Accept**: application/json
|
|
1267
|
+
|
|
1268
|
+
|
|
1269
|
+
### HTTP response details
|
|
1270
|
+
| Status code | Description | Response headers |
|
|
1271
|
+
|-------------|-------------|------------------|
|
|
1272
|
+
|**200** | | - |
|
|
1273
|
+
|
|
1274
|
+
[[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)
|
|
1275
|
+
|
|
1276
|
+
# **cloudFloatingIpv4Create**
|
|
1277
|
+
> FloatingIPv4 cloudFloatingIpv4Create()
|
|
1278
|
+
|
|
1279
|
+
Manage floating IPv4 addresses. A floating IP can be authorized on multiple VMs simultaneously; the customer asserts ownership inside the guest via keepalived/VRRP.
|
|
1280
|
+
|
|
1281
|
+
### Example
|
|
1282
|
+
|
|
1283
|
+
```typescript
|
|
1284
|
+
import {
|
|
1285
|
+
CloudApi,
|
|
1286
|
+
Configuration,
|
|
1287
|
+
FloatingIPv4Create
|
|
1288
|
+
} from '@pidginhost/sdk';
|
|
1289
|
+
|
|
1290
|
+
const configuration = new Configuration();
|
|
1291
|
+
const apiInstance = new CloudApi(configuration);
|
|
1292
|
+
|
|
1293
|
+
let floatingIPv4Create: FloatingIPv4Create; // (optional)
|
|
1294
|
+
|
|
1295
|
+
const { status, data } = await apiInstance.cloudFloatingIpv4Create(
|
|
1296
|
+
floatingIPv4Create
|
|
1297
|
+
);
|
|
1298
|
+
```
|
|
1299
|
+
|
|
1300
|
+
### Parameters
|
|
1301
|
+
|
|
1302
|
+
|Name | Type | Description | Notes|
|
|
1303
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1304
|
+
| **floatingIPv4Create** | **FloatingIPv4Create**| | |
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
### Return type
|
|
1308
|
+
|
|
1309
|
+
**FloatingIPv4**
|
|
1310
|
+
|
|
1311
|
+
### Authorization
|
|
1312
|
+
|
|
1313
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1314
|
+
|
|
1315
|
+
### HTTP request headers
|
|
1316
|
+
|
|
1317
|
+
- **Content-Type**: application/json
|
|
1318
|
+
- **Accept**: application/json
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
### HTTP response details
|
|
1322
|
+
| Status code | Description | Response headers |
|
|
1323
|
+
|-------------|-------------|------------------|
|
|
1324
|
+
|**201** | | - |
|
|
1325
|
+
|
|
1326
|
+
[[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)
|
|
1327
|
+
|
|
1328
|
+
# **cloudFloatingIpv4Destroy**
|
|
1329
|
+
> cloudFloatingIpv4Destroy()
|
|
1330
|
+
|
|
1331
|
+
Manage floating IPv4 addresses. A floating IP can be authorized on multiple VMs simultaneously; the customer asserts ownership inside the guest via keepalived/VRRP.
|
|
1332
|
+
|
|
1333
|
+
### Example
|
|
1334
|
+
|
|
1335
|
+
```typescript
|
|
1336
|
+
import {
|
|
1337
|
+
CloudApi,
|
|
1338
|
+
Configuration
|
|
1339
|
+
} from '@pidginhost/sdk';
|
|
1340
|
+
|
|
1341
|
+
const configuration = new Configuration();
|
|
1342
|
+
const apiInstance = new CloudApi(configuration);
|
|
1343
|
+
|
|
1344
|
+
let id: number; //A unique integer value identifying this floating IPv4. (default to undefined)
|
|
1345
|
+
|
|
1346
|
+
const { status, data } = await apiInstance.cloudFloatingIpv4Destroy(
|
|
1347
|
+
id
|
|
1348
|
+
);
|
|
1349
|
+
```
|
|
1350
|
+
|
|
1351
|
+
### Parameters
|
|
1352
|
+
|
|
1353
|
+
|Name | Type | Description | Notes|
|
|
1354
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1355
|
+
| **id** | [**number**] | A unique integer value identifying this floating IPv4. | defaults to undefined|
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
### Return type
|
|
1359
|
+
|
|
1360
|
+
void (empty response body)
|
|
1361
|
+
|
|
1362
|
+
### Authorization
|
|
1363
|
+
|
|
1364
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1365
|
+
|
|
1366
|
+
### HTTP request headers
|
|
1367
|
+
|
|
1368
|
+
- **Content-Type**: Not defined
|
|
1369
|
+
- **Accept**: Not defined
|
|
1370
|
+
|
|
1371
|
+
|
|
1372
|
+
### HTTP response details
|
|
1373
|
+
| Status code | Description | Response headers |
|
|
1374
|
+
|-------------|-------------|------------------|
|
|
1375
|
+
|**204** | No response body | - |
|
|
1376
|
+
|
|
1377
|
+
[[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)
|
|
1378
|
+
|
|
1379
|
+
# **cloudFloatingIpv4List**
|
|
1380
|
+
> PaginatedFloatingIPv4List cloudFloatingIpv4List()
|
|
1381
|
+
|
|
1382
|
+
Manage floating IPv4 addresses. A floating IP can be authorized on multiple VMs simultaneously; the customer asserts ownership inside the guest via keepalived/VRRP.
|
|
1383
|
+
|
|
1384
|
+
### Example
|
|
1385
|
+
|
|
1386
|
+
```typescript
|
|
1387
|
+
import {
|
|
1388
|
+
CloudApi,
|
|
1389
|
+
Configuration
|
|
1390
|
+
} from '@pidginhost/sdk';
|
|
1391
|
+
|
|
1392
|
+
const configuration = new Configuration();
|
|
1393
|
+
const apiInstance = new CloudApi(configuration);
|
|
1394
|
+
|
|
1395
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1396
|
+
|
|
1397
|
+
const { status, data } = await apiInstance.cloudFloatingIpv4List(
|
|
1398
|
+
page
|
|
1399
|
+
);
|
|
1400
|
+
```
|
|
1401
|
+
|
|
1402
|
+
### Parameters
|
|
1403
|
+
|
|
1404
|
+
|Name | Type | Description | Notes|
|
|
1405
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1406
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
### Return type
|
|
1410
|
+
|
|
1411
|
+
**PaginatedFloatingIPv4List**
|
|
1412
|
+
|
|
1413
|
+
### Authorization
|
|
1414
|
+
|
|
1415
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1416
|
+
|
|
1417
|
+
### HTTP request headers
|
|
1418
|
+
|
|
1419
|
+
- **Content-Type**: Not defined
|
|
1420
|
+
- **Accept**: application/json
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
### HTTP response details
|
|
1424
|
+
| Status code | Description | Response headers |
|
|
1425
|
+
|-------------|-------------|------------------|
|
|
1426
|
+
|**200** | | - |
|
|
1427
|
+
|
|
1428
|
+
[[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)
|
|
1429
|
+
|
|
1430
|
+
# **cloudFloatingIpv4Retrieve**
|
|
1431
|
+
> FloatingIPv4 cloudFloatingIpv4Retrieve()
|
|
1432
|
+
|
|
1433
|
+
Manage floating IPv4 addresses. A floating IP can be authorized on multiple VMs simultaneously; the customer asserts ownership inside the guest via keepalived/VRRP.
|
|
1434
|
+
|
|
1435
|
+
### Example
|
|
1436
|
+
|
|
1437
|
+
```typescript
|
|
1438
|
+
import {
|
|
1439
|
+
CloudApi,
|
|
1440
|
+
Configuration
|
|
1441
|
+
} from '@pidginhost/sdk';
|
|
1442
|
+
|
|
1443
|
+
const configuration = new Configuration();
|
|
1444
|
+
const apiInstance = new CloudApi(configuration);
|
|
1445
|
+
|
|
1446
|
+
let id: number; //A unique integer value identifying this floating IPv4. (default to undefined)
|
|
1447
|
+
|
|
1448
|
+
const { status, data } = await apiInstance.cloudFloatingIpv4Retrieve(
|
|
1449
|
+
id
|
|
1450
|
+
);
|
|
1451
|
+
```
|
|
1452
|
+
|
|
1453
|
+
### Parameters
|
|
1454
|
+
|
|
1455
|
+
|Name | Type | Description | Notes|
|
|
1456
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1457
|
+
| **id** | [**number**] | A unique integer value identifying this floating IPv4. | defaults to undefined|
|
|
1458
|
+
|
|
1459
|
+
|
|
1460
|
+
### Return type
|
|
1461
|
+
|
|
1462
|
+
**FloatingIPv4**
|
|
1463
|
+
|
|
1464
|
+
### Authorization
|
|
1465
|
+
|
|
1466
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1467
|
+
|
|
1468
|
+
### HTTP request headers
|
|
1469
|
+
|
|
1470
|
+
- **Content-Type**: Not defined
|
|
1471
|
+
- **Accept**: application/json
|
|
1472
|
+
|
|
1473
|
+
|
|
1474
|
+
### HTTP response details
|
|
1475
|
+
| Status code | Description | Response headers |
|
|
1476
|
+
|-------------|-------------|------------------|
|
|
1477
|
+
|**200** | | - |
|
|
1478
|
+
|
|
1479
|
+
[[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)
|
|
1480
|
+
|
|
1481
|
+
# **cloudFloatingIpv4UnauthorizeCreate**
|
|
1482
|
+
> FloatingIPv4UnauthorizeResponse cloudFloatingIpv4UnauthorizeCreate(floatingIPAuthorizeRequest)
|
|
1483
|
+
|
|
1484
|
+
Manage floating IPv4 addresses. A floating IP can be authorized on multiple VMs simultaneously; the customer asserts ownership inside the guest via keepalived/VRRP.
|
|
1485
|
+
|
|
1486
|
+
### Example
|
|
1487
|
+
|
|
1488
|
+
```typescript
|
|
1489
|
+
import {
|
|
1490
|
+
CloudApi,
|
|
1491
|
+
Configuration,
|
|
1492
|
+
FloatingIPAuthorizeRequest
|
|
1493
|
+
} from '@pidginhost/sdk';
|
|
1494
|
+
|
|
1495
|
+
const configuration = new Configuration();
|
|
1496
|
+
const apiInstance = new CloudApi(configuration);
|
|
1497
|
+
|
|
1498
|
+
let id: number; //A unique integer value identifying this floating IPv4. (default to undefined)
|
|
1499
|
+
let floatingIPAuthorizeRequest: FloatingIPAuthorizeRequest; //
|
|
1500
|
+
|
|
1501
|
+
const { status, data } = await apiInstance.cloudFloatingIpv4UnauthorizeCreate(
|
|
1502
|
+
id,
|
|
1503
|
+
floatingIPAuthorizeRequest
|
|
1504
|
+
);
|
|
1505
|
+
```
|
|
1506
|
+
|
|
1507
|
+
### Parameters
|
|
1508
|
+
|
|
1509
|
+
|Name | Type | Description | Notes|
|
|
1510
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1511
|
+
| **floatingIPAuthorizeRequest** | **FloatingIPAuthorizeRequest**| | |
|
|
1512
|
+
| **id** | [**number**] | A unique integer value identifying this floating IPv4. | defaults to undefined|
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
### Return type
|
|
1516
|
+
|
|
1517
|
+
**FloatingIPv4UnauthorizeResponse**
|
|
1518
|
+
|
|
1519
|
+
### Authorization
|
|
1520
|
+
|
|
1521
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1522
|
+
|
|
1523
|
+
### HTTP request headers
|
|
1524
|
+
|
|
1525
|
+
- **Content-Type**: application/json
|
|
1526
|
+
- **Accept**: application/json
|
|
1527
|
+
|
|
1528
|
+
|
|
1529
|
+
### HTTP response details
|
|
1530
|
+
| Status code | Description | Response headers |
|
|
1531
|
+
|-------------|-------------|------------------|
|
|
1532
|
+
|**200** | | - |
|
|
1533
|
+
|
|
1534
|
+
[[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)
|
|
1535
|
+
|
|
1536
|
+
# **cloudFloatingIpv6AuthorizationsList**
|
|
1537
|
+
> PaginatedFloatingIPAuthorizationList cloudFloatingIpv6AuthorizationsList()
|
|
1538
|
+
|
|
1539
|
+
Manage floating IPv6 addresses.
|
|
1540
|
+
|
|
1541
|
+
### Example
|
|
1542
|
+
|
|
1543
|
+
```typescript
|
|
1544
|
+
import {
|
|
1545
|
+
CloudApi,
|
|
1546
|
+
Configuration
|
|
1547
|
+
} from '@pidginhost/sdk';
|
|
1548
|
+
|
|
1549
|
+
const configuration = new Configuration();
|
|
1550
|
+
const apiInstance = new CloudApi(configuration);
|
|
1551
|
+
|
|
1552
|
+
let id: number; //A unique integer value identifying this floating IPv6. (default to undefined)
|
|
1553
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1554
|
+
|
|
1555
|
+
const { status, data } = await apiInstance.cloudFloatingIpv6AuthorizationsList(
|
|
1556
|
+
id,
|
|
1557
|
+
page
|
|
1558
|
+
);
|
|
1559
|
+
```
|
|
1560
|
+
|
|
1561
|
+
### Parameters
|
|
1562
|
+
|
|
1563
|
+
|Name | Type | Description | Notes|
|
|
1564
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1565
|
+
| **id** | [**number**] | A unique integer value identifying this floating IPv6. | defaults to undefined|
|
|
1566
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1567
|
+
|
|
1568
|
+
|
|
1569
|
+
### Return type
|
|
1570
|
+
|
|
1571
|
+
**PaginatedFloatingIPAuthorizationList**
|
|
1572
|
+
|
|
1573
|
+
### Authorization
|
|
1574
|
+
|
|
1575
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1576
|
+
|
|
1577
|
+
### HTTP request headers
|
|
1578
|
+
|
|
1579
|
+
- **Content-Type**: Not defined
|
|
1580
|
+
- **Accept**: application/json
|
|
1581
|
+
|
|
1582
|
+
|
|
1583
|
+
### HTTP response details
|
|
1584
|
+
| Status code | Description | Response headers |
|
|
1585
|
+
|-------------|-------------|------------------|
|
|
1586
|
+
|**200** | | - |
|
|
1587
|
+
|
|
1588
|
+
[[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)
|
|
1589
|
+
|
|
1590
|
+
# **cloudFloatingIpv6AuthorizeCreate**
|
|
1591
|
+
> FloatingIPv6AuthorizeResponse cloudFloatingIpv6AuthorizeCreate(floatingIPAuthorizeRequest)
|
|
1592
|
+
|
|
1593
|
+
Manage floating IPv6 addresses.
|
|
1594
|
+
|
|
1595
|
+
### Example
|
|
1596
|
+
|
|
1597
|
+
```typescript
|
|
1598
|
+
import {
|
|
1599
|
+
CloudApi,
|
|
1600
|
+
Configuration,
|
|
1601
|
+
FloatingIPAuthorizeRequest
|
|
1602
|
+
} from '@pidginhost/sdk';
|
|
1603
|
+
|
|
1604
|
+
const configuration = new Configuration();
|
|
1605
|
+
const apiInstance = new CloudApi(configuration);
|
|
1606
|
+
|
|
1607
|
+
let id: number; //A unique integer value identifying this floating IPv6. (default to undefined)
|
|
1608
|
+
let floatingIPAuthorizeRequest: FloatingIPAuthorizeRequest; //
|
|
1609
|
+
|
|
1610
|
+
const { status, data } = await apiInstance.cloudFloatingIpv6AuthorizeCreate(
|
|
1611
|
+
id,
|
|
1612
|
+
floatingIPAuthorizeRequest
|
|
1613
|
+
);
|
|
1614
|
+
```
|
|
1615
|
+
|
|
1616
|
+
### Parameters
|
|
1617
|
+
|
|
1618
|
+
|Name | Type | Description | Notes|
|
|
1619
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1620
|
+
| **floatingIPAuthorizeRequest** | **FloatingIPAuthorizeRequest**| | |
|
|
1621
|
+
| **id** | [**number**] | A unique integer value identifying this floating IPv6. | defaults to undefined|
|
|
1622
|
+
|
|
1623
|
+
|
|
1624
|
+
### Return type
|
|
1625
|
+
|
|
1626
|
+
**FloatingIPv6AuthorizeResponse**
|
|
1627
|
+
|
|
1628
|
+
### Authorization
|
|
1629
|
+
|
|
1630
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1631
|
+
|
|
1632
|
+
### HTTP request headers
|
|
1633
|
+
|
|
1634
|
+
- **Content-Type**: application/json
|
|
1635
|
+
- **Accept**: application/json
|
|
1636
|
+
|
|
1637
|
+
|
|
1638
|
+
### HTTP response details
|
|
1639
|
+
| Status code | Description | Response headers |
|
|
1640
|
+
|-------------|-------------|------------------|
|
|
1641
|
+
|**200** | | - |
|
|
1642
|
+
|
|
1643
|
+
[[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)
|
|
1644
|
+
|
|
1645
|
+
# **cloudFloatingIpv6Create**
|
|
1646
|
+
> FloatingIPv6 cloudFloatingIpv6Create()
|
|
1647
|
+
|
|
1648
|
+
Manage floating IPv6 addresses.
|
|
1649
|
+
|
|
1650
|
+
### Example
|
|
1651
|
+
|
|
1652
|
+
```typescript
|
|
1653
|
+
import {
|
|
1654
|
+
CloudApi,
|
|
1655
|
+
Configuration,
|
|
1656
|
+
FloatingIPv6Create
|
|
1657
|
+
} from '@pidginhost/sdk';
|
|
1658
|
+
|
|
1659
|
+
const configuration = new Configuration();
|
|
1660
|
+
const apiInstance = new CloudApi(configuration);
|
|
1661
|
+
|
|
1662
|
+
let floatingIPv6Create: FloatingIPv6Create; // (optional)
|
|
1663
|
+
|
|
1664
|
+
const { status, data } = await apiInstance.cloudFloatingIpv6Create(
|
|
1665
|
+
floatingIPv6Create
|
|
1666
|
+
);
|
|
1667
|
+
```
|
|
1668
|
+
|
|
1669
|
+
### Parameters
|
|
1670
|
+
|
|
1671
|
+
|Name | Type | Description | Notes|
|
|
1672
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1673
|
+
| **floatingIPv6Create** | **FloatingIPv6Create**| | |
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
### Return type
|
|
1677
|
+
|
|
1678
|
+
**FloatingIPv6**
|
|
1679
|
+
|
|
1680
|
+
### Authorization
|
|
1681
|
+
|
|
1682
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1683
|
+
|
|
1684
|
+
### HTTP request headers
|
|
1685
|
+
|
|
1686
|
+
- **Content-Type**: application/json
|
|
1687
|
+
- **Accept**: application/json
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
### HTTP response details
|
|
1691
|
+
| Status code | Description | Response headers |
|
|
1692
|
+
|-------------|-------------|------------------|
|
|
1693
|
+
|**201** | | - |
|
|
1694
|
+
|
|
1695
|
+
[[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)
|
|
1696
|
+
|
|
1697
|
+
# **cloudFloatingIpv6Destroy**
|
|
1698
|
+
> cloudFloatingIpv6Destroy()
|
|
1699
|
+
|
|
1700
|
+
Manage floating IPv6 addresses.
|
|
1701
|
+
|
|
1702
|
+
### Example
|
|
1703
|
+
|
|
1704
|
+
```typescript
|
|
1705
|
+
import {
|
|
1706
|
+
CloudApi,
|
|
1707
|
+
Configuration
|
|
1708
|
+
} from '@pidginhost/sdk';
|
|
1709
|
+
|
|
1710
|
+
const configuration = new Configuration();
|
|
1711
|
+
const apiInstance = new CloudApi(configuration);
|
|
1712
|
+
|
|
1713
|
+
let id: number; //A unique integer value identifying this floating IPv6. (default to undefined)
|
|
1714
|
+
|
|
1715
|
+
const { status, data } = await apiInstance.cloudFloatingIpv6Destroy(
|
|
1716
|
+
id
|
|
1717
|
+
);
|
|
1718
|
+
```
|
|
1719
|
+
|
|
1720
|
+
### Parameters
|
|
1721
|
+
|
|
1722
|
+
|Name | Type | Description | Notes|
|
|
1723
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1724
|
+
| **id** | [**number**] | A unique integer value identifying this floating IPv6. | defaults to undefined|
|
|
1725
|
+
|
|
1726
|
+
|
|
1727
|
+
### Return type
|
|
1728
|
+
|
|
1729
|
+
void (empty response body)
|
|
1730
|
+
|
|
1731
|
+
### Authorization
|
|
1732
|
+
|
|
1733
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1734
|
+
|
|
1735
|
+
### HTTP request headers
|
|
1736
|
+
|
|
1737
|
+
- **Content-Type**: Not defined
|
|
1738
|
+
- **Accept**: Not defined
|
|
1739
|
+
|
|
1740
|
+
|
|
1741
|
+
### HTTP response details
|
|
1742
|
+
| Status code | Description | Response headers |
|
|
1743
|
+
|-------------|-------------|------------------|
|
|
1744
|
+
|**204** | No response body | - |
|
|
1745
|
+
|
|
1746
|
+
[[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)
|
|
1747
|
+
|
|
1748
|
+
# **cloudFloatingIpv6List**
|
|
1749
|
+
> PaginatedFloatingIPv6List cloudFloatingIpv6List()
|
|
1750
|
+
|
|
1751
|
+
Manage floating IPv6 addresses.
|
|
1752
|
+
|
|
1753
|
+
### Example
|
|
1754
|
+
|
|
1755
|
+
```typescript
|
|
1756
|
+
import {
|
|
1757
|
+
CloudApi,
|
|
1758
|
+
Configuration
|
|
1759
|
+
} from '@pidginhost/sdk';
|
|
1760
|
+
|
|
1761
|
+
const configuration = new Configuration();
|
|
1762
|
+
const apiInstance = new CloudApi(configuration);
|
|
1763
|
+
|
|
1764
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1765
|
+
|
|
1766
|
+
const { status, data } = await apiInstance.cloudFloatingIpv6List(
|
|
1767
|
+
page
|
|
1768
|
+
);
|
|
1769
|
+
```
|
|
1770
|
+
|
|
1771
|
+
### Parameters
|
|
1772
|
+
|
|
1773
|
+
|Name | Type | Description | Notes|
|
|
1774
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1775
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1776
|
+
|
|
1777
|
+
|
|
1778
|
+
### Return type
|
|
1779
|
+
|
|
1780
|
+
**PaginatedFloatingIPv6List**
|
|
1781
|
+
|
|
1782
|
+
### Authorization
|
|
1783
|
+
|
|
1784
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1785
|
+
|
|
1786
|
+
### HTTP request headers
|
|
1787
|
+
|
|
1788
|
+
- **Content-Type**: Not defined
|
|
1789
|
+
- **Accept**: application/json
|
|
1790
|
+
|
|
1791
|
+
|
|
1792
|
+
### HTTP response details
|
|
1793
|
+
| Status code | Description | Response headers |
|
|
1794
|
+
|-------------|-------------|------------------|
|
|
1795
|
+
|**200** | | - |
|
|
1796
|
+
|
|
1797
|
+
[[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)
|
|
1798
|
+
|
|
1799
|
+
# **cloudFloatingIpv6Retrieve**
|
|
1800
|
+
> FloatingIPv6 cloudFloatingIpv6Retrieve()
|
|
1801
|
+
|
|
1802
|
+
Manage floating IPv6 addresses.
|
|
1803
|
+
|
|
1804
|
+
### Example
|
|
1805
|
+
|
|
1806
|
+
```typescript
|
|
1807
|
+
import {
|
|
1808
|
+
CloudApi,
|
|
1809
|
+
Configuration
|
|
1810
|
+
} from '@pidginhost/sdk';
|
|
1811
|
+
|
|
1812
|
+
const configuration = new Configuration();
|
|
1813
|
+
const apiInstance = new CloudApi(configuration);
|
|
1814
|
+
|
|
1815
|
+
let id: number; //A unique integer value identifying this floating IPv6. (default to undefined)
|
|
1816
|
+
|
|
1817
|
+
const { status, data } = await apiInstance.cloudFloatingIpv6Retrieve(
|
|
1818
|
+
id
|
|
1819
|
+
);
|
|
1820
|
+
```
|
|
1821
|
+
|
|
1822
|
+
### Parameters
|
|
1823
|
+
|
|
1824
|
+
|Name | Type | Description | Notes|
|
|
1825
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1826
|
+
| **id** | [**number**] | A unique integer value identifying this floating IPv6. | defaults to undefined|
|
|
1827
|
+
|
|
1828
|
+
|
|
1829
|
+
### Return type
|
|
1830
|
+
|
|
1831
|
+
**FloatingIPv6**
|
|
1832
|
+
|
|
1833
|
+
### Authorization
|
|
1834
|
+
|
|
1835
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1836
|
+
|
|
1837
|
+
### HTTP request headers
|
|
1838
|
+
|
|
1839
|
+
- **Content-Type**: Not defined
|
|
1840
|
+
- **Accept**: application/json
|
|
1841
|
+
|
|
1842
|
+
|
|
1843
|
+
### HTTP response details
|
|
1844
|
+
| Status code | Description | Response headers |
|
|
1845
|
+
|-------------|-------------|------------------|
|
|
1846
|
+
|**200** | | - |
|
|
1847
|
+
|
|
1848
|
+
[[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)
|
|
1849
|
+
|
|
1850
|
+
# **cloudFloatingIpv6UnauthorizeCreate**
|
|
1851
|
+
> FloatingIPv6UnauthorizeResponse cloudFloatingIpv6UnauthorizeCreate(floatingIPAuthorizeRequest)
|
|
1852
|
+
|
|
1853
|
+
Manage floating IPv6 addresses.
|
|
1854
|
+
|
|
1855
|
+
### Example
|
|
1856
|
+
|
|
1857
|
+
```typescript
|
|
1858
|
+
import {
|
|
1859
|
+
CloudApi,
|
|
1860
|
+
Configuration,
|
|
1861
|
+
FloatingIPAuthorizeRequest
|
|
1862
|
+
} from '@pidginhost/sdk';
|
|
1863
|
+
|
|
1864
|
+
const configuration = new Configuration();
|
|
1865
|
+
const apiInstance = new CloudApi(configuration);
|
|
1866
|
+
|
|
1867
|
+
let id: number; //A unique integer value identifying this floating IPv6. (default to undefined)
|
|
1868
|
+
let floatingIPAuthorizeRequest: FloatingIPAuthorizeRequest; //
|
|
1869
|
+
|
|
1870
|
+
const { status, data } = await apiInstance.cloudFloatingIpv6UnauthorizeCreate(
|
|
1871
|
+
id,
|
|
1872
|
+
floatingIPAuthorizeRequest
|
|
1873
|
+
);
|
|
1874
|
+
```
|
|
1875
|
+
|
|
1876
|
+
### Parameters
|
|
1877
|
+
|
|
1878
|
+
|Name | Type | Description | Notes|
|
|
1879
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1880
|
+
| **floatingIPAuthorizeRequest** | **FloatingIPAuthorizeRequest**| | |
|
|
1881
|
+
| **id** | [**number**] | A unique integer value identifying this floating IPv6. | defaults to undefined|
|
|
1882
|
+
|
|
1883
|
+
|
|
1884
|
+
### Return type
|
|
1885
|
+
|
|
1886
|
+
**FloatingIPv6UnauthorizeResponse**
|
|
1887
|
+
|
|
1888
|
+
### Authorization
|
|
1889
|
+
|
|
1890
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1891
|
+
|
|
714
1892
|
### HTTP request headers
|
|
715
1893
|
|
|
716
1894
|
- **Content-Type**: application/json
|
|
@@ -2136,9 +3314,11 @@ import {
|
|
|
2136
3314
|
const configuration = new Configuration();
|
|
2137
3315
|
const apiInstance = new CloudApi(configuration);
|
|
2138
3316
|
|
|
3317
|
+
let generation: string; //Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible. (optional) (default to undefined)
|
|
2139
3318
|
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
2140
3319
|
|
|
2141
3320
|
const { status, data } = await apiInstance.cloudServerPackagesList(
|
|
3321
|
+
generation,
|
|
2142
3322
|
page
|
|
2143
3323
|
);
|
|
2144
3324
|
```
|
|
@@ -2147,6 +3327,7 @@ const { status, data } = await apiInstance.cloudServerPackagesList(
|
|
|
2147
3327
|
|
|
2148
3328
|
|Name | Type | Description | Notes|
|
|
2149
3329
|
|------------- | ------------- | ------------- | -------------|
|
|
3330
|
+
| **generation** | [**string**] | Filter packages available on the given hardware generation (slug). Excludes free-tier-only packages when the generation is not free-tier eligible. | (optional) defaults to undefined|
|
|
2150
3331
|
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
2151
3332
|
|
|
2152
3333
|
|