@pantechdynamic/sdk 0.1.0 → 0.2.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/CHANGELOG.md +19 -0
- package/README.md +28 -4
- package/dist/index.cjs +147 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1819 -156
- package/dist/index.d.ts +1819 -156
- package/dist/index.js +147 -2
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1185,7 +1185,7 @@ interface paths {
|
|
|
1185
1185
|
*
|
|
1186
1186
|
* Send an `Idempotency-Key`. A retry with the same key returns the original operation instead of making the change twice.
|
|
1187
1187
|
*
|
|
1188
|
-
* **Scope:** `write`.
|
|
1188
|
+
* **Scope:** `write`. Closing access never needs `delete`, even for an AI app.
|
|
1189
1189
|
*/
|
|
1190
1190
|
delete: operations["revokeSSHAccess"];
|
|
1191
1191
|
options?: never;
|
|
@@ -1950,7 +1950,9 @@ interface paths {
|
|
|
1950
1950
|
put?: never;
|
|
1951
1951
|
/**
|
|
1952
1952
|
* Upgrade a Kubernetes cluster
|
|
1953
|
-
* @description Moves the cluster to
|
|
1953
|
+
* @description Moves the cluster to one of its `available_upgrades` (the next patch, or the next minor version). Upgrades never happen on their own and never go down.
|
|
1954
|
+
*
|
|
1955
|
+
* Today every cluster runs the version it was created with: its `available_upgrades` is empty and an upgrade is refused with `409 KUBERNETES_UPGRADE_NOT_AVAILABLE`. To move to a newer version, create a new cluster on it and move your workloads.
|
|
1954
1956
|
*
|
|
1955
1957
|
* Returns `202 Accepted` with an `operation_id` (also in the `Location` header). The change happens in the background: poll `GET /public/v1/operations/{operation_id}`, or stream `/events`, until `status` is `succeeded` or `failed`; a failed operation carries a stable `failure.code` and a readable `failure.reason`.
|
|
1956
1958
|
*
|
|
@@ -1975,9 +1977,10 @@ interface paths {
|
|
|
1975
1977
|
get?: never;
|
|
1976
1978
|
put?: never;
|
|
1977
1979
|
/**
|
|
1978
|
-
*
|
|
1979
|
-
* @description
|
|
1980
|
-
*
|
|
1980
|
+
* Change the cluster's node plan
|
|
1981
|
+
* @description A cluster's node plan is set when it is created and cannot be changed: its nodes keep the size they were built with. Sending a different `node_plan` is refused with `409 KUBERNETES_NODE_PLAN_NOT_CHANGEABLE` and nothing is recorded or billed; sending the plan the cluster already runs changes nothing.
|
|
1982
|
+
*
|
|
1983
|
+
* For bigger nodes, add a node pool on the plan you need (`POST /public/v1/kubernetes-clusters/{cluster_id}/node-pools`), or create a new cluster on it and move your workloads there.
|
|
1981
1984
|
*
|
|
1982
1985
|
* Returns `202 Accepted` with an `operation_id` (also in the `Location` header). The change happens in the background: poll `GET /public/v1/operations/{operation_id}`, or stream `/events`, until `status` is `succeeded` or `failed`.
|
|
1983
1986
|
*
|
|
@@ -2003,7 +2006,7 @@ interface paths {
|
|
|
2003
2006
|
put?: never;
|
|
2004
2007
|
/**
|
|
2005
2008
|
* Upgrade Kubernetes cluster networking
|
|
2006
|
-
* @description
|
|
2009
|
+
* @description Changes the API server allow-list (`api_allowed_cidrs`). A cluster's `cni_plugin`, `pod_cidr` and `service_cidr` are set when it is created: sending a different value is refused with `409 KUBERNETES_NETWORK_NOT_CHANGEABLE`, and sending the current value again changes nothing.
|
|
2007
2010
|
*
|
|
2008
2011
|
* Returns `202 Accepted` with an `operation_id` (also in the `Location` header). The change happens in the background: poll `GET /public/v1/operations/{operation_id}`, or stream `/events`, until `status` is `succeeded` or `failed`.
|
|
2009
2012
|
*
|
|
@@ -3186,6 +3189,230 @@ interface paths {
|
|
|
3186
3189
|
patch?: never;
|
|
3187
3190
|
trace?: never;
|
|
3188
3191
|
};
|
|
3192
|
+
"/public/v1/cloud-connections": {
|
|
3193
|
+
parameters: {
|
|
3194
|
+
query?: never;
|
|
3195
|
+
header?: never;
|
|
3196
|
+
path?: never;
|
|
3197
|
+
cookie?: never;
|
|
3198
|
+
};
|
|
3199
|
+
/**
|
|
3200
|
+
* List cloud connections
|
|
3201
|
+
* @description Your organization's connections to other cloud accounts, newest first. Each carries its setup: the template that creates the read-only role in your account.
|
|
3202
|
+
*
|
|
3203
|
+
* **Scope:** `read`.
|
|
3204
|
+
*/
|
|
3205
|
+
get: operations["listCloudConnections"];
|
|
3206
|
+
put?: never;
|
|
3207
|
+
/**
|
|
3208
|
+
* Connect a cloud account
|
|
3209
|
+
* @description Starts a connection to an AWS account. Nothing is shared yet: the response's `setup` holds a CloudFormation template (and, when available, a one-click `quick_create_url`) that creates, in your AWS account, a read-only role only Pantech can assume, with short-lived tokens for this one connection. No access keys are ever sent to Pantech.
|
|
3210
|
+
*
|
|
3211
|
+
* Create the stack, then send its `RoleArn` output with `PATCH /public/v1/cloud-connections/{connection_id}`. At most 10 connections per organization. Owners and admins only.
|
|
3212
|
+
*
|
|
3213
|
+
* **Idempotency:** a retry with the same `Idempotency-Key` returns the connection the first request made; the same key with a different name returns `409 IDEMPOTENCY_CONFLICT`.
|
|
3214
|
+
*
|
|
3215
|
+
* **Scope:** `write`.
|
|
3216
|
+
*/
|
|
3217
|
+
post: operations["createCloudConnection"];
|
|
3218
|
+
delete?: never;
|
|
3219
|
+
options?: never;
|
|
3220
|
+
head?: never;
|
|
3221
|
+
patch?: never;
|
|
3222
|
+
trace?: never;
|
|
3223
|
+
};
|
|
3224
|
+
"/public/v1/cloud-connections/{connection_id}": {
|
|
3225
|
+
parameters: {
|
|
3226
|
+
query?: never;
|
|
3227
|
+
header?: never;
|
|
3228
|
+
path?: never;
|
|
3229
|
+
cookie?: never;
|
|
3230
|
+
};
|
|
3231
|
+
/**
|
|
3232
|
+
* Get a cloud connection
|
|
3233
|
+
* @description One connection, with its status and setup. `status` is `awaiting_role` until you send the role ARN, `verifying` while Pantech tries it, then `connected` or `failed` (see `failure`).
|
|
3234
|
+
*
|
|
3235
|
+
* **Scope:** `read`.
|
|
3236
|
+
*/
|
|
3237
|
+
get: operations["getCloudConnection"];
|
|
3238
|
+
put?: never;
|
|
3239
|
+
post?: never;
|
|
3240
|
+
/**
|
|
3241
|
+
* Disconnect a cloud account
|
|
3242
|
+
* @description Removes the connection and its scans from Pantech; migration plans made from it stay. To revoke access on the AWS side too, delete the CloudFormation stack. Disconnecting only takes access away, so it needs `write`, not `delete`. Owners and admins only.
|
|
3243
|
+
*
|
|
3244
|
+
* **Scope:** `write`.
|
|
3245
|
+
*/
|
|
3246
|
+
delete: operations["deleteCloudConnection"];
|
|
3247
|
+
options?: never;
|
|
3248
|
+
head?: never;
|
|
3249
|
+
/**
|
|
3250
|
+
* Update a cloud connection
|
|
3251
|
+
* @description Renames a connection, sets the role ARN your stack created, or retries a failed check (`retry: true`). Setting `role_arn` or `retry` queues a verification: Pantech assumes the role and reads which AWS account it belongs to, usually within a minute. Owners and admins only.
|
|
3252
|
+
*
|
|
3253
|
+
* **Scope:** `write`.
|
|
3254
|
+
*/
|
|
3255
|
+
patch: operations["updateCloudConnection"];
|
|
3256
|
+
trace?: never;
|
|
3257
|
+
};
|
|
3258
|
+
"/public/v1/cloud-connections/{connection_id}/scans": {
|
|
3259
|
+
parameters: {
|
|
3260
|
+
query?: never;
|
|
3261
|
+
header?: never;
|
|
3262
|
+
path?: never;
|
|
3263
|
+
cookie?: never;
|
|
3264
|
+
};
|
|
3265
|
+
/**
|
|
3266
|
+
* List scans
|
|
3267
|
+
* @description A connection's scans, newest first, without their inventories. The 10 newest finished scans are kept.
|
|
3268
|
+
*
|
|
3269
|
+
* **Scope:** `read`.
|
|
3270
|
+
*/
|
|
3271
|
+
get: operations["listCloudScans"];
|
|
3272
|
+
put?: never;
|
|
3273
|
+
/**
|
|
3274
|
+
* Scan a cloud account
|
|
3275
|
+
* @description Queues a read of everything the role can see: servers, disks, networks, firewall groups, public addresses, load balancers, databases, bucket names, users, SSH keys and the last three months of spend, in every enabled region. Follow it with `GET /public/v1/cloud-scans/{scan_id}` until `status` is `succeeded` or `failed`; most accounts take under five minutes. Reading spend costs USD 0.01 on your AWS bill. Owners and admins only.
|
|
3276
|
+
*
|
|
3277
|
+
* **Scope:** `write`.
|
|
3278
|
+
*/
|
|
3279
|
+
post: operations["startCloudScan"];
|
|
3280
|
+
delete?: never;
|
|
3281
|
+
options?: never;
|
|
3282
|
+
head?: never;
|
|
3283
|
+
patch?: never;
|
|
3284
|
+
trace?: never;
|
|
3285
|
+
};
|
|
3286
|
+
"/public/v1/cloud-scans/{scan_id}": {
|
|
3287
|
+
parameters: {
|
|
3288
|
+
query?: never;
|
|
3289
|
+
header?: never;
|
|
3290
|
+
path?: never;
|
|
3291
|
+
cookie?: never;
|
|
3292
|
+
};
|
|
3293
|
+
/**
|
|
3294
|
+
* Get a scan
|
|
3295
|
+
* @description A scan's status, what it found (`counts`, `cost`, `regions`), and the parts it could not read (`warnings`). Add `include=inventory` for every item it found. Names and tags in the inventory are your own text, returned unchanged.
|
|
3296
|
+
*
|
|
3297
|
+
* **Scope:** `read`.
|
|
3298
|
+
*/
|
|
3299
|
+
get: operations["getCloudScan"];
|
|
3300
|
+
put?: never;
|
|
3301
|
+
post?: never;
|
|
3302
|
+
delete?: never;
|
|
3303
|
+
options?: never;
|
|
3304
|
+
head?: never;
|
|
3305
|
+
patch?: never;
|
|
3306
|
+
trace?: never;
|
|
3307
|
+
};
|
|
3308
|
+
"/public/v1/migrations": {
|
|
3309
|
+
parameters: {
|
|
3310
|
+
query?: never;
|
|
3311
|
+
header?: never;
|
|
3312
|
+
path?: never;
|
|
3313
|
+
cookie?: never;
|
|
3314
|
+
};
|
|
3315
|
+
/**
|
|
3316
|
+
* List migrations
|
|
3317
|
+
* @description Your organization's migration plans, newest first, without their items or estimate.
|
|
3318
|
+
*
|
|
3319
|
+
* **Scope:** `read`.
|
|
3320
|
+
*/
|
|
3321
|
+
get: operations["listMigrations"];
|
|
3322
|
+
put?: never;
|
|
3323
|
+
/**
|
|
3324
|
+
* Plan a migration
|
|
3325
|
+
* @description Builds a plan from a scan that succeeded: each server, disk, network, firewall group, database, key and person mapped to its Pantech equivalent, sized against today's plans, with anything that cannot move yet flagged and explained. Nothing is created: the plan is something to review, edit and export. `region` defaults to the first Pantech region. At most 25 migrations per organization. Owners and admins only.
|
|
3326
|
+
*
|
|
3327
|
+
* The response includes a live price comparison: Pantech's monthly price for the planned servers, disks and networks next to the source account's average monthly bill.
|
|
3328
|
+
*
|
|
3329
|
+
* **Scope:** `write`.
|
|
3330
|
+
*/
|
|
3331
|
+
post: operations["createMigration"];
|
|
3332
|
+
delete?: never;
|
|
3333
|
+
options?: never;
|
|
3334
|
+
head?: never;
|
|
3335
|
+
patch?: never;
|
|
3336
|
+
trace?: never;
|
|
3337
|
+
};
|
|
3338
|
+
"/public/v1/migrations/{migration_id}": {
|
|
3339
|
+
parameters: {
|
|
3340
|
+
query?: never;
|
|
3341
|
+
header?: never;
|
|
3342
|
+
path?: never;
|
|
3343
|
+
cookie?: never;
|
|
3344
|
+
};
|
|
3345
|
+
/**
|
|
3346
|
+
* Get a migration
|
|
3347
|
+
* @description A plan with every item and a price comparison computed now, from current prices.
|
|
3348
|
+
*
|
|
3349
|
+
* **Scope:** `read`.
|
|
3350
|
+
*/
|
|
3351
|
+
get: operations["getMigration"];
|
|
3352
|
+
put?: never;
|
|
3353
|
+
post?: never;
|
|
3354
|
+
/**
|
|
3355
|
+
* Delete a migration
|
|
3356
|
+
* @description Deletes a plan. Nothing in Pantech or in your other cloud is touched. Owners and admins only.
|
|
3357
|
+
*
|
|
3358
|
+
* **Scope:** `write`. Destructive: an AI app's key also needs `delete`.
|
|
3359
|
+
*/
|
|
3360
|
+
delete: operations["deleteMigration"];
|
|
3361
|
+
options?: never;
|
|
3362
|
+
head?: never;
|
|
3363
|
+
/**
|
|
3364
|
+
* Rename a migration
|
|
3365
|
+
* @description Changes a plan's name. Owners and admins only.
|
|
3366
|
+
*
|
|
3367
|
+
* **Scope:** `write`.
|
|
3368
|
+
*/
|
|
3369
|
+
patch: operations["renameMigration"];
|
|
3370
|
+
trace?: never;
|
|
3371
|
+
};
|
|
3372
|
+
"/public/v1/migrations/{migration_id}/items": {
|
|
3373
|
+
parameters: {
|
|
3374
|
+
query?: never;
|
|
3375
|
+
header?: never;
|
|
3376
|
+
path?: never;
|
|
3377
|
+
cookie?: never;
|
|
3378
|
+
};
|
|
3379
|
+
get?: never;
|
|
3380
|
+
put?: never;
|
|
3381
|
+
post?: never;
|
|
3382
|
+
delete?: never;
|
|
3383
|
+
options?: never;
|
|
3384
|
+
head?: never;
|
|
3385
|
+
/**
|
|
3386
|
+
* Edit a plan item
|
|
3387
|
+
* @description Changes one item, named by its `key`: leave it out of the move (`excluded`), choose another plan (`plan_slug`, for servers and databases), a size (`storage_gb`, for disks and databases), an address range (`cidr`, for networks and subnets), or a person's `role` and `email`. Items flagged as unsupported stay unsupported. Owners and admins only.
|
|
3388
|
+
*
|
|
3389
|
+
* **Scope:** `write`.
|
|
3390
|
+
*/
|
|
3391
|
+
patch: operations["updateMigrationItem"];
|
|
3392
|
+
trace?: never;
|
|
3393
|
+
};
|
|
3394
|
+
"/public/v1/migrations/{migration_id}/terraform": {
|
|
3395
|
+
parameters: {
|
|
3396
|
+
query?: never;
|
|
3397
|
+
header?: never;
|
|
3398
|
+
path?: never;
|
|
3399
|
+
cookie?: never;
|
|
3400
|
+
};
|
|
3401
|
+
/**
|
|
3402
|
+
* Export a migration as Terraform
|
|
3403
|
+
* @description The plan's planned items as Terraform for the `Pantech-Dynamics/pantechdynamics` provider: `main.tf` and `variables.tf`. Values Pantech cannot know (the image to start from, an SSH key, disk offerings, database passwords) are variables without defaults. Review it, then run `terraform plan`.
|
|
3404
|
+
*
|
|
3405
|
+
* **Scope:** `read`.
|
|
3406
|
+
*/
|
|
3407
|
+
get: operations["exportMigrationTerraform"];
|
|
3408
|
+
put?: never;
|
|
3409
|
+
post?: never;
|
|
3410
|
+
delete?: never;
|
|
3411
|
+
options?: never;
|
|
3412
|
+
head?: never;
|
|
3413
|
+
patch?: never;
|
|
3414
|
+
trace?: never;
|
|
3415
|
+
};
|
|
3189
3416
|
}
|
|
3190
3417
|
interface components {
|
|
3191
3418
|
schemas: {
|
|
@@ -3223,7 +3450,7 @@ interface components {
|
|
|
3223
3450
|
* @default ingress
|
|
3224
3451
|
* @enum {string}
|
|
3225
3452
|
*/
|
|
3226
|
-
direction
|
|
3453
|
+
direction?: "ingress" | "egress";
|
|
3227
3454
|
/**
|
|
3228
3455
|
* @description `tcp`, `udp`, `icmp` or `all`.
|
|
3229
3456
|
* @enum {string}
|
|
@@ -3259,7 +3486,7 @@ interface components {
|
|
|
3259
3486
|
* @default allow
|
|
3260
3487
|
* @enum {string}
|
|
3261
3488
|
*/
|
|
3262
|
-
action
|
|
3489
|
+
action?: "allow" | "deny";
|
|
3263
3490
|
};
|
|
3264
3491
|
CreateInstanceRequest: {
|
|
3265
3492
|
/**
|
|
@@ -3316,6 +3543,12 @@ interface components {
|
|
|
3316
3543
|
tags?: {
|
|
3317
3544
|
[key: string]: string;
|
|
3318
3545
|
};
|
|
3546
|
+
/**
|
|
3547
|
+
* @description Installs the Pantech agent when the instance first boots and connects it to your organization, so agent sessions (`POST /public/v1/instances/{instance_id}/agent-sessions`) can start with no login to the instance. The agent connects out; nothing is opened on the instance. Set at creation only.
|
|
3548
|
+
* @default false
|
|
3549
|
+
* @example true
|
|
3550
|
+
*/
|
|
3551
|
+
agent_enabled?: boolean;
|
|
3319
3552
|
};
|
|
3320
3553
|
CreateNetworkRequest: {
|
|
3321
3554
|
/**
|
|
@@ -3341,12 +3574,18 @@ interface components {
|
|
|
3341
3574
|
*/
|
|
3342
3575
|
name: string;
|
|
3343
3576
|
/**
|
|
3344
|
-
* @description The zone to place the load balancer in.
|
|
3345
|
-
* @example
|
|
3577
|
+
* @description The zone to place the load balancer in, by its code as `GET /public/v1/regions` lists it.
|
|
3578
|
+
* @example af-abj-1
|
|
3346
3579
|
*/
|
|
3347
3580
|
zone_id?: string;
|
|
3348
3581
|
/**
|
|
3349
|
-
* @description
|
|
3582
|
+
* @description The listener protocol. Only `tcp` is offered: HTTP and HTTPS are balanced as `tcp` and reach your instances unchanged, so serve TLS on the instances. Anything else is `422 LOAD_BALANCER_PROTOCOL_NOT_SUPPORTED`.
|
|
3583
|
+
* @default tcp
|
|
3584
|
+
* @enum {string}
|
|
3585
|
+
*/
|
|
3586
|
+
protocol?: "tcp";
|
|
3587
|
+
/**
|
|
3588
|
+
* @description `vpc_native` (a VPC zone: needs `public_ip_id` and `subnet_id`) or `appliance` (a standard zone: needs `zone_id`; a load balancer VM with its own public address, billed as that VM). Left out, it is `vpc_native` when `subnet_id` is given and `appliance` when only `zone_id` is. Anything else is `422 INVALID_LOAD_BALANCER_KIND`; an appliance in a zone that does not offer one fails its operation with `LOAD_BALANCER_APPLIANCE_UNAVAILABLE`, and one whose load balancer never starts serving fails it with `LOAD_BALANCER_APPLIANCE_NOT_READY` and is removed.
|
|
3350
3589
|
* @enum {string}
|
|
3351
3590
|
*/
|
|
3352
3591
|
kind?: "vpc_native" | "appliance";
|
|
@@ -3365,7 +3604,7 @@ interface components {
|
|
|
3365
3604
|
* @default roundrobin
|
|
3366
3605
|
* @enum {string}
|
|
3367
3606
|
*/
|
|
3368
|
-
algorithm
|
|
3607
|
+
algorithm?: "roundrobin" | "leastconn" | "source";
|
|
3369
3608
|
/**
|
|
3370
3609
|
* @description The TCP port clients connect to, 1 to 65535.
|
|
3371
3610
|
* @example 443
|
|
@@ -3426,6 +3665,10 @@ interface components {
|
|
|
3426
3665
|
/** @description e.g. `lb_...`. */
|
|
3427
3666
|
id: string;
|
|
3428
3667
|
name: string;
|
|
3668
|
+
/**
|
|
3669
|
+
* @description The zone's code, as `GET /public/v1/regions` lists it.
|
|
3670
|
+
* @example af-abj-1
|
|
3671
|
+
*/
|
|
3429
3672
|
zone_id: string;
|
|
3430
3673
|
/** @enum {string} */
|
|
3431
3674
|
kind: "vpc_native" | "appliance";
|
|
@@ -3492,7 +3735,7 @@ interface components {
|
|
|
3492
3735
|
* @example prod-web
|
|
3493
3736
|
*/
|
|
3494
3737
|
name: string;
|
|
3495
|
-
/** @example
|
|
3738
|
+
/** @example af-abj-2 */
|
|
3496
3739
|
zone_id: string;
|
|
3497
3740
|
/**
|
|
3498
3741
|
* @description From the Kubernetes versions list, in `zone_id`.
|
|
@@ -3505,7 +3748,7 @@ interface components {
|
|
|
3505
3748
|
*/
|
|
3506
3749
|
subnet_id?: string;
|
|
3507
3750
|
/**
|
|
3508
|
-
* @description The plan slug every node uses, from the plans list. In a zone where every node has one fixed size (af-abj-2: 2 vCPU, 4 GB), the plan must be that size: `422 KUBERNETES_PLAN_NOT_IN_ZONE` on `node_plan`.
|
|
3751
|
+
* @description The plan slug every node uses, from the plans list. In a zone where every node has one fixed size (af-abj-2: 2 vCPU, 4 GB), the plan must be that size: `422 KUBERNETES_PLAN_NOT_IN_ZONE` on `node_plan`. Fixed once the cluster is created: for bigger nodes later, add a node pool.
|
|
3509
3752
|
* @example s-2vcpu-4gb
|
|
3510
3753
|
*/
|
|
3511
3754
|
node_plan: string;
|
|
@@ -3514,7 +3757,7 @@ interface components {
|
|
|
3514
3757
|
* @default 1
|
|
3515
3758
|
* @enum {integer}
|
|
3516
3759
|
*/
|
|
3517
|
-
control_nodes
|
|
3760
|
+
control_nodes?: 1 | 3;
|
|
3518
3761
|
/**
|
|
3519
3762
|
* @description Worker nodes, 1 to 10. Required unless `autoscaling` is enabled, when it defaults to `min_workers` and must lie within the range.
|
|
3520
3763
|
* @example 2
|
|
@@ -3535,27 +3778,27 @@ interface components {
|
|
|
3535
3778
|
*/
|
|
3536
3779
|
kind?: "appliance";
|
|
3537
3780
|
/**
|
|
3538
|
-
* @description CNI backend plugin (`flannel`, `wireguard`, or `calico`). Defaults to `flannel`.
|
|
3781
|
+
* @description CNI backend plugin (`flannel`, `wireguard`, or `calico`). Defaults to `flannel`. Cannot be changed after creation.
|
|
3539
3782
|
* @example flannel
|
|
3540
3783
|
*/
|
|
3541
3784
|
cni_plugin?: string;
|
|
3542
3785
|
/**
|
|
3543
|
-
* @description IPv4 CIDR range allocated for cluster pods.
|
|
3786
|
+
* @description IPv4 CIDR range allocated for cluster pods. It must not overlap the cluster's VPC network, its subnet or `service_cidr` (`422 KUBERNETES_POD_CIDR_OVERLAP`). Left out, the first of `10.42.0.0/16`, `10.244.0.0/16`, `172.20.0.0/16` and `192.168.0.0/17` clear of those is used. Cannot be changed after creation.
|
|
3544
3787
|
* @example 10.42.0.0/16
|
|
3545
3788
|
*/
|
|
3546
3789
|
pod_cidr?: string;
|
|
3547
3790
|
/**
|
|
3548
|
-
* @description IPv4 CIDR range allocated for cluster services.
|
|
3791
|
+
* @description IPv4 CIDR range allocated for cluster services. It must not overlap the cluster's VPC network, its subnet or `pod_cidr` (`422 KUBERNETES_SERVICE_CIDR_OVERLAP`). Left out, the first of `10.43.0.0/16`, `10.96.0.0/16`, `172.21.0.0/16` and `192.168.128.0/17` clear of those is used. Cannot be changed after creation.
|
|
3549
3792
|
* @example 10.43.0.0/16
|
|
3550
3793
|
*/
|
|
3551
3794
|
service_cidr?: string;
|
|
3552
3795
|
/**
|
|
3553
|
-
* @description Who can reach the API server. `private` (the default) is reachable only from inside the VPC. `public` and `dual` give the API server a public address of its own, billed as a VPC public IP for every hour it is held.
|
|
3796
|
+
* @description Who can reach the API server. `private` (the default) is reachable only from inside the VPC. `public` and `dual` give the API server a public address of its own, billed as a VPC public IP for every hour it is held, and open its port 6443 on the subnet's network rules to `api_allowed_cidrs` (any address when that is empty). Those rules are numbered from 30000, after your own firewall rules, so a deny rule of yours still applies first; they are removed when the cluster goes private or is deleted.
|
|
3554
3797
|
* @default private
|
|
3555
3798
|
* @example private
|
|
3556
3799
|
* @enum {string}
|
|
3557
3800
|
*/
|
|
3558
|
-
endpoint_access
|
|
3801
|
+
endpoint_access?: "private" | "public" | "dual";
|
|
3559
3802
|
};
|
|
3560
3803
|
/** @description The platform's autoscaler: about once a minute it adds a worker when a pod that a worker could run is waiting for room, and removes the newest worker once it has run nothing but DaemonSet pods for 10 minutes, one step at a time and always within min_workers and max_workers. You pay for the workers that run. */
|
|
3561
3804
|
KubernetesAutoscaling: {
|
|
@@ -3604,17 +3847,17 @@ interface components {
|
|
|
3604
3847
|
};
|
|
3605
3848
|
UpgradeKubernetesNetworkRequest: {
|
|
3606
3849
|
/**
|
|
3607
|
-
* @description The new CNI plugin (`flannel`, `wireguard`, or `calico`).
|
|
3850
|
+
* @description The new CNI plugin (`flannel`, `wireguard`, or `calico`). Fixed at creation: a value different from the cluster's current one is `409 KUBERNETES_NETWORK_NOT_CHANGEABLE`.
|
|
3608
3851
|
* @example wireguard
|
|
3609
3852
|
*/
|
|
3610
3853
|
cni_plugin?: string;
|
|
3611
3854
|
/**
|
|
3612
|
-
* @description The new IPv4 CIDR range allocated for cluster pods.
|
|
3855
|
+
* @description The new IPv4 CIDR range allocated for cluster pods. Fixed at creation: a value different from the cluster's current one is `409 KUBERNETES_NETWORK_NOT_CHANGEABLE`.
|
|
3613
3856
|
* @example 10.42.0.0/16
|
|
3614
3857
|
*/
|
|
3615
3858
|
pod_cidr?: string;
|
|
3616
3859
|
/**
|
|
3617
|
-
* @description The new IPv4 CIDR range allocated for cluster services.
|
|
3860
|
+
* @description The new IPv4 CIDR range allocated for cluster services. Fixed at creation: a value different from the cluster's current one is `409 KUBERNETES_NETWORK_NOT_CHANGEABLE`.
|
|
3618
3861
|
* @example 10.43.0.0/16
|
|
3619
3862
|
*/
|
|
3620
3863
|
service_cidr?: string;
|
|
@@ -3659,7 +3902,7 @@ interface components {
|
|
|
3659
3902
|
in_sync: boolean;
|
|
3660
3903
|
failure_code: string | null;
|
|
3661
3904
|
failure_reason: string | null;
|
|
3662
|
-
/** @description Versions this cluster can be upgraded to now. */
|
|
3905
|
+
/** @description Versions this cluster can be upgraded to now. Empty for a cluster that runs the version it was created with, which is every cluster today. */
|
|
3663
3906
|
available_upgrades: components["schemas"]["KubernetesVersion"][];
|
|
3664
3907
|
autoscaling: components["schemas"]["KubernetesAutoscaling"];
|
|
3665
3908
|
/** @description Sources allowed to reach the API server; empty is any address. */
|
|
@@ -3676,6 +3919,24 @@ interface components {
|
|
|
3676
3919
|
* @example 6443
|
|
3677
3920
|
*/
|
|
3678
3921
|
public_port?: number | null;
|
|
3922
|
+
/**
|
|
3923
|
+
* @description What Kubernetes last reported of the cluster's nodes while it runs: `healthy` (every node Ready), `degraded` (a node is NotReady, or fewer are Ready than the cluster should run) or `unknown` (the nodes could not be read in the last 15 minutes, for example a private endpoint whose agent is not connected). Read about every 5 minutes; null while the cluster is not running. Always `degraded`, with `node_health_reason`, while the cluster's pod or service range overlaps its own network.
|
|
3924
|
+
* @example healthy
|
|
3925
|
+
* @enum {string|null}
|
|
3926
|
+
*/
|
|
3927
|
+
node_health?: "healthy" | "degraded" | "unknown" | null;
|
|
3928
|
+
/** @description Why `node_health` is `degraded` when the cause is the cluster itself rather than a node's last reading: its `pod_cidr` or `service_cidr` overlaps the network its nodes are on (possible only for a cluster created before such ranges were refused). The ranges are fixed at creation, so the fix is a new cluster. Null otherwise. */
|
|
3929
|
+
node_health_reason?: string | null;
|
|
3930
|
+
/**
|
|
3931
|
+
* @description Nodes Kubernetes reports Ready, as of `nodes_checked_at`; null when `node_health` is unknown or null.
|
|
3932
|
+
* @example 2
|
|
3933
|
+
*/
|
|
3934
|
+
ready_nodes?: number | null;
|
|
3935
|
+
/**
|
|
3936
|
+
* Format: date-time
|
|
3937
|
+
* @description When the nodes were last read; null if never.
|
|
3938
|
+
*/
|
|
3939
|
+
nodes_checked_at?: string | null;
|
|
3679
3940
|
/** @description Storage your workloads' persistent volume claims use, billed with the nodes' disks. */
|
|
3680
3941
|
volume_storage_gb: number;
|
|
3681
3942
|
/**
|
|
@@ -3768,7 +4029,7 @@ interface components {
|
|
|
3768
4029
|
/** @description Worker nodes, 1 to 10. Required unless autoscaling_enabled, when it defaults to min_workers. */
|
|
3769
4030
|
workers?: number;
|
|
3770
4031
|
/** @default false */
|
|
3771
|
-
autoscaling_enabled
|
|
4032
|
+
autoscaling_enabled?: boolean;
|
|
3772
4033
|
/** @description With autoscaling_enabled: fewest workers, 1 to 10. */
|
|
3773
4034
|
min_workers?: number;
|
|
3774
4035
|
/** @description With autoscaling_enabled: most workers, min_workers to 10. Your credit and limits are checked for this many. */
|
|
@@ -3810,7 +4071,7 @@ interface components {
|
|
|
3810
4071
|
};
|
|
3811
4072
|
ConfigureKubernetesEndpointAccessRequest: {
|
|
3812
4073
|
/**
|
|
3813
|
-
* @description Endpoint access mode.
|
|
4074
|
+
* @description Endpoint access mode. `public` and `dual` open the API server's port 6443 on the subnet's network rules to `api_allowed_cidrs` (any address when empty); `private` removes those rules. The change is in sync (`in_sync` true) once the cluster is routed on its public address, or that address is released.
|
|
3814
4075
|
* @enum {string}
|
|
3815
4076
|
*/
|
|
3816
4077
|
endpoint_access: "public" | "private" | "dual";
|
|
@@ -3860,7 +4121,7 @@ interface components {
|
|
|
3860
4121
|
* @default static_nat
|
|
3861
4122
|
* @enum {string}
|
|
3862
4123
|
*/
|
|
3863
|
-
purpose
|
|
4124
|
+
purpose?: "static_nat" | "port_forwarding" | "load_balancer";
|
|
3864
4125
|
/**
|
|
3865
4126
|
* @description For `static_nat` only: an instance in `network_id` without a public IP. Leave it out to reserve the address now and attach it later (`POST /public/v1/public-ips/{public_ip_id}/attach`). Leave out for `port_forwarding` and `load_balancer`.
|
|
3866
4127
|
* @example vm_06gk3x9tq7m2v8r4y1c5d0zp8w
|
|
@@ -4002,7 +4263,7 @@ interface components {
|
|
|
4002
4263
|
* @default dbadmin
|
|
4003
4264
|
* @example app_admin
|
|
4004
4265
|
*/
|
|
4005
|
-
admin_username
|
|
4266
|
+
admin_username?: string;
|
|
4006
4267
|
/**
|
|
4007
4268
|
* @description Optional admin password: 16 to 128 printable ASCII characters, with no spaces, single quotes (`'`), double quotes (`"`) or backslashes (`\`). Write-only: never stored in plain text, never returned, never logged. Leave it out to have a 32-character password generated and returned once in the response.
|
|
4008
4269
|
* @example c0rrect-H0rse-battery-St4ple
|
|
@@ -5042,12 +5303,12 @@ interface components {
|
|
|
5042
5303
|
* @description How many successful automatic snapshots to keep, 1 to 168; older ones are deleted. Defaults to 7.
|
|
5043
5304
|
* @default 7
|
|
5044
5305
|
*/
|
|
5045
|
-
retention_count
|
|
5306
|
+
retention_count?: number;
|
|
5046
5307
|
/**
|
|
5047
5308
|
* @description False pauses the schedule without forgetting it. Defaults to true.
|
|
5048
5309
|
* @default true
|
|
5049
5310
|
*/
|
|
5050
|
-
enabled
|
|
5311
|
+
enabled?: boolean;
|
|
5051
5312
|
};
|
|
5052
5313
|
RebuildRequest: {
|
|
5053
5314
|
/**
|
|
@@ -5791,47 +6052,415 @@ interface components {
|
|
|
5791
6052
|
/** @description Always null: this list is returned whole. */
|
|
5792
6053
|
next_cursor: string | null;
|
|
5793
6054
|
};
|
|
5794
|
-
|
|
5795
|
-
|
|
5796
|
-
|
|
5797
|
-
|
|
5798
|
-
|
|
5799
|
-
|
|
5800
|
-
|
|
5801
|
-
|
|
5802
|
-
|
|
5803
|
-
|
|
5804
|
-
|
|
6055
|
+
/** @description Why the last check or scan failed; null when it didn't. */
|
|
6056
|
+
CloudFailure: {
|
|
6057
|
+
/** @enum {string} */
|
|
6058
|
+
code: "assume_role_denied" | "permission_missing" | "provider_unavailable" | "scan_too_large" | "internal";
|
|
6059
|
+
/** @description What to do about it. */
|
|
6060
|
+
message: string;
|
|
6061
|
+
} | null;
|
|
6062
|
+
/** @description What you need to create the role in your account. */
|
|
6063
|
+
CloudConnectionSetup: {
|
|
6064
|
+
/** @description Pantech's identity provider URL, which your role trusts. */
|
|
6065
|
+
issuer_url: string;
|
|
6066
|
+
/** @description The audience every token carries. */
|
|
6067
|
+
audience: string;
|
|
6068
|
+
/** @description The subject your role requires: this connection's id. */
|
|
6069
|
+
subject: string;
|
|
6070
|
+
/** @description Opens AWS's create-stack page with this template and connection filled in; null when not offered. */
|
|
6071
|
+
quick_create_url: string | null;
|
|
6072
|
+
/** @description A CloudFormation template (JSON) for this connection: a read-only role and, unless one exists, the identity provider. */
|
|
6073
|
+
template: string;
|
|
6074
|
+
};
|
|
6075
|
+
CloudConnection: {
|
|
6076
|
+
/** @example ccn_06gk3x9tq7m2v8r4y1c5d0zp8w */
|
|
6077
|
+
id: string;
|
|
6078
|
+
/** @enum {string} */
|
|
6079
|
+
provider: "aws";
|
|
6080
|
+
name: string;
|
|
6081
|
+
/**
|
|
6082
|
+
* @description `awaiting_role`, `verifying`, `connected` or `failed`.
|
|
6083
|
+
* @enum {string}
|
|
6084
|
+
*/
|
|
6085
|
+
status: "awaiting_role" | "verifying" | "connected" | "failed";
|
|
6086
|
+
failure: components["schemas"]["CloudFailure"];
|
|
6087
|
+
role_arn: string | null;
|
|
6088
|
+
aws_account_id: string | null;
|
|
6089
|
+
/** Format: date-time */
|
|
6090
|
+
verified_at: string | null;
|
|
6091
|
+
/** Format: date-time */
|
|
6092
|
+
created_at: string;
|
|
6093
|
+
/** Format: date-time */
|
|
6094
|
+
updated_at: string;
|
|
6095
|
+
setup: components["schemas"]["CloudConnectionSetup"];
|
|
5805
6096
|
};
|
|
5806
|
-
|
|
5807
|
-
|
|
5808
|
-
|
|
5809
|
-
|
|
5810
|
-
*/
|
|
5811
|
-
Forbidden: {
|
|
5812
|
-
headers: {
|
|
5813
|
-
[name: string]: unknown;
|
|
5814
|
-
};
|
|
5815
|
-
content: {
|
|
5816
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
5817
|
-
};
|
|
6097
|
+
CloudConnectionList: {
|
|
6098
|
+
data: components["schemas"]["CloudConnection"][];
|
|
6099
|
+
/** @description Always null: this list is returned whole. */
|
|
6100
|
+
next_cursor: string | null;
|
|
5818
6101
|
};
|
|
5819
|
-
|
|
5820
|
-
|
|
5821
|
-
|
|
5822
|
-
|
|
5823
|
-
|
|
5824
|
-
|
|
5825
|
-
|
|
5826
|
-
|
|
6102
|
+
CreateCloudConnectionRequest: {
|
|
6103
|
+
/**
|
|
6104
|
+
* @description `aws`, the default.
|
|
6105
|
+
* @enum {string}
|
|
6106
|
+
*/
|
|
6107
|
+
provider?: "aws";
|
|
6108
|
+
/** @description 1 to 100 characters, for example `Production AWS`. */
|
|
6109
|
+
name: string;
|
|
5827
6110
|
};
|
|
5828
|
-
|
|
5829
|
-
|
|
5830
|
-
|
|
5831
|
-
|
|
5832
|
-
|
|
5833
|
-
|
|
5834
|
-
|
|
6111
|
+
UpdateCloudConnectionRequest: {
|
|
6112
|
+
name?: string;
|
|
6113
|
+
/** @description The stack's RoleArn output. */
|
|
6114
|
+
role_arn?: string;
|
|
6115
|
+
/** @description Check the role again. */
|
|
6116
|
+
retry?: boolean;
|
|
6117
|
+
};
|
|
6118
|
+
CloudScanCounts: {
|
|
6119
|
+
instances: number;
|
|
6120
|
+
volumes: number;
|
|
6121
|
+
networks: number;
|
|
6122
|
+
subnets: number;
|
|
6123
|
+
security_groups: number;
|
|
6124
|
+
public_ips: number;
|
|
6125
|
+
load_balancers: number;
|
|
6126
|
+
databases: number;
|
|
6127
|
+
buckets: number;
|
|
6128
|
+
users: number;
|
|
6129
|
+
ssh_keys: number;
|
|
6130
|
+
} | null;
|
|
6131
|
+
CloudCostMonth: {
|
|
6132
|
+
/** @description YYYY-MM. */
|
|
6133
|
+
month: string;
|
|
6134
|
+
amount_minor: number;
|
|
6135
|
+
};
|
|
6136
|
+
/** @description The source account's whole bill, every service. */
|
|
6137
|
+
CloudCost: {
|
|
6138
|
+
currency: string;
|
|
6139
|
+
/** @description Average of the months, in minor units of currency. */
|
|
6140
|
+
average_monthly_minor: number;
|
|
6141
|
+
months: components["schemas"]["CloudCostMonth"][];
|
|
6142
|
+
} | null;
|
|
6143
|
+
CloudScan: {
|
|
6144
|
+
/** @example csn_06gk3x9tq7m2v8r4y1c5d0zp8w */
|
|
6145
|
+
id: string;
|
|
6146
|
+
connection_id: string;
|
|
6147
|
+
/** @enum {string} */
|
|
6148
|
+
status: "queued" | "running" | "succeeded" | "failed";
|
|
6149
|
+
failure: components["schemas"]["CloudFailure"];
|
|
6150
|
+
/** Format: date-time */
|
|
6151
|
+
created_at: string;
|
|
6152
|
+
/** Format: date-time */
|
|
6153
|
+
started_at: string | null;
|
|
6154
|
+
/** Format: date-time */
|
|
6155
|
+
finished_at: string | null;
|
|
6156
|
+
aws_account_id: string | null;
|
|
6157
|
+
/** @description Regions read. */
|
|
6158
|
+
regions: string[];
|
|
6159
|
+
counts: components["schemas"]["CloudScanCounts"];
|
|
6160
|
+
cost: components["schemas"]["CloudCost"];
|
|
6161
|
+
/** @description Parts not read, e.g. `cost_unavailable` or `region_denied:eu-south-1`. */
|
|
6162
|
+
warnings: string[];
|
|
6163
|
+
/** @description Kinds cut at 2,000 items. */
|
|
6164
|
+
truncated: string[];
|
|
6165
|
+
inventory: components["schemas"]["CloudInventory"];
|
|
6166
|
+
};
|
|
6167
|
+
CloudScanList: {
|
|
6168
|
+
data: components["schemas"]["CloudScan"][];
|
|
6169
|
+
/** @description Always null: this list is returned whole. */
|
|
6170
|
+
next_cursor: string | null;
|
|
6171
|
+
};
|
|
6172
|
+
MigrationListener: {
|
|
6173
|
+
protocol: string;
|
|
6174
|
+
port: number;
|
|
6175
|
+
};
|
|
6176
|
+
/** @description Everything a scan found. */
|
|
6177
|
+
CloudInventory: {
|
|
6178
|
+
instances: {
|
|
6179
|
+
id: string;
|
|
6180
|
+
name: string | null;
|
|
6181
|
+
region: string;
|
|
6182
|
+
zone: string | null;
|
|
6183
|
+
instance_type: string;
|
|
6184
|
+
state: string;
|
|
6185
|
+
vcpu: number | null;
|
|
6186
|
+
memory_mib: number | null;
|
|
6187
|
+
architecture: string;
|
|
6188
|
+
platform: string;
|
|
6189
|
+
volume_ids: string[];
|
|
6190
|
+
network_id: string | null;
|
|
6191
|
+
subnet_id: string | null;
|
|
6192
|
+
security_group_ids: string[];
|
|
6193
|
+
public_ip: string | null;
|
|
6194
|
+
private_ip: string | null;
|
|
6195
|
+
key_name: string | null;
|
|
6196
|
+
/** Format: date-time */
|
|
6197
|
+
launched_at: string | null;
|
|
6198
|
+
}[];
|
|
6199
|
+
volumes: {
|
|
6200
|
+
id: string;
|
|
6201
|
+
region: string;
|
|
6202
|
+
zone: string | null;
|
|
6203
|
+
type: string;
|
|
6204
|
+
size_gb: number;
|
|
6205
|
+
attached_to: string | null;
|
|
6206
|
+
device: string | null;
|
|
6207
|
+
encrypted: boolean;
|
|
6208
|
+
}[];
|
|
6209
|
+
networks: {
|
|
6210
|
+
id: string;
|
|
6211
|
+
region: string;
|
|
6212
|
+
name: string | null;
|
|
6213
|
+
cidr: string;
|
|
6214
|
+
is_default: boolean;
|
|
6215
|
+
}[];
|
|
6216
|
+
subnets: {
|
|
6217
|
+
id: string;
|
|
6218
|
+
region: string;
|
|
6219
|
+
network_id: string;
|
|
6220
|
+
name: string | null;
|
|
6221
|
+
cidr: string;
|
|
6222
|
+
zone: string | null;
|
|
6223
|
+
maps_public_ip: boolean;
|
|
6224
|
+
}[];
|
|
6225
|
+
security_groups: {
|
|
6226
|
+
id: string;
|
|
6227
|
+
region: string;
|
|
6228
|
+
network_id: string | null;
|
|
6229
|
+
name: string;
|
|
6230
|
+
description: string | null;
|
|
6231
|
+
rules: {
|
|
6232
|
+
/** @enum {string} */
|
|
6233
|
+
direction: "ingress" | "egress";
|
|
6234
|
+
protocol: string;
|
|
6235
|
+
from_port: number | null;
|
|
6236
|
+
to_port: number | null;
|
|
6237
|
+
cidr: string | null;
|
|
6238
|
+
ipv6_cidr: string | null;
|
|
6239
|
+
source_group_id: string | null;
|
|
6240
|
+
prefix_list_id: string | null;
|
|
6241
|
+
}[];
|
|
6242
|
+
}[];
|
|
6243
|
+
public_ips: {
|
|
6244
|
+
id: string;
|
|
6245
|
+
region: string;
|
|
6246
|
+
address: string;
|
|
6247
|
+
instance_id: string | null;
|
|
6248
|
+
}[];
|
|
6249
|
+
load_balancers: {
|
|
6250
|
+
id: string;
|
|
6251
|
+
region: string;
|
|
6252
|
+
name: string;
|
|
6253
|
+
type: string;
|
|
6254
|
+
scheme: string;
|
|
6255
|
+
network_id: string | null;
|
|
6256
|
+
listeners: components["schemas"]["MigrationListener"][];
|
|
6257
|
+
}[];
|
|
6258
|
+
databases: {
|
|
6259
|
+
id: string;
|
|
6260
|
+
region: string;
|
|
6261
|
+
engine: string;
|
|
6262
|
+
engine_version: string;
|
|
6263
|
+
instance_class: string;
|
|
6264
|
+
vcpu: number | null;
|
|
6265
|
+
memory_mib: number | null;
|
|
6266
|
+
storage_gb: number;
|
|
6267
|
+
multi_az: boolean;
|
|
6268
|
+
publicly_accessible: boolean;
|
|
6269
|
+
}[];
|
|
6270
|
+
buckets: {
|
|
6271
|
+
name: string;
|
|
6272
|
+
region: string | null;
|
|
6273
|
+
/** Format: date-time */
|
|
6274
|
+
created_at: string | null;
|
|
6275
|
+
}[];
|
|
6276
|
+
users: {
|
|
6277
|
+
name: string;
|
|
6278
|
+
email: string | null;
|
|
6279
|
+
is_admin: boolean;
|
|
6280
|
+
/** Format: date-time */
|
|
6281
|
+
created_at: string | null;
|
|
6282
|
+
}[];
|
|
6283
|
+
ssh_keys: {
|
|
6284
|
+
name: string;
|
|
6285
|
+
region: string;
|
|
6286
|
+
fingerprint: string | null;
|
|
6287
|
+
public_key: string | null;
|
|
6288
|
+
}[];
|
|
6289
|
+
} | null;
|
|
6290
|
+
MigrationFlag: {
|
|
6291
|
+
code: string;
|
|
6292
|
+
message: string;
|
|
6293
|
+
/** @description A blocking flag makes the item unsupported. */
|
|
6294
|
+
blocking: boolean;
|
|
6295
|
+
};
|
|
6296
|
+
MigrationRule: {
|
|
6297
|
+
/** @enum {string} */
|
|
6298
|
+
direction: "ingress" | "egress";
|
|
6299
|
+
/** @enum {string} */
|
|
6300
|
+
protocol: "tcp" | "udp" | "icmp" | "all";
|
|
6301
|
+
port_range: string | null;
|
|
6302
|
+
cidr: string;
|
|
6303
|
+
};
|
|
6304
|
+
/** @description What the item becomes on Pantech; fields that don't apply to its kind are null or empty. */
|
|
6305
|
+
MigrationItemTarget: {
|
|
6306
|
+
plan_slug: string | null;
|
|
6307
|
+
disk_gb: number | null;
|
|
6308
|
+
cidr: string | null;
|
|
6309
|
+
network_key: string | null;
|
|
6310
|
+
subnet_key: string | null;
|
|
6311
|
+
instance_key: string | null;
|
|
6312
|
+
rules: components["schemas"]["MigrationRule"][];
|
|
6313
|
+
engine: string | null;
|
|
6314
|
+
engine_version: string | null;
|
|
6315
|
+
storage_gb: number | null;
|
|
6316
|
+
/** @enum {string|null} */
|
|
6317
|
+
role: "admin" | "member" | null;
|
|
6318
|
+
email: string | null;
|
|
6319
|
+
public_key: string | null;
|
|
6320
|
+
listeners: components["schemas"]["MigrationListener"][];
|
|
6321
|
+
};
|
|
6322
|
+
MigrationItemSource: {
|
|
6323
|
+
id: string;
|
|
6324
|
+
name: string | null;
|
|
6325
|
+
region: string | null;
|
|
6326
|
+
summary: string;
|
|
6327
|
+
vcpu: number | null;
|
|
6328
|
+
memory_mib: number | null;
|
|
6329
|
+
disk_gb: number | null;
|
|
6330
|
+
};
|
|
6331
|
+
MigrationItem: {
|
|
6332
|
+
/** @description Stable across edits: kind, region and the source id. */
|
|
6333
|
+
key: string;
|
|
6334
|
+
/** @enum {string} */
|
|
6335
|
+
kind: "network" | "subnet" | "security_group" | "instance" | "volume" | "public_ip" | "load_balancer" | "database" | "ssh_key" | "user" | "bucket";
|
|
6336
|
+
source: components["schemas"]["MigrationItemSource"];
|
|
6337
|
+
/** @enum {string} */
|
|
6338
|
+
status: "planned" | "excluded" | "unsupported";
|
|
6339
|
+
flags: components["schemas"]["MigrationFlag"][];
|
|
6340
|
+
target: components["schemas"]["MigrationItemTarget"];
|
|
6341
|
+
};
|
|
6342
|
+
/** @description Pantech's monthly price for the plan next to the source's monthly bill, computed when read. */
|
|
6343
|
+
MigrationEstimate: {
|
|
6344
|
+
currency: string;
|
|
6345
|
+
/** @description False when part of the plan could not be priced; then pantech_monthly_minor is null. */
|
|
6346
|
+
pantech_priced: boolean;
|
|
6347
|
+
pantech_monthly_minor: number | null;
|
|
6348
|
+
/** @description What the Pantech price includes: servers, volumes, networks. */
|
|
6349
|
+
covers: string[];
|
|
6350
|
+
/** @description Planned items the price leaves out, e.g. databases. */
|
|
6351
|
+
not_covered: string[];
|
|
6352
|
+
source_known: boolean;
|
|
6353
|
+
source_monthly_minor: number | null;
|
|
6354
|
+
source_currency: string | null;
|
|
6355
|
+
source_months: number;
|
|
6356
|
+
/**
|
|
6357
|
+
* @description `whole_account`: the source figure is the whole cloud bill.
|
|
6358
|
+
* @enum {string}
|
|
6359
|
+
*/
|
|
6360
|
+
source_scope: "whole_account";
|
|
6361
|
+
} | null;
|
|
6362
|
+
MigrationSummary: {
|
|
6363
|
+
planned: number;
|
|
6364
|
+
excluded: number;
|
|
6365
|
+
unsupported: number;
|
|
6366
|
+
/** @description Planned items per kind. */
|
|
6367
|
+
by_kind: {
|
|
6368
|
+
[key: string]: number;
|
|
6369
|
+
};
|
|
6370
|
+
};
|
|
6371
|
+
Migration: {
|
|
6372
|
+
/** @example mig_06gk3x9tq7m2v8r4y1c5d0zp8w */
|
|
6373
|
+
id: string;
|
|
6374
|
+
name: string;
|
|
6375
|
+
region: string;
|
|
6376
|
+
connection_id: string;
|
|
6377
|
+
scan_id: string;
|
|
6378
|
+
/**
|
|
6379
|
+
* @description `planning`. Copying arrives in a later release.
|
|
6380
|
+
* @enum {string}
|
|
6381
|
+
*/
|
|
6382
|
+
stage: "planning";
|
|
6383
|
+
version: number;
|
|
6384
|
+
summary: components["schemas"]["MigrationSummary"];
|
|
6385
|
+
estimate: components["schemas"]["MigrationEstimate"];
|
|
6386
|
+
/** @description Null in a list. */
|
|
6387
|
+
items: components["schemas"]["MigrationItem"][] | null;
|
|
6388
|
+
/** Format: date-time */
|
|
6389
|
+
created_at: string;
|
|
6390
|
+
/** Format: date-time */
|
|
6391
|
+
updated_at: string;
|
|
6392
|
+
};
|
|
6393
|
+
MigrationList: {
|
|
6394
|
+
data: components["schemas"]["Migration"][];
|
|
6395
|
+
/** @description Always null: this list is returned whole. */
|
|
6396
|
+
next_cursor: string | null;
|
|
6397
|
+
};
|
|
6398
|
+
CreateMigrationRequest: {
|
|
6399
|
+
scan_id: string;
|
|
6400
|
+
name: string;
|
|
6401
|
+
/** @description A Pantech region code; the first region when left out. */
|
|
6402
|
+
region?: string;
|
|
6403
|
+
};
|
|
6404
|
+
RenameMigrationRequest: {
|
|
6405
|
+
name: string;
|
|
6406
|
+
};
|
|
6407
|
+
UpdateMigrationItemRequest: {
|
|
6408
|
+
key: string;
|
|
6409
|
+
excluded?: boolean;
|
|
6410
|
+
plan_slug?: string;
|
|
6411
|
+
storage_gb?: number;
|
|
6412
|
+
cidr?: string;
|
|
6413
|
+
/** @enum {string} */
|
|
6414
|
+
role?: "member" | "admin";
|
|
6415
|
+
email?: string;
|
|
6416
|
+
};
|
|
6417
|
+
MigrationTerraform: {
|
|
6418
|
+
files: {
|
|
6419
|
+
name: string;
|
|
6420
|
+
content: string;
|
|
6421
|
+
}[];
|
|
6422
|
+
};
|
|
6423
|
+
};
|
|
6424
|
+
responses: {
|
|
6425
|
+
/** @description `UNAUTHENTICATED`: the request has no API key, or the key is mistyped, revoked or expired, or its creator has left the organization. Send `Authorization: Bearer PAN_…` with a valid key; create one in the console under Organization › API keys. */
|
|
6426
|
+
Unauthenticated: {
|
|
6427
|
+
headers: {
|
|
6428
|
+
"WWW-Authenticate"?: string;
|
|
6429
|
+
[name: string]: unknown;
|
|
6430
|
+
};
|
|
6431
|
+
content: {
|
|
6432
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
6433
|
+
};
|
|
6434
|
+
};
|
|
6435
|
+
/**
|
|
6436
|
+
* @description `INSUFFICIENT_SCOPE`: the API key lacks the scope this endpoint needs (`read` for GET, `write` for changes; an AI app's key also needs `delete` for a destructive call). Use a key with that scope, or reconnect the AI app with "Manage and delete" access.
|
|
6437
|
+
* `FORBIDDEN`: the member who created the key may not do this in the organization. Use a key created by an owner or admin.
|
|
6438
|
+
* `AI_APPS_DISABLED`: the organization has turned AI app access off, and this request was made with an AI app's key or sent by Pantech's MCP server (`Pantech-Client: mcp/…`). An owner can turn it on in the console under Organization › AI apps.
|
|
6439
|
+
*/
|
|
6440
|
+
Forbidden: {
|
|
6441
|
+
headers: {
|
|
6442
|
+
[name: string]: unknown;
|
|
6443
|
+
};
|
|
6444
|
+
content: {
|
|
6445
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
6446
|
+
};
|
|
6447
|
+
};
|
|
6448
|
+
/** @description `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry. */
|
|
6449
|
+
QuotaUnavailable: {
|
|
6450
|
+
headers: {
|
|
6451
|
+
[name: string]: unknown;
|
|
6452
|
+
};
|
|
6453
|
+
content: {
|
|
6454
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
6455
|
+
};
|
|
6456
|
+
};
|
|
6457
|
+
/** @description `RATE_LIMITED`: this API key, verified user or organization used its request budget for the current window, or this address exceeded an IP/failed-auth limit. Wait `Retry-After` seconds, then retry. For authenticated quota denials, `RateLimit-Scope` identifies the denying quota and `RateLimit-Reset` reports its remaining window in seconds. */
|
|
6458
|
+
RateLimited: {
|
|
6459
|
+
headers: {
|
|
6460
|
+
"RateLimit-Scope"?: "api_key" | "user" | "organization";
|
|
6461
|
+
"RateLimit-Limit"?: number;
|
|
6462
|
+
"RateLimit-Remaining"?: number;
|
|
6463
|
+
"RateLimit-Reset"?: number;
|
|
5835
6464
|
"Retry-After"?: number;
|
|
5836
6465
|
[name: string]: unknown;
|
|
5837
6466
|
};
|
|
@@ -11275,6 +11904,8 @@ interface operations {
|
|
|
11275
11904
|
* `subnet_id` `SUBNET_NOT_IN_NETWORK`: the subnet is not in the public IP's private network.
|
|
11276
11905
|
* `instance_ids` `INSTANCE_NOT_IN_SUBNET`: every instance must be in the load balancer's subnet.
|
|
11277
11906
|
* `instance_ids` `TOO_MANY`: at most 50 instances.
|
|
11907
|
+
* `protocol` `LOAD_BALANCER_PROTOCOL_NOT_SUPPORTED`: only `tcp` listeners are offered. HTTP and HTTPS are balanced as `tcp` and reach your instances unchanged, so serve TLS on the instances.
|
|
11908
|
+
* `public_port` `LOAD_BALANCER_PORT_RESERVED`: an `appliance` load balancer cannot listen on 8404 or 8405; those ports run the load balancer itself.
|
|
11278
11909
|
* `UNKNOWN_FIELD`: the body has a field this endpoint does not take (named in `field`). Remove it or fix its spelling.
|
|
11279
11910
|
*/
|
|
11280
11911
|
422: {
|
|
@@ -12680,6 +13311,8 @@ interface operations {
|
|
|
12680
13311
|
* `control_nodes` `INVALID_KUBERNETES_CONTROL_NODES` or `KUBERNETES_HA_NOT_AVAILABLE`: 1, or 3 where offered.
|
|
12681
13312
|
* `autoscaling` `INVALID_KUBERNETES_AUTOSCALING`: min_workers and max_workers 1 to 10, min no more than max, and workers within them.
|
|
12682
13313
|
* `api_allowed_cidrs` `INVALID_API_ALLOWED_CIDRS` (at most 20 IPv4 CIDRs) or `API_ALLOWED_CIDRS_VPC_ONLY`.
|
|
13314
|
+
* `pod_cidr` `KUBERNETES_POD_CIDR_OVERLAP`: the pod range overlaps the cluster's VPC network, its subnet or `service_cidr`. Choose a range clear of them, or leave it out.
|
|
13315
|
+
* `service_cidr` `KUBERNETES_SERVICE_CIDR_OVERLAP`: the service range overlaps the cluster's VPC network, its subnet or `pod_cidr`. Choose a range clear of them, or leave it out.
|
|
12683
13316
|
* `subnet_id` `KUBERNETES_SUBNET_REQUIRED`, `KUBERNETES_SUBNET_NOT_ALLOWED` or `KUBERNETES_SUBNET_NOT_FOUND`: an active subnet in a VPC zone, and none in a standard zone.
|
|
12684
13317
|
* `UNKNOWN_FIELD`: the body has a field this endpoint does not take (named in `field`).
|
|
12685
13318
|
*/
|
|
@@ -13035,6 +13668,7 @@ interface operations {
|
|
|
13035
13668
|
* @description `KUBERNETES_CLUSTER_NOT_RUNNING`: start the cluster first.
|
|
13036
13669
|
* `KUBERNETES_CLUSTER_BUSY`: the cluster is already changing. Wait until it is running or stopped.
|
|
13037
13670
|
* `KUBERNETES_CLUSTER_NOT_CHANGEABLE`: the cluster cannot make this change now (stopped, being deleted, or failed).
|
|
13671
|
+
* `KUBERNETES_UPGRADE_NOT_AVAILABLE`: the cluster runs the version it was created with and cannot be upgraded in place. Create a new cluster on the version you need.
|
|
13038
13672
|
* `CONCURRENT_UPDATE`: the cluster changed while this request was being processed. Retry the request; if it repeats, read the cluster first.
|
|
13039
13673
|
*/
|
|
13040
13674
|
409: {
|
|
@@ -13146,6 +13780,7 @@ interface operations {
|
|
|
13146
13780
|
* @description `KUBERNETES_CLUSTER_NOT_RUNNING`: start the cluster first.
|
|
13147
13781
|
* `KUBERNETES_CLUSTER_BUSY`: the cluster is already changing. Wait until it is running or stopped.
|
|
13148
13782
|
* `KUBERNETES_CLUSTER_NOT_CHANGEABLE`: the cluster cannot make this change now (stopped, being deleted, or failed).
|
|
13783
|
+
* `KUBERNETES_NODE_PLAN_NOT_CHANGEABLE`: a different `node_plan`. A cluster's node plan is fixed at creation; add a node pool on the plan you need, or create a new cluster on it.
|
|
13149
13784
|
* `CONCURRENT_UPDATE`: the cluster changed while this request was being processed. Retry the request; if it repeats, read the cluster first.
|
|
13150
13785
|
*/
|
|
13151
13786
|
409: {
|
|
@@ -13257,6 +13892,7 @@ interface operations {
|
|
|
13257
13892
|
* @description `KUBERNETES_CLUSTER_NOT_RUNNING`: start the cluster first.
|
|
13258
13893
|
* `KUBERNETES_CLUSTER_BUSY`: the cluster is already changing. Wait until it is running or stopped.
|
|
13259
13894
|
* `KUBERNETES_CLUSTER_NOT_CHANGEABLE`: the cluster cannot make this change now (stopped, being deleted, or failed).
|
|
13895
|
+
* `KUBERNETES_NETWORK_NOT_CHANGEABLE`: `cni_plugin`, `pod_cidr` and `service_cidr` are set when the cluster is created and cannot be changed. Create a new cluster with the settings you need. Only `api_allowed_cidrs` changes here.
|
|
13260
13896
|
* `CONCURRENT_UPDATE`: the cluster changed while this request was being processed. Retry the request; if it repeats, read the cluster first.
|
|
13261
13897
|
*/
|
|
13262
13898
|
409: {
|
|
@@ -15618,7 +16254,8 @@ interface operations {
|
|
|
15618
16254
|
};
|
|
15619
16255
|
/**
|
|
15620
16256
|
* @description `INVALID_RESOURCE_STATE`: the subnet still has instances or databases, or is already being deleted. Delete them first.
|
|
15621
|
-
* `SUBNET_HAS_KUBERNETES_CLUSTERS`: Kubernetes clusters still run in this subnet. Delete
|
|
16257
|
+
* `SUBNET_HAS_KUBERNETES_CLUSTERS`: Kubernetes clusters still run in this subnet, or the nodes of a cluster you deleted are still being removed (they are removed in the background, which can take up to an hour after the delete). Delete the clusters first, then retry.
|
|
16258
|
+
* `SUBNET_HAS_LOAD_BALANCERS`: load balancers still sit on this subnet, or one you deleted is still being removed. Delete them first, then retry; a deleted load balancer is removed within a few minutes.
|
|
15622
16259
|
* `CONCURRENT_UPDATE`: the resource changed while this request was being processed. Retry the request; if it repeats, read the resource first.
|
|
15623
16260
|
*/
|
|
15624
16261
|
409: {
|
|
@@ -17774,92 +18411,1015 @@ interface operations {
|
|
|
17774
18411
|
};
|
|
17775
18412
|
};
|
|
17776
18413
|
};
|
|
17777
|
-
|
|
17778
|
-
|
|
17779
|
-
|
|
17780
|
-
|
|
17781
|
-
|
|
17782
|
-
|
|
17783
|
-
|
|
17784
|
-
|
|
17785
|
-
|
|
18414
|
+
listCloudConnections: {
|
|
18415
|
+
parameters: {
|
|
18416
|
+
query?: never;
|
|
18417
|
+
header?: never;
|
|
18418
|
+
path?: never;
|
|
18419
|
+
cookie?: never;
|
|
18420
|
+
};
|
|
18421
|
+
requestBody?: never;
|
|
18422
|
+
responses: {
|
|
18423
|
+
/** @description Cloud connections. */
|
|
18424
|
+
200: {
|
|
18425
|
+
headers: {
|
|
18426
|
+
/** @description Requests allowed per window for this key. */
|
|
18427
|
+
"RateLimit-Limit"?: number;
|
|
18428
|
+
/** @description Requests left in this window. */
|
|
18429
|
+
"RateLimit-Remaining"?: number;
|
|
18430
|
+
/** @description Seconds until the window resets. */
|
|
18431
|
+
"RateLimit-Reset"?: number;
|
|
18432
|
+
/** @description This request's id. */
|
|
18433
|
+
"X-Request-Id"?: string;
|
|
18434
|
+
[name: string]: unknown;
|
|
18435
|
+
};
|
|
18436
|
+
content: {
|
|
18437
|
+
"application/json": components["schemas"]["CloudConnectionList"];
|
|
18438
|
+
};
|
|
18439
|
+
};
|
|
18440
|
+
401: components["responses"]["Unauthenticated"];
|
|
18441
|
+
403: components["responses"]["Forbidden"];
|
|
18442
|
+
429: components["responses"]["RateLimited"];
|
|
18443
|
+
/**
|
|
18444
|
+
* @description `MIGRATE_UNAVAILABLE`: Pantech Migrate is not available on this deployment yet. Try again later.
|
|
18445
|
+
* `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry.
|
|
18446
|
+
*/
|
|
18447
|
+
503: {
|
|
18448
|
+
headers: {
|
|
18449
|
+
[name: string]: unknown;
|
|
18450
|
+
};
|
|
18451
|
+
content: {
|
|
18452
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18453
|
+
};
|
|
18454
|
+
};
|
|
18455
|
+
};
|
|
17786
18456
|
};
|
|
17787
|
-
|
|
17788
|
-
|
|
17789
|
-
|
|
17790
|
-
|
|
17791
|
-
|
|
17792
|
-
|
|
17793
|
-
|
|
17794
|
-
|
|
17795
|
-
|
|
17796
|
-
|
|
17797
|
-
|
|
17798
|
-
|
|
17799
|
-
|
|
17800
|
-
|
|
17801
|
-
|
|
17802
|
-
|
|
17803
|
-
|
|
17804
|
-
|
|
17805
|
-
|
|
17806
|
-
/**
|
|
17807
|
-
|
|
17808
|
-
|
|
17809
|
-
|
|
17810
|
-
|
|
17811
|
-
|
|
17812
|
-
|
|
17813
|
-
|
|
17814
|
-
|
|
17815
|
-
|
|
17816
|
-
|
|
17817
|
-
|
|
17818
|
-
|
|
17819
|
-
|
|
17820
|
-
}
|
|
17821
|
-
|
|
17822
|
-
|
|
17823
|
-
|
|
17824
|
-
|
|
17825
|
-
|
|
17826
|
-
|
|
17827
|
-
|
|
17828
|
-
|
|
17829
|
-
|
|
17830
|
-
|
|
17831
|
-
|
|
17832
|
-
}
|
|
17833
|
-
|
|
17834
|
-
|
|
17835
|
-
|
|
17836
|
-
|
|
17837
|
-
}
|
|
17838
|
-
|
|
17839
|
-
|
|
17840
|
-
|
|
17841
|
-
}
|
|
17842
|
-
|
|
17843
|
-
|
|
17844
|
-
|
|
17845
|
-
|
|
17846
|
-
|
|
17847
|
-
|
|
17848
|
-
|
|
17849
|
-
|
|
17850
|
-
|
|
17851
|
-
|
|
17852
|
-
|
|
17853
|
-
|
|
17854
|
-
|
|
17855
|
-
}
|
|
17856
|
-
|
|
17857
|
-
|
|
17858
|
-
|
|
17859
|
-
|
|
17860
|
-
|
|
17861
|
-
|
|
17862
|
-
|
|
18457
|
+
createCloudConnection: {
|
|
18458
|
+
parameters: {
|
|
18459
|
+
query?: never;
|
|
18460
|
+
header: {
|
|
18461
|
+
/** @description A unique value per change, e.g. a UUID. Retrying with the same key returns the original result instead of repeating the change; reusing it for a different request is an error. Required on every POST, PUT and DELETE. */
|
|
18462
|
+
"Idempotency-Key": components["parameters"]["IdempotencyKey"];
|
|
18463
|
+
};
|
|
18464
|
+
path?: never;
|
|
18465
|
+
cookie?: never;
|
|
18466
|
+
};
|
|
18467
|
+
requestBody: {
|
|
18468
|
+
content: {
|
|
18469
|
+
"application/json": components["schemas"]["CreateCloudConnectionRequest"];
|
|
18470
|
+
};
|
|
18471
|
+
};
|
|
18472
|
+
responses: {
|
|
18473
|
+
/** @description The connection, with its setup. */
|
|
18474
|
+
201: {
|
|
18475
|
+
headers: {
|
|
18476
|
+
/** @description Requests allowed per window for this key. */
|
|
18477
|
+
"RateLimit-Limit"?: number;
|
|
18478
|
+
/** @description Requests left in this window. */
|
|
18479
|
+
"RateLimit-Remaining"?: number;
|
|
18480
|
+
/** @description Seconds until the window resets. */
|
|
18481
|
+
"RateLimit-Reset"?: number;
|
|
18482
|
+
/** @description This request's id. */
|
|
18483
|
+
"X-Request-Id"?: string;
|
|
18484
|
+
/** @description Where the new resource is. */
|
|
18485
|
+
Location?: string;
|
|
18486
|
+
[name: string]: unknown;
|
|
18487
|
+
};
|
|
18488
|
+
content: {
|
|
18489
|
+
"application/json": components["schemas"]["CloudConnection"];
|
|
18490
|
+
};
|
|
18491
|
+
};
|
|
18492
|
+
401: components["responses"]["Unauthenticated"];
|
|
18493
|
+
403: components["responses"]["Forbidden"];
|
|
18494
|
+
/** @description `IDEMPOTENCY_CONFLICT`: this Idempotency-Key was used with a different request. */
|
|
18495
|
+
409: {
|
|
18496
|
+
headers: {
|
|
18497
|
+
[name: string]: unknown;
|
|
18498
|
+
};
|
|
18499
|
+
content: {
|
|
18500
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18501
|
+
};
|
|
18502
|
+
};
|
|
18503
|
+
/** @description `VALIDATION_FAILED`: a field is invalid; `errors` names it. `provider` must be `aws`. */
|
|
18504
|
+
422: {
|
|
18505
|
+
headers: {
|
|
18506
|
+
[name: string]: unknown;
|
|
18507
|
+
};
|
|
18508
|
+
content: {
|
|
18509
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18510
|
+
};
|
|
18511
|
+
};
|
|
18512
|
+
429: components["responses"]["RateLimited"];
|
|
18513
|
+
/**
|
|
18514
|
+
* @description `MIGRATE_UNAVAILABLE`: Pantech Migrate is not available on this deployment yet. Try again later.
|
|
18515
|
+
* `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry.
|
|
18516
|
+
*/
|
|
18517
|
+
503: {
|
|
18518
|
+
headers: {
|
|
18519
|
+
[name: string]: unknown;
|
|
18520
|
+
};
|
|
18521
|
+
content: {
|
|
18522
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18523
|
+
};
|
|
18524
|
+
};
|
|
18525
|
+
};
|
|
18526
|
+
};
|
|
18527
|
+
getCloudConnection: {
|
|
18528
|
+
parameters: {
|
|
18529
|
+
query?: never;
|
|
18530
|
+
header?: never;
|
|
18531
|
+
path: {
|
|
18532
|
+
connection_id: string;
|
|
18533
|
+
};
|
|
18534
|
+
cookie?: never;
|
|
18535
|
+
};
|
|
18536
|
+
requestBody?: never;
|
|
18537
|
+
responses: {
|
|
18538
|
+
/** @description The connection. */
|
|
18539
|
+
200: {
|
|
18540
|
+
headers: {
|
|
18541
|
+
/** @description Requests allowed per window for this key. */
|
|
18542
|
+
"RateLimit-Limit"?: number;
|
|
18543
|
+
/** @description Requests left in this window. */
|
|
18544
|
+
"RateLimit-Remaining"?: number;
|
|
18545
|
+
/** @description Seconds until the window resets. */
|
|
18546
|
+
"RateLimit-Reset"?: number;
|
|
18547
|
+
/** @description This request's id. */
|
|
18548
|
+
"X-Request-Id"?: string;
|
|
18549
|
+
[name: string]: unknown;
|
|
18550
|
+
};
|
|
18551
|
+
content: {
|
|
18552
|
+
"application/json": components["schemas"]["CloudConnection"];
|
|
18553
|
+
};
|
|
18554
|
+
};
|
|
18555
|
+
401: components["responses"]["Unauthenticated"];
|
|
18556
|
+
403: components["responses"]["Forbidden"];
|
|
18557
|
+
/** @description `CLOUD_CONNECTION_NOT_FOUND`: no cloud connection with this id exists in your organization. */
|
|
18558
|
+
404: {
|
|
18559
|
+
headers: {
|
|
18560
|
+
[name: string]: unknown;
|
|
18561
|
+
};
|
|
18562
|
+
content: {
|
|
18563
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18564
|
+
};
|
|
18565
|
+
};
|
|
18566
|
+
429: components["responses"]["RateLimited"];
|
|
18567
|
+
/**
|
|
18568
|
+
* @description `MIGRATE_UNAVAILABLE`: Pantech Migrate is not available on this deployment yet. Try again later.
|
|
18569
|
+
* `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry.
|
|
18570
|
+
*/
|
|
18571
|
+
503: {
|
|
18572
|
+
headers: {
|
|
18573
|
+
[name: string]: unknown;
|
|
18574
|
+
};
|
|
18575
|
+
content: {
|
|
18576
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18577
|
+
};
|
|
18578
|
+
};
|
|
18579
|
+
};
|
|
18580
|
+
};
|
|
18581
|
+
deleteCloudConnection: {
|
|
18582
|
+
parameters: {
|
|
18583
|
+
query?: never;
|
|
18584
|
+
header: {
|
|
18585
|
+
/** @description A unique value per change, e.g. a UUID. Retrying with the same key returns the original result instead of repeating the change; reusing it for a different request is an error. Required on every POST, PUT and DELETE. */
|
|
18586
|
+
"Idempotency-Key": components["parameters"]["IdempotencyKey"];
|
|
18587
|
+
};
|
|
18588
|
+
path: {
|
|
18589
|
+
connection_id: string;
|
|
18590
|
+
};
|
|
18591
|
+
cookie?: never;
|
|
18592
|
+
};
|
|
18593
|
+
requestBody?: never;
|
|
18594
|
+
responses: {
|
|
18595
|
+
/** @description Disconnected. */
|
|
18596
|
+
204: {
|
|
18597
|
+
headers: {
|
|
18598
|
+
/** @description Requests allowed per window for this key. */
|
|
18599
|
+
"RateLimit-Limit"?: number;
|
|
18600
|
+
/** @description Requests left in this window. */
|
|
18601
|
+
"RateLimit-Remaining"?: number;
|
|
18602
|
+
/** @description Seconds until the window resets. */
|
|
18603
|
+
"RateLimit-Reset"?: number;
|
|
18604
|
+
/** @description This request's id. */
|
|
18605
|
+
"X-Request-Id"?: string;
|
|
18606
|
+
[name: string]: unknown;
|
|
18607
|
+
};
|
|
18608
|
+
content?: never;
|
|
18609
|
+
};
|
|
18610
|
+
401: components["responses"]["Unauthenticated"];
|
|
18611
|
+
403: components["responses"]["Forbidden"];
|
|
18612
|
+
/** @description `CLOUD_CONNECTION_NOT_FOUND`: no cloud connection with this id exists in your organization. */
|
|
18613
|
+
404: {
|
|
18614
|
+
headers: {
|
|
18615
|
+
[name: string]: unknown;
|
|
18616
|
+
};
|
|
18617
|
+
content: {
|
|
18618
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18619
|
+
};
|
|
18620
|
+
};
|
|
18621
|
+
429: components["responses"]["RateLimited"];
|
|
18622
|
+
/**
|
|
18623
|
+
* @description `MIGRATE_UNAVAILABLE`: Pantech Migrate is not available on this deployment yet. Try again later.
|
|
18624
|
+
* `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry.
|
|
18625
|
+
*/
|
|
18626
|
+
503: {
|
|
18627
|
+
headers: {
|
|
18628
|
+
[name: string]: unknown;
|
|
18629
|
+
};
|
|
18630
|
+
content: {
|
|
18631
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18632
|
+
};
|
|
18633
|
+
};
|
|
18634
|
+
};
|
|
18635
|
+
};
|
|
18636
|
+
updateCloudConnection: {
|
|
18637
|
+
parameters: {
|
|
18638
|
+
query?: never;
|
|
18639
|
+
header: {
|
|
18640
|
+
/** @description A unique value per change, e.g. a UUID. Retrying with the same key returns the original result instead of repeating the change; reusing it for a different request is an error. Required on every POST, PUT and DELETE. */
|
|
18641
|
+
"Idempotency-Key": components["parameters"]["IdempotencyKey"];
|
|
18642
|
+
};
|
|
18643
|
+
path: {
|
|
18644
|
+
connection_id: string;
|
|
18645
|
+
};
|
|
18646
|
+
cookie?: never;
|
|
18647
|
+
};
|
|
18648
|
+
requestBody: {
|
|
18649
|
+
content: {
|
|
18650
|
+
"application/json": components["schemas"]["UpdateCloudConnectionRequest"];
|
|
18651
|
+
};
|
|
18652
|
+
};
|
|
18653
|
+
responses: {
|
|
18654
|
+
/** @description The connection. */
|
|
18655
|
+
200: {
|
|
18656
|
+
headers: {
|
|
18657
|
+
/** @description Requests allowed per window for this key. */
|
|
18658
|
+
"RateLimit-Limit"?: number;
|
|
18659
|
+
/** @description Requests left in this window. */
|
|
18660
|
+
"RateLimit-Remaining"?: number;
|
|
18661
|
+
/** @description Seconds until the window resets. */
|
|
18662
|
+
"RateLimit-Reset"?: number;
|
|
18663
|
+
/** @description This request's id. */
|
|
18664
|
+
"X-Request-Id"?: string;
|
|
18665
|
+
[name: string]: unknown;
|
|
18666
|
+
};
|
|
18667
|
+
content: {
|
|
18668
|
+
"application/json": components["schemas"]["CloudConnection"];
|
|
18669
|
+
};
|
|
18670
|
+
};
|
|
18671
|
+
401: components["responses"]["Unauthenticated"];
|
|
18672
|
+
403: components["responses"]["Forbidden"];
|
|
18673
|
+
/** @description `CLOUD_CONNECTION_NOT_FOUND`: no cloud connection with this id exists in your organization. */
|
|
18674
|
+
404: {
|
|
18675
|
+
headers: {
|
|
18676
|
+
[name: string]: unknown;
|
|
18677
|
+
};
|
|
18678
|
+
content: {
|
|
18679
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18680
|
+
};
|
|
18681
|
+
};
|
|
18682
|
+
/** @description `CONFLICT`: the connection changed at the same time. Read it again and retry. */
|
|
18683
|
+
409: {
|
|
18684
|
+
headers: {
|
|
18685
|
+
[name: string]: unknown;
|
|
18686
|
+
};
|
|
18687
|
+
content: {
|
|
18688
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18689
|
+
};
|
|
18690
|
+
};
|
|
18691
|
+
/** @description `VALIDATION_FAILED`: a field is invalid; `errors` names it. `role_arn` must be the stack's RoleArn output, like `arn:aws:iam::123456789012:role/name`. */
|
|
18692
|
+
422: {
|
|
18693
|
+
headers: {
|
|
18694
|
+
[name: string]: unknown;
|
|
18695
|
+
};
|
|
18696
|
+
content: {
|
|
18697
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18698
|
+
};
|
|
18699
|
+
};
|
|
18700
|
+
429: components["responses"]["RateLimited"];
|
|
18701
|
+
/**
|
|
18702
|
+
* @description `MIGRATE_UNAVAILABLE`: Pantech Migrate is not available on this deployment yet. Try again later.
|
|
18703
|
+
* `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry.
|
|
18704
|
+
*/
|
|
18705
|
+
503: {
|
|
18706
|
+
headers: {
|
|
18707
|
+
[name: string]: unknown;
|
|
18708
|
+
};
|
|
18709
|
+
content: {
|
|
18710
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18711
|
+
};
|
|
18712
|
+
};
|
|
18713
|
+
};
|
|
18714
|
+
};
|
|
18715
|
+
listCloudScans: {
|
|
18716
|
+
parameters: {
|
|
18717
|
+
query?: never;
|
|
18718
|
+
header?: never;
|
|
18719
|
+
path: {
|
|
18720
|
+
connection_id: string;
|
|
18721
|
+
};
|
|
18722
|
+
cookie?: never;
|
|
18723
|
+
};
|
|
18724
|
+
requestBody?: never;
|
|
18725
|
+
responses: {
|
|
18726
|
+
/** @description Scans. */
|
|
18727
|
+
200: {
|
|
18728
|
+
headers: {
|
|
18729
|
+
/** @description Requests allowed per window for this key. */
|
|
18730
|
+
"RateLimit-Limit"?: number;
|
|
18731
|
+
/** @description Requests left in this window. */
|
|
18732
|
+
"RateLimit-Remaining"?: number;
|
|
18733
|
+
/** @description Seconds until the window resets. */
|
|
18734
|
+
"RateLimit-Reset"?: number;
|
|
18735
|
+
/** @description This request's id. */
|
|
18736
|
+
"X-Request-Id"?: string;
|
|
18737
|
+
[name: string]: unknown;
|
|
18738
|
+
};
|
|
18739
|
+
content: {
|
|
18740
|
+
"application/json": components["schemas"]["CloudScanList"];
|
|
18741
|
+
};
|
|
18742
|
+
};
|
|
18743
|
+
401: components["responses"]["Unauthenticated"];
|
|
18744
|
+
403: components["responses"]["Forbidden"];
|
|
18745
|
+
/** @description `CLOUD_CONNECTION_NOT_FOUND`: no cloud connection with this id exists in your organization. */
|
|
18746
|
+
404: {
|
|
18747
|
+
headers: {
|
|
18748
|
+
[name: string]: unknown;
|
|
18749
|
+
};
|
|
18750
|
+
content: {
|
|
18751
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18752
|
+
};
|
|
18753
|
+
};
|
|
18754
|
+
429: components["responses"]["RateLimited"];
|
|
18755
|
+
/**
|
|
18756
|
+
* @description `MIGRATE_UNAVAILABLE`: Pantech Migrate is not available on this deployment yet. Try again later.
|
|
18757
|
+
* `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry.
|
|
18758
|
+
*/
|
|
18759
|
+
503: {
|
|
18760
|
+
headers: {
|
|
18761
|
+
[name: string]: unknown;
|
|
18762
|
+
};
|
|
18763
|
+
content: {
|
|
18764
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18765
|
+
};
|
|
18766
|
+
};
|
|
18767
|
+
};
|
|
18768
|
+
};
|
|
18769
|
+
startCloudScan: {
|
|
18770
|
+
parameters: {
|
|
18771
|
+
query?: never;
|
|
18772
|
+
header: {
|
|
18773
|
+
/** @description A unique value per change, e.g. a UUID. Retrying with the same key returns the original result instead of repeating the change; reusing it for a different request is an error. Required on every POST, PUT and DELETE. */
|
|
18774
|
+
"Idempotency-Key": components["parameters"]["IdempotencyKey"];
|
|
18775
|
+
};
|
|
18776
|
+
path: {
|
|
18777
|
+
connection_id: string;
|
|
18778
|
+
};
|
|
18779
|
+
cookie?: never;
|
|
18780
|
+
};
|
|
18781
|
+
requestBody?: never;
|
|
18782
|
+
responses: {
|
|
18783
|
+
/** @description The queued scan. */
|
|
18784
|
+
202: {
|
|
18785
|
+
headers: {
|
|
18786
|
+
/** @description Requests allowed per window for this key. */
|
|
18787
|
+
"RateLimit-Limit"?: number;
|
|
18788
|
+
/** @description Requests left in this window. */
|
|
18789
|
+
"RateLimit-Remaining"?: number;
|
|
18790
|
+
/** @description Seconds until the window resets. */
|
|
18791
|
+
"RateLimit-Reset"?: number;
|
|
18792
|
+
/** @description This request's id. */
|
|
18793
|
+
"X-Request-Id"?: string;
|
|
18794
|
+
/** @description Where the new resource is. */
|
|
18795
|
+
Location?: string;
|
|
18796
|
+
[name: string]: unknown;
|
|
18797
|
+
};
|
|
18798
|
+
content: {
|
|
18799
|
+
"application/json": components["schemas"]["CloudScan"];
|
|
18800
|
+
};
|
|
18801
|
+
};
|
|
18802
|
+
401: components["responses"]["Unauthenticated"];
|
|
18803
|
+
403: components["responses"]["Forbidden"];
|
|
18804
|
+
/** @description `CLOUD_CONNECTION_NOT_FOUND`: no cloud connection with this id exists in your organization. */
|
|
18805
|
+
404: {
|
|
18806
|
+
headers: {
|
|
18807
|
+
[name: string]: unknown;
|
|
18808
|
+
};
|
|
18809
|
+
content: {
|
|
18810
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18811
|
+
};
|
|
18812
|
+
};
|
|
18813
|
+
/** @description `CLOUD_CONNECTION_NOT_CONNECTED`: finish connecting first. `CLOUD_CONNECTION_VERIFYING`: the connection is still being checked. `CLOUD_SCAN_IN_PROGRESS`: a scan is already running. `IDEMPOTENCY_CONFLICT`: this Idempotency-Key was used for another connection. */
|
|
18814
|
+
409: {
|
|
18815
|
+
headers: {
|
|
18816
|
+
[name: string]: unknown;
|
|
18817
|
+
};
|
|
18818
|
+
content: {
|
|
18819
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18820
|
+
};
|
|
18821
|
+
};
|
|
18822
|
+
429: components["responses"]["RateLimited"];
|
|
18823
|
+
/**
|
|
18824
|
+
* @description `MIGRATE_UNAVAILABLE`: Pantech Migrate is not available on this deployment yet. Try again later.
|
|
18825
|
+
* `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry.
|
|
18826
|
+
*/
|
|
18827
|
+
503: {
|
|
18828
|
+
headers: {
|
|
18829
|
+
[name: string]: unknown;
|
|
18830
|
+
};
|
|
18831
|
+
content: {
|
|
18832
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18833
|
+
};
|
|
18834
|
+
};
|
|
18835
|
+
};
|
|
18836
|
+
};
|
|
18837
|
+
getCloudScan: {
|
|
18838
|
+
parameters: {
|
|
18839
|
+
query?: {
|
|
18840
|
+
/** @description `inventory` returns everything the scan found. */
|
|
18841
|
+
include?: "inventory";
|
|
18842
|
+
};
|
|
18843
|
+
header?: never;
|
|
18844
|
+
path: {
|
|
18845
|
+
scan_id: string;
|
|
18846
|
+
};
|
|
18847
|
+
cookie?: never;
|
|
18848
|
+
};
|
|
18849
|
+
requestBody?: never;
|
|
18850
|
+
responses: {
|
|
18851
|
+
/** @description The scan. */
|
|
18852
|
+
200: {
|
|
18853
|
+
headers: {
|
|
18854
|
+
/** @description Requests allowed per window for this key. */
|
|
18855
|
+
"RateLimit-Limit"?: number;
|
|
18856
|
+
/** @description Requests left in this window. */
|
|
18857
|
+
"RateLimit-Remaining"?: number;
|
|
18858
|
+
/** @description Seconds until the window resets. */
|
|
18859
|
+
"RateLimit-Reset"?: number;
|
|
18860
|
+
/** @description This request's id. */
|
|
18861
|
+
"X-Request-Id"?: string;
|
|
18862
|
+
[name: string]: unknown;
|
|
18863
|
+
};
|
|
18864
|
+
content: {
|
|
18865
|
+
"application/json": components["schemas"]["CloudScan"];
|
|
18866
|
+
};
|
|
18867
|
+
};
|
|
18868
|
+
401: components["responses"]["Unauthenticated"];
|
|
18869
|
+
403: components["responses"]["Forbidden"];
|
|
18870
|
+
/** @description `CLOUD_SCAN_NOT_FOUND`: no scan with this id exists in your organization. */
|
|
18871
|
+
404: {
|
|
18872
|
+
headers: {
|
|
18873
|
+
[name: string]: unknown;
|
|
18874
|
+
};
|
|
18875
|
+
content: {
|
|
18876
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18877
|
+
};
|
|
18878
|
+
};
|
|
18879
|
+
429: components["responses"]["RateLimited"];
|
|
18880
|
+
/**
|
|
18881
|
+
* @description `MIGRATE_UNAVAILABLE`: Pantech Migrate is not available on this deployment yet. Try again later.
|
|
18882
|
+
* `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry.
|
|
18883
|
+
*/
|
|
18884
|
+
503: {
|
|
18885
|
+
headers: {
|
|
18886
|
+
[name: string]: unknown;
|
|
18887
|
+
};
|
|
18888
|
+
content: {
|
|
18889
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18890
|
+
};
|
|
18891
|
+
};
|
|
18892
|
+
};
|
|
18893
|
+
};
|
|
18894
|
+
listMigrations: {
|
|
18895
|
+
parameters: {
|
|
18896
|
+
query?: never;
|
|
18897
|
+
header?: never;
|
|
18898
|
+
path?: never;
|
|
18899
|
+
cookie?: never;
|
|
18900
|
+
};
|
|
18901
|
+
requestBody?: never;
|
|
18902
|
+
responses: {
|
|
18903
|
+
/** @description Migrations. */
|
|
18904
|
+
200: {
|
|
18905
|
+
headers: {
|
|
18906
|
+
/** @description Requests allowed per window for this key. */
|
|
18907
|
+
"RateLimit-Limit"?: number;
|
|
18908
|
+
/** @description Requests left in this window. */
|
|
18909
|
+
"RateLimit-Remaining"?: number;
|
|
18910
|
+
/** @description Seconds until the window resets. */
|
|
18911
|
+
"RateLimit-Reset"?: number;
|
|
18912
|
+
/** @description This request's id. */
|
|
18913
|
+
"X-Request-Id"?: string;
|
|
18914
|
+
[name: string]: unknown;
|
|
18915
|
+
};
|
|
18916
|
+
content: {
|
|
18917
|
+
"application/json": components["schemas"]["MigrationList"];
|
|
18918
|
+
};
|
|
18919
|
+
};
|
|
18920
|
+
401: components["responses"]["Unauthenticated"];
|
|
18921
|
+
403: components["responses"]["Forbidden"];
|
|
18922
|
+
429: components["responses"]["RateLimited"];
|
|
18923
|
+
/**
|
|
18924
|
+
* @description `MIGRATE_UNAVAILABLE`: Pantech Migrate is not available on this deployment yet. Try again later.
|
|
18925
|
+
* `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry.
|
|
18926
|
+
*/
|
|
18927
|
+
503: {
|
|
18928
|
+
headers: {
|
|
18929
|
+
[name: string]: unknown;
|
|
18930
|
+
};
|
|
18931
|
+
content: {
|
|
18932
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18933
|
+
};
|
|
18934
|
+
};
|
|
18935
|
+
};
|
|
18936
|
+
};
|
|
18937
|
+
createMigration: {
|
|
18938
|
+
parameters: {
|
|
18939
|
+
query?: never;
|
|
18940
|
+
header: {
|
|
18941
|
+
/** @description A unique value per change, e.g. a UUID. Retrying with the same key returns the original result instead of repeating the change; reusing it for a different request is an error. Required on every POST, PUT and DELETE. */
|
|
18942
|
+
"Idempotency-Key": components["parameters"]["IdempotencyKey"];
|
|
18943
|
+
};
|
|
18944
|
+
path?: never;
|
|
18945
|
+
cookie?: never;
|
|
18946
|
+
};
|
|
18947
|
+
requestBody: {
|
|
18948
|
+
content: {
|
|
18949
|
+
"application/json": components["schemas"]["CreateMigrationRequest"];
|
|
18950
|
+
};
|
|
18951
|
+
};
|
|
18952
|
+
responses: {
|
|
18953
|
+
/** @description The plan. */
|
|
18954
|
+
201: {
|
|
18955
|
+
headers: {
|
|
18956
|
+
/** @description Requests allowed per window for this key. */
|
|
18957
|
+
"RateLimit-Limit"?: number;
|
|
18958
|
+
/** @description Requests left in this window. */
|
|
18959
|
+
"RateLimit-Remaining"?: number;
|
|
18960
|
+
/** @description Seconds until the window resets. */
|
|
18961
|
+
"RateLimit-Reset"?: number;
|
|
18962
|
+
/** @description This request's id. */
|
|
18963
|
+
"X-Request-Id"?: string;
|
|
18964
|
+
/** @description Where the new resource is. */
|
|
18965
|
+
Location?: string;
|
|
18966
|
+
[name: string]: unknown;
|
|
18967
|
+
};
|
|
18968
|
+
content: {
|
|
18969
|
+
"application/json": components["schemas"]["Migration"];
|
|
18970
|
+
};
|
|
18971
|
+
};
|
|
18972
|
+
401: components["responses"]["Unauthenticated"];
|
|
18973
|
+
403: components["responses"]["Forbidden"];
|
|
18974
|
+
/** @description `CLOUD_SCAN_NOT_FOUND`: no scan with this id exists in your organization. */
|
|
18975
|
+
404: {
|
|
18976
|
+
headers: {
|
|
18977
|
+
[name: string]: unknown;
|
|
18978
|
+
};
|
|
18979
|
+
content: {
|
|
18980
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18981
|
+
};
|
|
18982
|
+
};
|
|
18983
|
+
/** @description `CLOUD_SCAN_NOT_READY`: the scan has not succeeded. `IDEMPOTENCY_CONFLICT`: this Idempotency-Key was used with another scan. */
|
|
18984
|
+
409: {
|
|
18985
|
+
headers: {
|
|
18986
|
+
[name: string]: unknown;
|
|
18987
|
+
};
|
|
18988
|
+
content: {
|
|
18989
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18990
|
+
};
|
|
18991
|
+
};
|
|
18992
|
+
/** @description `VALIDATION_FAILED`: a field is invalid; `errors` names it. `region` must be a Pantech region code. */
|
|
18993
|
+
422: {
|
|
18994
|
+
headers: {
|
|
18995
|
+
[name: string]: unknown;
|
|
18996
|
+
};
|
|
18997
|
+
content: {
|
|
18998
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
18999
|
+
};
|
|
19000
|
+
};
|
|
19001
|
+
429: components["responses"]["RateLimited"];
|
|
19002
|
+
/**
|
|
19003
|
+
* @description `MIGRATE_UNAVAILABLE`: Pantech Migrate is not available on this deployment yet. Try again later.
|
|
19004
|
+
* `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry.
|
|
19005
|
+
*/
|
|
19006
|
+
503: {
|
|
19007
|
+
headers: {
|
|
19008
|
+
[name: string]: unknown;
|
|
19009
|
+
};
|
|
19010
|
+
content: {
|
|
19011
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19012
|
+
};
|
|
19013
|
+
};
|
|
19014
|
+
};
|
|
19015
|
+
};
|
|
19016
|
+
getMigration: {
|
|
19017
|
+
parameters: {
|
|
19018
|
+
query?: never;
|
|
19019
|
+
header?: never;
|
|
19020
|
+
path: {
|
|
19021
|
+
migration_id: string;
|
|
19022
|
+
};
|
|
19023
|
+
cookie?: never;
|
|
19024
|
+
};
|
|
19025
|
+
requestBody?: never;
|
|
19026
|
+
responses: {
|
|
19027
|
+
/** @description The plan. */
|
|
19028
|
+
200: {
|
|
19029
|
+
headers: {
|
|
19030
|
+
/** @description Requests allowed per window for this key. */
|
|
19031
|
+
"RateLimit-Limit"?: number;
|
|
19032
|
+
/** @description Requests left in this window. */
|
|
19033
|
+
"RateLimit-Remaining"?: number;
|
|
19034
|
+
/** @description Seconds until the window resets. */
|
|
19035
|
+
"RateLimit-Reset"?: number;
|
|
19036
|
+
/** @description This request's id. */
|
|
19037
|
+
"X-Request-Id"?: string;
|
|
19038
|
+
[name: string]: unknown;
|
|
19039
|
+
};
|
|
19040
|
+
content: {
|
|
19041
|
+
"application/json": components["schemas"]["Migration"];
|
|
19042
|
+
};
|
|
19043
|
+
};
|
|
19044
|
+
401: components["responses"]["Unauthenticated"];
|
|
19045
|
+
403: components["responses"]["Forbidden"];
|
|
19046
|
+
/** @description `MIGRATION_NOT_FOUND`: no migration with this id exists in your organization. */
|
|
19047
|
+
404: {
|
|
19048
|
+
headers: {
|
|
19049
|
+
[name: string]: unknown;
|
|
19050
|
+
};
|
|
19051
|
+
content: {
|
|
19052
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19053
|
+
};
|
|
19054
|
+
};
|
|
19055
|
+
429: components["responses"]["RateLimited"];
|
|
19056
|
+
/**
|
|
19057
|
+
* @description `MIGRATE_UNAVAILABLE`: Pantech Migrate is not available on this deployment yet. Try again later.
|
|
19058
|
+
* `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry.
|
|
19059
|
+
*/
|
|
19060
|
+
503: {
|
|
19061
|
+
headers: {
|
|
19062
|
+
[name: string]: unknown;
|
|
19063
|
+
};
|
|
19064
|
+
content: {
|
|
19065
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19066
|
+
};
|
|
19067
|
+
};
|
|
19068
|
+
};
|
|
19069
|
+
};
|
|
19070
|
+
deleteMigration: {
|
|
19071
|
+
parameters: {
|
|
19072
|
+
query?: never;
|
|
19073
|
+
header: {
|
|
19074
|
+
/** @description A unique value per change, e.g. a UUID. Retrying with the same key returns the original result instead of repeating the change; reusing it for a different request is an error. Required on every POST, PUT and DELETE. */
|
|
19075
|
+
"Idempotency-Key": components["parameters"]["IdempotencyKey"];
|
|
19076
|
+
};
|
|
19077
|
+
path: {
|
|
19078
|
+
migration_id: string;
|
|
19079
|
+
};
|
|
19080
|
+
cookie?: never;
|
|
19081
|
+
};
|
|
19082
|
+
requestBody?: never;
|
|
19083
|
+
responses: {
|
|
19084
|
+
/** @description Deleted. */
|
|
19085
|
+
204: {
|
|
19086
|
+
headers: {
|
|
19087
|
+
/** @description Requests allowed per window for this key. */
|
|
19088
|
+
"RateLimit-Limit"?: number;
|
|
19089
|
+
/** @description Requests left in this window. */
|
|
19090
|
+
"RateLimit-Remaining"?: number;
|
|
19091
|
+
/** @description Seconds until the window resets. */
|
|
19092
|
+
"RateLimit-Reset"?: number;
|
|
19093
|
+
/** @description This request's id. */
|
|
19094
|
+
"X-Request-Id"?: string;
|
|
19095
|
+
[name: string]: unknown;
|
|
19096
|
+
};
|
|
19097
|
+
content?: never;
|
|
19098
|
+
};
|
|
19099
|
+
401: components["responses"]["Unauthenticated"];
|
|
19100
|
+
403: components["responses"]["Forbidden"];
|
|
19101
|
+
/** @description `MIGRATION_NOT_FOUND`: no migration with this id exists in your organization. */
|
|
19102
|
+
404: {
|
|
19103
|
+
headers: {
|
|
19104
|
+
[name: string]: unknown;
|
|
19105
|
+
};
|
|
19106
|
+
content: {
|
|
19107
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19108
|
+
};
|
|
19109
|
+
};
|
|
19110
|
+
429: components["responses"]["RateLimited"];
|
|
19111
|
+
/**
|
|
19112
|
+
* @description `MIGRATE_UNAVAILABLE`: Pantech Migrate is not available on this deployment yet. Try again later.
|
|
19113
|
+
* `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry.
|
|
19114
|
+
*/
|
|
19115
|
+
503: {
|
|
19116
|
+
headers: {
|
|
19117
|
+
[name: string]: unknown;
|
|
19118
|
+
};
|
|
19119
|
+
content: {
|
|
19120
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19121
|
+
};
|
|
19122
|
+
};
|
|
19123
|
+
};
|
|
19124
|
+
};
|
|
19125
|
+
renameMigration: {
|
|
19126
|
+
parameters: {
|
|
19127
|
+
query?: never;
|
|
19128
|
+
header: {
|
|
19129
|
+
/** @description A unique value per change, e.g. a UUID. Retrying with the same key returns the original result instead of repeating the change; reusing it for a different request is an error. Required on every POST, PUT and DELETE. */
|
|
19130
|
+
"Idempotency-Key": components["parameters"]["IdempotencyKey"];
|
|
19131
|
+
};
|
|
19132
|
+
path: {
|
|
19133
|
+
migration_id: string;
|
|
19134
|
+
};
|
|
19135
|
+
cookie?: never;
|
|
19136
|
+
};
|
|
19137
|
+
requestBody: {
|
|
19138
|
+
content: {
|
|
19139
|
+
"application/json": components["schemas"]["RenameMigrationRequest"];
|
|
19140
|
+
};
|
|
19141
|
+
};
|
|
19142
|
+
responses: {
|
|
19143
|
+
/** @description The plan. */
|
|
19144
|
+
200: {
|
|
19145
|
+
headers: {
|
|
19146
|
+
/** @description Requests allowed per window for this key. */
|
|
19147
|
+
"RateLimit-Limit"?: number;
|
|
19148
|
+
/** @description Requests left in this window. */
|
|
19149
|
+
"RateLimit-Remaining"?: number;
|
|
19150
|
+
/** @description Seconds until the window resets. */
|
|
19151
|
+
"RateLimit-Reset"?: number;
|
|
19152
|
+
/** @description This request's id. */
|
|
19153
|
+
"X-Request-Id"?: string;
|
|
19154
|
+
[name: string]: unknown;
|
|
19155
|
+
};
|
|
19156
|
+
content: {
|
|
19157
|
+
"application/json": components["schemas"]["Migration"];
|
|
19158
|
+
};
|
|
19159
|
+
};
|
|
19160
|
+
401: components["responses"]["Unauthenticated"];
|
|
19161
|
+
403: components["responses"]["Forbidden"];
|
|
19162
|
+
/** @description `MIGRATION_NOT_FOUND`: no migration with this id exists in your organization. */
|
|
19163
|
+
404: {
|
|
19164
|
+
headers: {
|
|
19165
|
+
[name: string]: unknown;
|
|
19166
|
+
};
|
|
19167
|
+
content: {
|
|
19168
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19169
|
+
};
|
|
19170
|
+
};
|
|
19171
|
+
/** @description `CONFLICT`: the plan changed at the same time. Read it again and retry. */
|
|
19172
|
+
409: {
|
|
19173
|
+
headers: {
|
|
19174
|
+
[name: string]: unknown;
|
|
19175
|
+
};
|
|
19176
|
+
content: {
|
|
19177
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19178
|
+
};
|
|
19179
|
+
};
|
|
19180
|
+
/** @description `VALIDATION_FAILED`: a field is invalid; `errors` names it. */
|
|
19181
|
+
422: {
|
|
19182
|
+
headers: {
|
|
19183
|
+
[name: string]: unknown;
|
|
19184
|
+
};
|
|
19185
|
+
content: {
|
|
19186
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19187
|
+
};
|
|
19188
|
+
};
|
|
19189
|
+
429: components["responses"]["RateLimited"];
|
|
19190
|
+
/**
|
|
19191
|
+
* @description `MIGRATE_UNAVAILABLE`: Pantech Migrate is not available on this deployment yet. Try again later.
|
|
19192
|
+
* `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry.
|
|
19193
|
+
*/
|
|
19194
|
+
503: {
|
|
19195
|
+
headers: {
|
|
19196
|
+
[name: string]: unknown;
|
|
19197
|
+
};
|
|
19198
|
+
content: {
|
|
19199
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19200
|
+
};
|
|
19201
|
+
};
|
|
19202
|
+
};
|
|
19203
|
+
};
|
|
19204
|
+
updateMigrationItem: {
|
|
19205
|
+
parameters: {
|
|
19206
|
+
query?: never;
|
|
19207
|
+
header: {
|
|
19208
|
+
/** @description A unique value per change, e.g. a UUID. Retrying with the same key returns the original result instead of repeating the change; reusing it for a different request is an error. Required on every POST, PUT and DELETE. */
|
|
19209
|
+
"Idempotency-Key": components["parameters"]["IdempotencyKey"];
|
|
19210
|
+
};
|
|
19211
|
+
path: {
|
|
19212
|
+
migration_id: string;
|
|
19213
|
+
};
|
|
19214
|
+
cookie?: never;
|
|
19215
|
+
};
|
|
19216
|
+
requestBody: {
|
|
19217
|
+
content: {
|
|
19218
|
+
"application/json": components["schemas"]["UpdateMigrationItemRequest"];
|
|
19219
|
+
};
|
|
19220
|
+
};
|
|
19221
|
+
responses: {
|
|
19222
|
+
/** @description The plan. */
|
|
19223
|
+
200: {
|
|
19224
|
+
headers: {
|
|
19225
|
+
/** @description Requests allowed per window for this key. */
|
|
19226
|
+
"RateLimit-Limit"?: number;
|
|
19227
|
+
/** @description Requests left in this window. */
|
|
19228
|
+
"RateLimit-Remaining"?: number;
|
|
19229
|
+
/** @description Seconds until the window resets. */
|
|
19230
|
+
"RateLimit-Reset"?: number;
|
|
19231
|
+
/** @description This request's id. */
|
|
19232
|
+
"X-Request-Id"?: string;
|
|
19233
|
+
[name: string]: unknown;
|
|
19234
|
+
};
|
|
19235
|
+
content: {
|
|
19236
|
+
"application/json": components["schemas"]["Migration"];
|
|
19237
|
+
};
|
|
19238
|
+
};
|
|
19239
|
+
401: components["responses"]["Unauthenticated"];
|
|
19240
|
+
403: components["responses"]["Forbidden"];
|
|
19241
|
+
/** @description `MIGRATION_NOT_FOUND`: no migration with this id exists in your organization. */
|
|
19242
|
+
404: {
|
|
19243
|
+
headers: {
|
|
19244
|
+
[name: string]: unknown;
|
|
19245
|
+
};
|
|
19246
|
+
content: {
|
|
19247
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19248
|
+
};
|
|
19249
|
+
};
|
|
19250
|
+
/** @description `CONFLICT`: the plan changed at the same time. Read it again and retry. */
|
|
19251
|
+
409: {
|
|
19252
|
+
headers: {
|
|
19253
|
+
[name: string]: unknown;
|
|
19254
|
+
};
|
|
19255
|
+
content: {
|
|
19256
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19257
|
+
};
|
|
19258
|
+
};
|
|
19259
|
+
/** @description `VALIDATION_FAILED`: `key` names no item (`UNKNOWN_ITEM`), or the change doesn't apply to it (`INVALID_TARGET`). */
|
|
19260
|
+
422: {
|
|
19261
|
+
headers: {
|
|
19262
|
+
[name: string]: unknown;
|
|
19263
|
+
};
|
|
19264
|
+
content: {
|
|
19265
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19266
|
+
};
|
|
19267
|
+
};
|
|
19268
|
+
429: components["responses"]["RateLimited"];
|
|
19269
|
+
/**
|
|
19270
|
+
* @description `MIGRATE_UNAVAILABLE`: Pantech Migrate is not available on this deployment yet. Try again later.
|
|
19271
|
+
* `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry.
|
|
19272
|
+
*/
|
|
19273
|
+
503: {
|
|
19274
|
+
headers: {
|
|
19275
|
+
[name: string]: unknown;
|
|
19276
|
+
};
|
|
19277
|
+
content: {
|
|
19278
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19279
|
+
};
|
|
19280
|
+
};
|
|
19281
|
+
};
|
|
19282
|
+
};
|
|
19283
|
+
exportMigrationTerraform: {
|
|
19284
|
+
parameters: {
|
|
19285
|
+
query?: never;
|
|
19286
|
+
header?: never;
|
|
19287
|
+
path: {
|
|
19288
|
+
migration_id: string;
|
|
19289
|
+
};
|
|
19290
|
+
cookie?: never;
|
|
19291
|
+
};
|
|
19292
|
+
requestBody?: never;
|
|
19293
|
+
responses: {
|
|
19294
|
+
/** @description The files. */
|
|
19295
|
+
200: {
|
|
19296
|
+
headers: {
|
|
19297
|
+
/** @description Requests allowed per window for this key. */
|
|
19298
|
+
"RateLimit-Limit"?: number;
|
|
19299
|
+
/** @description Requests left in this window. */
|
|
19300
|
+
"RateLimit-Remaining"?: number;
|
|
19301
|
+
/** @description Seconds until the window resets. */
|
|
19302
|
+
"RateLimit-Reset"?: number;
|
|
19303
|
+
/** @description This request's id. */
|
|
19304
|
+
"X-Request-Id"?: string;
|
|
19305
|
+
[name: string]: unknown;
|
|
19306
|
+
};
|
|
19307
|
+
content: {
|
|
19308
|
+
"application/json": components["schemas"]["MigrationTerraform"];
|
|
19309
|
+
};
|
|
19310
|
+
};
|
|
19311
|
+
401: components["responses"]["Unauthenticated"];
|
|
19312
|
+
403: components["responses"]["Forbidden"];
|
|
19313
|
+
/** @description `MIGRATION_NOT_FOUND`: no migration with this id exists in your organization. */
|
|
19314
|
+
404: {
|
|
19315
|
+
headers: {
|
|
19316
|
+
[name: string]: unknown;
|
|
19317
|
+
};
|
|
19318
|
+
content: {
|
|
19319
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19320
|
+
};
|
|
19321
|
+
};
|
|
19322
|
+
429: components["responses"]["RateLimited"];
|
|
19323
|
+
/**
|
|
19324
|
+
* @description `MIGRATE_UNAVAILABLE`: Pantech Migrate is not available on this deployment yet. Try again later.
|
|
19325
|
+
* `SERVICE_UNAVAILABLE`: request quota storage is unavailable. Wait a few seconds, then retry.
|
|
19326
|
+
*/
|
|
19327
|
+
503: {
|
|
19328
|
+
headers: {
|
|
19329
|
+
[name: string]: unknown;
|
|
19330
|
+
};
|
|
19331
|
+
content: {
|
|
19332
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
19333
|
+
};
|
|
19334
|
+
};
|
|
19335
|
+
};
|
|
19336
|
+
};
|
|
19337
|
+
}
|
|
19338
|
+
|
|
19339
|
+
/** Every schema in the public API spec, by name. */
|
|
19340
|
+
type Schemas = components["schemas"];
|
|
19341
|
+
/** The `operationId` of every endpoint in the spec. */
|
|
19342
|
+
type OperationId = keyof operations;
|
|
19343
|
+
type JSONContent<R> = R extends {
|
|
19344
|
+
content: {
|
|
19345
|
+
"application/json": infer T;
|
|
19346
|
+
};
|
|
19347
|
+
} ? T : never;
|
|
19348
|
+
type Responses<K extends OperationId> = operations[K]["responses"];
|
|
19349
|
+
/** The JSON body of an operation's success response (200, 201 or 202). */
|
|
19350
|
+
type ResponseOf<K extends OperationId> = {
|
|
19351
|
+
[C in keyof Responses<K>]: C extends 200 | 201 | 202 ? JSONContent<Responses<K>[C]> : never;
|
|
19352
|
+
}[keyof Responses<K>];
|
|
19353
|
+
/** The JSON request body an operation takes. */
|
|
19354
|
+
type BodyOf<K extends OperationId> = JSONContent<NonNullable<operations[K]["requestBody"]>>;
|
|
19355
|
+
/** The query parameters an operation takes. */
|
|
19356
|
+
type QueryOf<K extends OperationId> = NonNullable<operations[K]["parameters"]["query"]>;
|
|
19357
|
+
/**
|
|
19358
|
+
* The parameters of a list method. Every list returns `next_cursor`, so a
|
|
19359
|
+
* `cursor` is accepted even where the spec documents no other filter.
|
|
19360
|
+
*/
|
|
19361
|
+
type ListParams<K extends OperationId> = [QueryOf<K>] extends [never] ? {
|
|
19362
|
+
cursor?: string | null;
|
|
19363
|
+
} : QueryOf<K>;
|
|
19364
|
+
/** The parameters of a `listAll` method: a list's filters, without the cursor. */
|
|
19365
|
+
type ListAllParams<K extends OperationId> = Omit<ListParams<K>, "cursor">;
|
|
19366
|
+
/** One item of a list response's `data`. */
|
|
19367
|
+
type ItemOf<K extends OperationId> = ResponseOf<K> extends {
|
|
19368
|
+
data: Array<infer T>;
|
|
19369
|
+
} ? T : never;
|
|
19370
|
+
|
|
19371
|
+
/** Your credit, and whether it covers your next invoice. */
|
|
19372
|
+
declare class Billing extends APIResource {
|
|
19373
|
+
readonly credit: Credit;
|
|
19374
|
+
readonly receipts: Receipts;
|
|
19375
|
+
}
|
|
19376
|
+
declare class Credit extends APIResource {
|
|
19377
|
+
readonly purchases: CreditPurchases;
|
|
19378
|
+
/** Your credit balance and whether it covers the next invoice. */
|
|
19379
|
+
get(options?: RequestOptions): Promise<ResponseOf<"getCredit">>;
|
|
19380
|
+
}
|
|
19381
|
+
declare class CreditPurchases extends APIResource {
|
|
19382
|
+
/** Creates a payment link that adds credit: send its `checkout_url` to whoever pays. */
|
|
19383
|
+
create(body: BodyOf<"createCreditPurchase">, options?: RequestOptions): Promise<ResponseOf<"createCreditPurchase">>;
|
|
19384
|
+
get(purchaseId: string, options?: RequestOptions): Promise<ResponseOf<"getCreditPurchase">>;
|
|
19385
|
+
}
|
|
19386
|
+
declare class Receipts extends APIResource {
|
|
19387
|
+
list(params?: ListParams<"listReceipts">, options?: RequestOptions): Promise<ResponseOf<"listReceipts">>;
|
|
19388
|
+
listAll(params?: ListAllParams<"listReceipts">, options?: RequestOptions): AsyncGenerator<ItemOf<"listReceipts">>;
|
|
19389
|
+
get(receiptId: string, options?: RequestOptions): Promise<ResponseOf<"getReceipt">>;
|
|
19390
|
+
/** The receipt as a PDF document. */
|
|
19391
|
+
getPdf(receiptId: string, options?: RequestOptions): Promise<ArrayBuffer>;
|
|
19392
|
+
}
|
|
19393
|
+
|
|
19394
|
+
declare class Regions extends APIResource {
|
|
19395
|
+
list(params?: ListParams<"listRegions">, options?: RequestOptions): Promise<ResponseOf<"listRegions">>;
|
|
19396
|
+
listAll(params?: ListAllParams<"listRegions">, options?: RequestOptions): AsyncGenerator<ItemOf<"listRegions">>;
|
|
19397
|
+
}
|
|
19398
|
+
declare class Plans extends APIResource {
|
|
19399
|
+
list(params?: ListParams<"listPlans">, options?: RequestOptions): Promise<ResponseOf<"listPlans">>;
|
|
19400
|
+
listAll(params?: ListAllParams<"listPlans">, options?: RequestOptions): AsyncGenerator<ItemOf<"listPlans">>;
|
|
19401
|
+
}
|
|
19402
|
+
declare class Images extends APIResource {
|
|
19403
|
+
list(params?: ListParams<"listImages">, options?: RequestOptions): Promise<ResponseOf<"listImages">>;
|
|
19404
|
+
listAll(params?: ListAllParams<"listImages">, options?: RequestOptions): AsyncGenerator<ItemOf<"listImages">>;
|
|
19405
|
+
}
|
|
19406
|
+
declare class DiskOfferings extends APIResource {
|
|
19407
|
+
list(params?: ListParams<"listDiskOfferings">, options?: RequestOptions): Promise<ResponseOf<"listDiskOfferings">>;
|
|
19408
|
+
listAll(params?: ListAllParams<"listDiskOfferings">, options?: RequestOptions): AsyncGenerator<ItemOf<"listDiskOfferings">>;
|
|
19409
|
+
/** What a volume of this offering costs. */
|
|
19410
|
+
quote(slug: string, params?: QueryOf<"quoteDiskOffering">, options?: RequestOptions): Promise<ResponseOf<"quoteDiskOffering">>;
|
|
19411
|
+
}
|
|
19412
|
+
declare class DatabaseEngines extends APIResource {
|
|
19413
|
+
list(params?: ListParams<"listDatabaseEngines">, options?: RequestOptions): Promise<ResponseOf<"listDatabaseEngines">>;
|
|
19414
|
+
listAll(params?: ListAllParams<"listDatabaseEngines">, options?: RequestOptions): AsyncGenerator<ItemOf<"listDatabaseEngines">>;
|
|
19415
|
+
}
|
|
19416
|
+
declare class KubernetesVersions extends APIResource {
|
|
19417
|
+
/** The Kubernetes versions a new cluster can run, and the zones that offer high availability. */
|
|
19418
|
+
list(params?: QueryOf<"listKubernetesVersions">, options?: RequestOptions): Promise<ResponseOf<"listKubernetesVersions">>;
|
|
19419
|
+
}
|
|
19420
|
+
declare class Pricing extends APIResource {
|
|
19421
|
+
/** Prices a set of instances, volumes and other resources. Changes nothing. */
|
|
19422
|
+
estimate(body: BodyOf<"estimatePricing">, options?: RequestOptions): Promise<ResponseOf<"estimatePricing">>;
|
|
17863
19423
|
}
|
|
17864
19424
|
|
|
17865
19425
|
interface WaitOptions<T = unknown> {
|
|
@@ -18181,6 +19741,32 @@ type WebhookDeliveryList = components["schemas"]["WebhookDeliveryList"];
|
|
|
18181
19741
|
type WebhookEvent = components["schemas"]["WebhookEvent"];
|
|
18182
19742
|
type WebhookEventType = components["schemas"]["WebhookEventType"];
|
|
18183
19743
|
type WebhookEventTypeList = components["schemas"]["WebhookEventTypeList"];
|
|
19744
|
+
type CloudFailure = components["schemas"]["CloudFailure"];
|
|
19745
|
+
type CloudConnectionSetup = components["schemas"]["CloudConnectionSetup"];
|
|
19746
|
+
type CloudConnection = components["schemas"]["CloudConnection"];
|
|
19747
|
+
type CloudConnectionList = components["schemas"]["CloudConnectionList"];
|
|
19748
|
+
type CreateCloudConnectionRequest = components["schemas"]["CreateCloudConnectionRequest"];
|
|
19749
|
+
type UpdateCloudConnectionRequest = components["schemas"]["UpdateCloudConnectionRequest"];
|
|
19750
|
+
type CloudScanCounts = components["schemas"]["CloudScanCounts"];
|
|
19751
|
+
type CloudCostMonth = components["schemas"]["CloudCostMonth"];
|
|
19752
|
+
type CloudCost = components["schemas"]["CloudCost"];
|
|
19753
|
+
type CloudScan = components["schemas"]["CloudScan"];
|
|
19754
|
+
type CloudScanList = components["schemas"]["CloudScanList"];
|
|
19755
|
+
type MigrationListener = components["schemas"]["MigrationListener"];
|
|
19756
|
+
type CloudInventory = components["schemas"]["CloudInventory"];
|
|
19757
|
+
type MigrationFlag = components["schemas"]["MigrationFlag"];
|
|
19758
|
+
type MigrationRule = components["schemas"]["MigrationRule"];
|
|
19759
|
+
type MigrationItemTarget = components["schemas"]["MigrationItemTarget"];
|
|
19760
|
+
type MigrationItemSource = components["schemas"]["MigrationItemSource"];
|
|
19761
|
+
type MigrationItem = components["schemas"]["MigrationItem"];
|
|
19762
|
+
type MigrationEstimate = components["schemas"]["MigrationEstimate"];
|
|
19763
|
+
type MigrationSummary = components["schemas"]["MigrationSummary"];
|
|
19764
|
+
type Migration = components["schemas"]["Migration"];
|
|
19765
|
+
type MigrationList = components["schemas"]["MigrationList"];
|
|
19766
|
+
type CreateMigrationRequest = components["schemas"]["CreateMigrationRequest"];
|
|
19767
|
+
type RenameMigrationRequest = components["schemas"]["RenameMigrationRequest"];
|
|
19768
|
+
type UpdateMigrationItemRequest = components["schemas"]["UpdateMigrationItemRequest"];
|
|
19769
|
+
type MigrationTerraform = components["schemas"]["MigrationTerraform"];
|
|
18184
19770
|
|
|
18185
19771
|
type SpecMe = components["schemas"]["Me"];
|
|
18186
19772
|
/** The kind of API key: a standard key, or one handed to an AI app when it was connected. */
|
|
@@ -18208,6 +19794,72 @@ declare class MeResource extends APIResource {
|
|
|
18208
19794
|
revoke(options?: RequestOptions): Promise<void>;
|
|
18209
19795
|
}
|
|
18210
19796
|
|
|
19797
|
+
/**
|
|
19798
|
+
* Move from another cloud: connect an AWS account through a read-only role
|
|
19799
|
+
* (no access keys are shared), scan what runs there, and plan the move to
|
|
19800
|
+
* Pantech with a price comparison and a Terraform export.
|
|
19801
|
+
*/
|
|
19802
|
+
declare class Migrate extends APIResource {
|
|
19803
|
+
/** Connections to AWS accounts through a read-only role only Pantech can assume. */
|
|
19804
|
+
readonly connections: CloudConnections;
|
|
19805
|
+
/** Reads of everything a connection's role can see. */
|
|
19806
|
+
readonly scans: CloudScans;
|
|
19807
|
+
/** Plans to move what a scan found to Pantech. Nothing is created until you apply the Terraform. */
|
|
19808
|
+
readonly migrations: Migrations;
|
|
19809
|
+
}
|
|
19810
|
+
declare class CloudConnections extends APIResource {
|
|
19811
|
+
list(params?: ListParams<"listCloudConnections">, options?: RequestOptions): Promise<ResponseOf<"listCloudConnections">>;
|
|
19812
|
+
listAll(params?: ListAllParams<"listCloudConnections">, options?: RequestOptions): AsyncGenerator<ItemOf<"listCloudConnections">>;
|
|
19813
|
+
/**
|
|
19814
|
+
* Starts a connection. Its `setup` holds the CloudFormation template (and,
|
|
19815
|
+
* when offered, a one-click `quick_create_url`) that creates the read-only
|
|
19816
|
+
* role in your AWS account; send the stack's `RoleArn` output with `update`.
|
|
19817
|
+
*/
|
|
19818
|
+
create(body: BodyOf<"createCloudConnection">, options?: RequestOptions): Promise<ResponseOf<"createCloudConnection">>;
|
|
19819
|
+
get(connectionId: string, options?: RequestOptions): Promise<ResponseOf<"getCloudConnection">>;
|
|
19820
|
+
/** Renames the connection, sets its `role_arn`, or retries a failed check (`retry: true`). */
|
|
19821
|
+
update(connectionId: string, body: BodyOf<"updateCloudConnection">, options?: RequestOptions): Promise<ResponseOf<"updateCloudConnection">>;
|
|
19822
|
+
/** Removes the connection and its scans; plans made from it stay. Delete the stack in AWS to revoke the role there. */
|
|
19823
|
+
delete(connectionId: string, options?: RequestOptions): Promise<void>;
|
|
19824
|
+
/**
|
|
19825
|
+
* Polls the connection until it is `connected` (resolves with it) or its
|
|
19826
|
+
* check fails (rejects with CloudFailedError). Set the role ARN with
|
|
19827
|
+
* `update` first. Default timeout 10 minutes, polling every 5 seconds.
|
|
19828
|
+
*/
|
|
19829
|
+
wait(connectionId: string, options?: WaitOptions<CloudConnection>): Promise<CloudConnection>;
|
|
19830
|
+
}
|
|
19831
|
+
declare class CloudScans extends APIResource {
|
|
19832
|
+
/** A connection's scans, newest first, without their inventories. */
|
|
19833
|
+
list(connectionId: string, params?: ListParams<"listCloudScans">, options?: RequestOptions): Promise<ResponseOf<"listCloudScans">>;
|
|
19834
|
+
listAll(connectionId: string, params?: ListAllParams<"listCloudScans">, options?: RequestOptions): AsyncGenerator<ItemOf<"listCloudScans">>;
|
|
19835
|
+
/** Queues a scan of a connected account. Follow it with `wait`. */
|
|
19836
|
+
start(connectionId: string, options?: RequestOptions): Promise<ResponseOf<"startCloudScan">>;
|
|
19837
|
+
/** A scan's status and counts. Pass `{ include: "inventory" }` for everything it found. */
|
|
19838
|
+
get(scanId: string, params?: QueryOf<"getCloudScan">, options?: RequestOptions): Promise<ResponseOf<"getCloudScan">>;
|
|
19839
|
+
/**
|
|
19840
|
+
* Polls the scan until it `succeeded` (resolves with it, without its
|
|
19841
|
+
* inventory) or failed (rejects with CloudFailedError). Default timeout 30
|
|
19842
|
+
* minutes, polling every 10 seconds.
|
|
19843
|
+
*/
|
|
19844
|
+
wait(scanId: string, options?: WaitOptions<CloudScan>): Promise<CloudScan>;
|
|
19845
|
+
}
|
|
19846
|
+
declare class Migrations extends APIResource {
|
|
19847
|
+
/** Your migration plans, newest first, without their items or estimate. */
|
|
19848
|
+
list(params?: ListParams<"listMigrations">, options?: RequestOptions): Promise<ResponseOf<"listMigrations">>;
|
|
19849
|
+
listAll(params?: ListAllParams<"listMigrations">, options?: RequestOptions): AsyncGenerator<ItemOf<"listMigrations">>;
|
|
19850
|
+
/** Builds a plan, with a price comparison, from a scan that succeeded. Nothing is created on Pantech. */
|
|
19851
|
+
create(body: BodyOf<"createMigration">, options?: RequestOptions): Promise<ResponseOf<"createMigration">>;
|
|
19852
|
+
/** A plan with every item, and a price comparison computed now. */
|
|
19853
|
+
get(migrationId: string, options?: RequestOptions): Promise<ResponseOf<"getMigration">>;
|
|
19854
|
+
rename(migrationId: string, body: BodyOf<"renameMigration">, options?: RequestOptions): Promise<ResponseOf<"renameMigration">>;
|
|
19855
|
+
/** Deletes the plan. Nothing on Pantech or in the other cloud is touched. */
|
|
19856
|
+
delete(migrationId: string, options?: RequestOptions): Promise<void>;
|
|
19857
|
+
/** Changes one item, named by its `key`: exclude it, or change its plan, size, range, role or email. */
|
|
19858
|
+
updateItem(migrationId: string, body: BodyOf<"updateMigrationItem">, options?: RequestOptions): Promise<ResponseOf<"updateMigrationItem">>;
|
|
19859
|
+
/** The plan's planned items as Terraform: `main.tf` and `variables.tf`. */
|
|
19860
|
+
exportTerraform(migrationId: string, options?: RequestOptions): Promise<ResponseOf<"exportMigrationTerraform">>;
|
|
19861
|
+
}
|
|
19862
|
+
|
|
18211
19863
|
/** VPC networks. */
|
|
18212
19864
|
declare class Networks extends APIResource {
|
|
18213
19865
|
/** A network's subnets: `client.networks.subnets.list(networkId)`. */
|
|
@@ -18344,6 +19996,15 @@ declare class OrderFailedError extends PantechError {
|
|
|
18344
19996
|
constructor(message: string, order: unknown, init?: PantechErrorInit);
|
|
18345
19997
|
}
|
|
18346
19998
|
/** Waiting for an operation or order took longer than `timeoutMs`. */
|
|
19999
|
+
/** A cloud connection's check or a scan ended `failed`. `code` is stable; `detail` says what to do. */
|
|
20000
|
+
declare class CloudFailedError extends PantechError {
|
|
20001
|
+
name: string;
|
|
20002
|
+
/** `connection` or `scan`. */
|
|
20003
|
+
readonly kind: "connection" | "scan";
|
|
20004
|
+
/** The failed connection or scan, as the API returned it. */
|
|
20005
|
+
readonly resource: unknown;
|
|
20006
|
+
constructor(message: string, kind: "connection" | "scan", resource: unknown, init?: PantechErrorInit);
|
|
20007
|
+
}
|
|
18347
20008
|
declare class WaitTimeoutError extends PantechError {
|
|
18348
20009
|
name: string;
|
|
18349
20010
|
}
|
|
@@ -18592,6 +20253,8 @@ declare class Pantech {
|
|
|
18592
20253
|
readonly databaseOrders: DatabaseOrders;
|
|
18593
20254
|
readonly sshKeys: SshKeys;
|
|
18594
20255
|
readonly webhooks: Webhooks;
|
|
20256
|
+
/** Move from another cloud: connections, scans and migration plans. */
|
|
20257
|
+
readonly migrate: Migrate;
|
|
18595
20258
|
readonly operations: Operations;
|
|
18596
20259
|
constructor(options?: ClientOptions);
|
|
18597
20260
|
/**
|
|
@@ -18614,7 +20277,7 @@ interface Page<T> {
|
|
|
18614
20277
|
declare function paginate<T>(fetchPage: (cursor: string | undefined) => Promise<Page<T>>, startCursor?: string | null): AsyncGenerator<T, void, undefined>;
|
|
18615
20278
|
|
|
18616
20279
|
/** The SDK's version, sent in `User-Agent: pantech-js/<version>`. Kept in step with package.json. */
|
|
18617
|
-
declare const VERSION = "0.
|
|
20280
|
+
declare const VERSION = "0.2.0";
|
|
18618
20281
|
|
|
18619
20282
|
/** The header a delivery's signature arrives in. */
|
|
18620
20283
|
declare const WEBHOOK_SIGNATURE_HEADER = "Pantech-Signature";
|
|
@@ -18649,4 +20312,4 @@ declare function signWebhook(options: {
|
|
|
18649
20312
|
timestamp?: number;
|
|
18650
20313
|
}): Promise<string>;
|
|
18651
20314
|
|
|
18652
|
-
export { APIConnectionError, type APIKeyKind, type APIKeyScope, type APIRequest, APITimeoutError, type Accepted, type AttachPublicIPRequest, type AttachVolumeRequest, AuthenticationError, BadRequestError, type BodyOf, type ChangeDatabasePasswordRequest, type ChangeSSHKeyRequest, type ChangeSecurityGroupRequest, type ClientOptions, type ConfigureKubernetesEndpointAccessRequest, ConflictError, type CreateCreditPurchaseRequest, type CreateDatabaseRequest, type CreateFirewallRuleRequest, type CreateInstanceRequest, type CreateKubernetesClusterRequest, type CreateKubernetesNodePoolRequest, type CreateLoadBalancerRequest, type CreateNetworkRequest, type CreatePortForwardingRuleRequest, type CreatePublicIPRequest, type CreateSSHKeyRequest, type CreateSecurityGroupRequest, type CreateSnapshotRequest, type CreateSubnetRequest, type CreateVolumeRequest, type CreateWebhookRequest, type CreditOutlook, type CreditPurchase, DEFAULT_BASE_URL, DEFAULT_WEBHOOK_TOLERANCE_SECONDS, type Database, type DatabaseAccessRule, type DatabaseAccessRuleRequest, type DatabaseEffectiveAccessRule, type DatabaseEngine, type DatabaseEngineList, type DatabaseIgnoredSecurityGroupRule, type DatabaseList, type DatabaseOrder, type DatabaseOrderAccepted, type DatabaseOrderList, type DatabasePasswordAccepted, type DiskOffering, type DiskOfferingList, type Failure, type FieldError, type FirewallRule, type FirewallRuleFields, type FirewallRuleList, type GeneratedSSHKey, type HTTPMethod, type Image, type ImageList, type Instance, type InstanceList, type InstanceOrder, type InstanceOrderList, InternalServerError, type ItemOf, type Kubeconfig, type KubernetesAutoscaling, type KubernetesCluster, type KubernetesClusterAddon, type KubernetesClusterAddonList, type KubernetesClusterList, type KubernetesNode, type KubernetesNodePool, type KubernetesNodePoolList, type KubernetesNodePoolTaint, type KubernetesVersion, type KubernetesVersionList, type ListAllParams, type ListParams, type LoadBalancer, type LoadBalancerList, type LoadBalancerMember, type Me, type MetricsSeries, type MonthlyQuote, type Network, type NetworkList, NotFoundError, type Operation, OperationFailedError, type OperationId, type OperationRef, type OptionalQuote, type OrderAccepted, OrderFailedError, type OrderRef, type OrderWaitOptions, type Page, Pantech, PantechError, type PantechErrorInit, PaymentRequiredError, PermissionDeniedError, type Plan, type PlanList, type PortForwardingRule, type PortForwardingRuleList, type PricingEstimate, type PricingEstimateRequest, type Problem, type PublicIP, type PublicIPList, type PutSnapshotScheduleRequest, type QueryOf, RateLimitError, type RebuildRequest, type Receipt, type ReceiptList, type Region, type RegionList, type RenameRequest, type ReplaceDatabaseAccessRulesRequest, type ReplaceSecurityGroupRulesRequest, type RequestOptions, type ResizeDatabaseStorageRequest, type ResizeKubernetesClusterPlanRequest, type ResizeRequest, type ResizeVolumeRequest, type ResponseOf, type RestoreRequest, type RestoreSnapshotRequest, type SSHAccessGrant, type SSHKey, type SSHKeyList, type ScaleKubernetesNodePoolRequest, type Schemas, type SecurityGroup, type SecurityGroupList, type SecurityGroupRule, type SetDatabaseSecurityGroupsRequest, type Snapshot, type SnapshotList, type SnapshotSchedule, type Subnet, type SubnetList, type ToggleKubernetesAddonRequest, type UpdateKubernetesClusterRequest, type UpdateLoadBalancerRequest, type UpdateWebhookRequest, type UpgradeKubernetesClusterRequest, type UpgradeKubernetesNetworkRequest, type UsageByResource, type UsageSummary, VERSION, ValidationError, type VerifyWebhookOptions, type Volume, type VolumeList, WEBHOOK_SIGNATURE_HEADER, type WaitOptions, WaitTimeoutError, type Webhook, type WebhookBody, type WebhookDelivery, type WebhookDeliveryDetail, type WebhookDeliveryList, type WebhookEvent, type WebhookEventType, type WebhookEventTypeList, type WebhookList, WebhookVerificationError, type WebhookWithSecret, type components, isPantechError, type operations, paginate, type paths, signWebhook, verifyWebhook };
|
|
20315
|
+
export { APIConnectionError, type APIKeyKind, type APIKeyScope, type APIRequest, APITimeoutError, type Accepted, type AttachPublicIPRequest, type AttachVolumeRequest, AuthenticationError, BadRequestError, type BodyOf, type ChangeDatabasePasswordRequest, type ChangeSSHKeyRequest, type ChangeSecurityGroupRequest, type ClientOptions, type CloudConnection, type CloudConnectionList, type CloudConnectionSetup, type CloudCost, type CloudCostMonth, CloudFailedError, type CloudFailure, type CloudInventory, type CloudScan, type CloudScanCounts, type CloudScanList, type ConfigureKubernetesEndpointAccessRequest, ConflictError, type CreateCloudConnectionRequest, type CreateCreditPurchaseRequest, type CreateDatabaseRequest, type CreateFirewallRuleRequest, type CreateInstanceRequest, type CreateKubernetesClusterRequest, type CreateKubernetesNodePoolRequest, type CreateLoadBalancerRequest, type CreateMigrationRequest, type CreateNetworkRequest, type CreatePortForwardingRuleRequest, type CreatePublicIPRequest, type CreateSSHKeyRequest, type CreateSecurityGroupRequest, type CreateSnapshotRequest, type CreateSubnetRequest, type CreateVolumeRequest, type CreateWebhookRequest, type CreditOutlook, type CreditPurchase, DEFAULT_BASE_URL, DEFAULT_WEBHOOK_TOLERANCE_SECONDS, type Database, type DatabaseAccessRule, type DatabaseAccessRuleRequest, type DatabaseEffectiveAccessRule, type DatabaseEngine, type DatabaseEngineList, type DatabaseIgnoredSecurityGroupRule, type DatabaseList, type DatabaseOrder, type DatabaseOrderAccepted, type DatabaseOrderList, type DatabasePasswordAccepted, type DiskOffering, type DiskOfferingList, type Failure, type FieldError, type FirewallRule, type FirewallRuleFields, type FirewallRuleList, type GeneratedSSHKey, type HTTPMethod, type Image, type ImageList, type Instance, type InstanceList, type InstanceOrder, type InstanceOrderList, InternalServerError, type ItemOf, type Kubeconfig, type KubernetesAutoscaling, type KubernetesCluster, type KubernetesClusterAddon, type KubernetesClusterAddonList, type KubernetesClusterList, type KubernetesNode, type KubernetesNodePool, type KubernetesNodePoolList, type KubernetesNodePoolTaint, type KubernetesVersion, type KubernetesVersionList, type ListAllParams, type ListParams, type LoadBalancer, type LoadBalancerList, type LoadBalancerMember, type Me, type MetricsSeries, type Migration, type MigrationEstimate, type MigrationFlag, type MigrationItem, type MigrationItemSource, type MigrationItemTarget, type MigrationList, type MigrationListener, type MigrationRule, type MigrationSummary, type MigrationTerraform, type MonthlyQuote, type Network, type NetworkList, NotFoundError, type Operation, OperationFailedError, type OperationId, type OperationRef, type OptionalQuote, type OrderAccepted, OrderFailedError, type OrderRef, type OrderWaitOptions, type Page, Pantech, PantechError, type PantechErrorInit, PaymentRequiredError, PermissionDeniedError, type Plan, type PlanList, type PortForwardingRule, type PortForwardingRuleList, type PricingEstimate, type PricingEstimateRequest, type Problem, type PublicIP, type PublicIPList, type PutSnapshotScheduleRequest, type QueryOf, RateLimitError, type RebuildRequest, type Receipt, type ReceiptList, type Region, type RegionList, type RenameMigrationRequest, type RenameRequest, type ReplaceDatabaseAccessRulesRequest, type ReplaceSecurityGroupRulesRequest, type RequestOptions, type ResizeDatabaseStorageRequest, type ResizeKubernetesClusterPlanRequest, type ResizeRequest, type ResizeVolumeRequest, type ResponseOf, type RestoreRequest, type RestoreSnapshotRequest, type SSHAccessGrant, type SSHKey, type SSHKeyList, type ScaleKubernetesNodePoolRequest, type Schemas, type SecurityGroup, type SecurityGroupList, type SecurityGroupRule, type SetDatabaseSecurityGroupsRequest, type Snapshot, type SnapshotList, type SnapshotSchedule, type Subnet, type SubnetList, type ToggleKubernetesAddonRequest, type UpdateCloudConnectionRequest, type UpdateKubernetesClusterRequest, type UpdateLoadBalancerRequest, type UpdateMigrationItemRequest, type UpdateWebhookRequest, type UpgradeKubernetesClusterRequest, type UpgradeKubernetesNetworkRequest, type UsageByResource, type UsageSummary, VERSION, ValidationError, type VerifyWebhookOptions, type Volume, type VolumeList, WEBHOOK_SIGNATURE_HEADER, type WaitOptions, WaitTimeoutError, type Webhook, type WebhookBody, type WebhookDelivery, type WebhookDeliveryDetail, type WebhookDeliveryList, type WebhookEvent, type WebhookEventType, type WebhookEventTypeList, type WebhookList, WebhookVerificationError, type WebhookWithSecret, type components, isPantechError, type operations, paginate, type paths, signWebhook, verifyWebhook };
|