@cycleplatform/api-client-typescript 0.1.14 → 0.1.15
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/package.json +1 -1
- package/src/generated/types.ts +518 -19
package/package.json
CHANGED
package/src/generated/types.ts
CHANGED
|
@@ -60,7 +60,14 @@ export interface paths {
|
|
|
60
60
|
* Update Account Invite
|
|
61
61
|
* @description Update a given invite.
|
|
62
62
|
*/
|
|
63
|
-
patch: operations["
|
|
63
|
+
patch: operations["updatePassword"];
|
|
64
|
+
};
|
|
65
|
+
"/v1/account/reset-password": {
|
|
66
|
+
/**
|
|
67
|
+
* Update Account Invite
|
|
68
|
+
* @description Update a given invite.
|
|
69
|
+
*/
|
|
70
|
+
post: operations["resetPassword"];
|
|
64
71
|
};
|
|
65
72
|
"/v1/account/2fa/setup": {
|
|
66
73
|
/**
|
|
@@ -924,6 +931,35 @@ export interface paths {
|
|
|
924
931
|
*/
|
|
925
932
|
post: operations["createProviderJob"];
|
|
926
933
|
};
|
|
934
|
+
"/v1/infrastructure/auto-scale/groups": {
|
|
935
|
+
/**
|
|
936
|
+
* Get Auto-Scale Groups list
|
|
937
|
+
* @description Requires the `autoscale-groups-manage` capability.
|
|
938
|
+
*/
|
|
939
|
+
get: operations["getAutoScaleGroups"];
|
|
940
|
+
/**
|
|
941
|
+
* Create Auto-Scale Group
|
|
942
|
+
* @description Requires the 'autoscale-groups-manage'
|
|
943
|
+
*/
|
|
944
|
+
post: operations["createAutoScaleGroup"];
|
|
945
|
+
};
|
|
946
|
+
"/v1/infrastructure/auto-scale/groups/{groupId}": {
|
|
947
|
+
/**
|
|
948
|
+
* Fetch Auto-Scale Group
|
|
949
|
+
* @description Requires the `autoscale-groups-view` capability.
|
|
950
|
+
*/
|
|
951
|
+
get: operations["getAutoScaleGroup"];
|
|
952
|
+
/**
|
|
953
|
+
* Remove Auto-Scale Group
|
|
954
|
+
* @description Requires the `autoscale-group-manage` capability.
|
|
955
|
+
*/
|
|
956
|
+
delete: operations["removeAutoScaleGroup"];
|
|
957
|
+
/**
|
|
958
|
+
* Update Auto-Scale Group
|
|
959
|
+
* @description Requires the `autoscale-groups-manage` capability.
|
|
960
|
+
*/
|
|
961
|
+
patch: operations["updateAutoScaleGroup"];
|
|
962
|
+
};
|
|
927
963
|
"/v1/infrastructure/servers": {
|
|
928
964
|
/**
|
|
929
965
|
* List Servers
|
|
@@ -1322,6 +1358,7 @@ export interface components {
|
|
|
1322
1358
|
/**
|
|
1323
1359
|
* ID
|
|
1324
1360
|
* @description A 24 character hex string used to identify a unique resource.
|
|
1361
|
+
* @example 651586fca6078e98982dbd90
|
|
1325
1362
|
*/
|
|
1326
1363
|
ID: string;
|
|
1327
1364
|
/**
|
|
@@ -2024,8 +2061,6 @@ export interface components {
|
|
|
2024
2061
|
TaskDescriptor: {
|
|
2025
2062
|
/** @description The action that was taken. */
|
|
2026
2063
|
action: string;
|
|
2027
|
-
/** @description The ID of the job associated with this task. */
|
|
2028
|
-
job_id?: string;
|
|
2029
2064
|
/** @description Contains some basic information about the job associated with this task. */
|
|
2030
2065
|
job?: {
|
|
2031
2066
|
/** @description The ID of the job */
|
|
@@ -2159,6 +2194,8 @@ export interface components {
|
|
|
2159
2194
|
advanced_features: {
|
|
2160
2195
|
gpu: boolean;
|
|
2161
2196
|
ial: boolean;
|
|
2197
|
+
glb: boolean;
|
|
2198
|
+
autoscale: boolean;
|
|
2162
2199
|
};
|
|
2163
2200
|
max_daily_api_requests: number | null;
|
|
2164
2201
|
ram: components["schemas"]["BillingRam"];
|
|
@@ -3561,6 +3598,98 @@ export interface components {
|
|
|
3561
3598
|
web_hook?: string;
|
|
3562
3599
|
};
|
|
3563
3600
|
};
|
|
3601
|
+
/**
|
|
3602
|
+
* ScaleThresholdMetricRam
|
|
3603
|
+
* @description Describes the RAM threshold at which scaling will occur
|
|
3604
|
+
*/
|
|
3605
|
+
ScaleThresholdMetricRam: {
|
|
3606
|
+
/** @enum {string} */
|
|
3607
|
+
type: "ram";
|
|
3608
|
+
details: {
|
|
3609
|
+
/**
|
|
3610
|
+
* @description The limit (maximum) amount of RAM each instance of the given container can use before triggering a scaling event.
|
|
3611
|
+
* @example 1G, 2M
|
|
3612
|
+
*/
|
|
3613
|
+
used: string;
|
|
3614
|
+
};
|
|
3615
|
+
};
|
|
3616
|
+
/**
|
|
3617
|
+
* ScaleThresholdMetricCpu
|
|
3618
|
+
* @description Describes the CPU threshold at which scaling will occur
|
|
3619
|
+
*/
|
|
3620
|
+
ScaleThresholdMetricCpu: {
|
|
3621
|
+
/** @enum {string} */
|
|
3622
|
+
type: "cpu";
|
|
3623
|
+
details: {
|
|
3624
|
+
utilization: number;
|
|
3625
|
+
};
|
|
3626
|
+
};
|
|
3627
|
+
/**
|
|
3628
|
+
* ScaleThresholdMetricNetworkConnections
|
|
3629
|
+
* @description Describes the network connections threshold at which scaling will occur
|
|
3630
|
+
*/
|
|
3631
|
+
ScaleThresholdMetricNetworkConnections: {
|
|
3632
|
+
/** @enum {string} */
|
|
3633
|
+
type: "network-connections";
|
|
3634
|
+
details: {
|
|
3635
|
+
connections_total: number;
|
|
3636
|
+
};
|
|
3637
|
+
};
|
|
3638
|
+
/**
|
|
3639
|
+
* ScaleThresholdMetricNetworkRequests
|
|
3640
|
+
* @description Describes the network requests threshold at which scaling will occur
|
|
3641
|
+
*/
|
|
3642
|
+
ScaleThresholdMetricNetworkRequests: {
|
|
3643
|
+
/** @enum {string} */
|
|
3644
|
+
type: "network-requests";
|
|
3645
|
+
details: {
|
|
3646
|
+
requests_total: number;
|
|
3647
|
+
};
|
|
3648
|
+
};
|
|
3649
|
+
/**
|
|
3650
|
+
* ScaleThresholdMetricNetworkThroughput
|
|
3651
|
+
* @description Describes the network throughput threshold at which scaling will occur
|
|
3652
|
+
*/
|
|
3653
|
+
ScaleThresholdMetricNetworkThroughput: {
|
|
3654
|
+
/** @enum {string} */
|
|
3655
|
+
type: "network-throughput";
|
|
3656
|
+
details: {
|
|
3657
|
+
private: boolean;
|
|
3658
|
+
/**
|
|
3659
|
+
* @description The limit (maximum) amount of throughput each instance of the given container can use before triggering a scaling event.
|
|
3660
|
+
* @example 1G, 2M
|
|
3661
|
+
*/
|
|
3662
|
+
bandwidth: string;
|
|
3663
|
+
};
|
|
3664
|
+
};
|
|
3665
|
+
/**
|
|
3666
|
+
* ScaleThresholdMetric
|
|
3667
|
+
* @description Discriminated union describing the different types of scaling threshold and their respective details
|
|
3668
|
+
*/
|
|
3669
|
+
ScaleThresholdMetric: components["schemas"]["ScaleThresholdMetricRam"] | components["schemas"]["ScaleThresholdMetricCpu"] | components["schemas"]["ScaleThresholdMetricNetworkConnections"] | components["schemas"]["ScaleThresholdMetricNetworkRequests"] | components["schemas"]["ScaleThresholdMetricNetworkThroughput"];
|
|
3670
|
+
/**
|
|
3671
|
+
* ContainerScale
|
|
3672
|
+
* @description Network configuration for a container.
|
|
3673
|
+
*/
|
|
3674
|
+
ContainerScale: {
|
|
3675
|
+
/** @description The autoscaling group describes which servers should be deployed */
|
|
3676
|
+
autoscale_group: string;
|
|
3677
|
+
/** @description Describes how many instances should be running */
|
|
3678
|
+
instances: {
|
|
3679
|
+
/** @description Number of additional instances the auto-scaler will add/subtract per scaling event */
|
|
3680
|
+
delta: number;
|
|
3681
|
+
/** @description Maximum additional instances the auto-scaler will run at any time */
|
|
3682
|
+
max: number;
|
|
3683
|
+
/** @description Minimum number of instances per server */
|
|
3684
|
+
max_server: number;
|
|
3685
|
+
/** @description Minimum amount of time an instance will live */
|
|
3686
|
+
min_ttl: components["schemas"]["Duration"];
|
|
3687
|
+
};
|
|
3688
|
+
/** @description Duration in which the auto-scaler will watch for changes */
|
|
3689
|
+
window: components["schemas"]["Duration"];
|
|
3690
|
+
/** @description An array of rules that dictate when a scaling event will be triggered */
|
|
3691
|
+
thresholds: components["schemas"]["ScaleThresholdMetric"][];
|
|
3692
|
+
};
|
|
3564
3693
|
/**
|
|
3565
3694
|
* SeccompRule
|
|
3566
3695
|
* @description Rules for controlling Linux seccomp inside a container.
|
|
@@ -3596,7 +3725,7 @@ export interface components {
|
|
|
3596
3725
|
args: string;
|
|
3597
3726
|
};
|
|
3598
3727
|
/** @description Namespaces the given container will have access to. */
|
|
3599
|
-
namespaces?: ("ipc" | "pid" | "uts" | "network" | "mount" | "user")[];
|
|
3728
|
+
namespaces?: ("ipc" | "pid" | "uts" | "network" | "mount" | "user" | "cgroup")[];
|
|
3600
3729
|
/** @description A record of environment variables for the given container. */
|
|
3601
3730
|
environment_vars?: {
|
|
3602
3731
|
[key: string]: string | undefined;
|
|
@@ -3734,6 +3863,7 @@ export interface components {
|
|
|
3734
3863
|
Config: {
|
|
3735
3864
|
network: components["schemas"]["ContainerNetwork"];
|
|
3736
3865
|
deploy: components["schemas"]["ContainerDeploy"];
|
|
3866
|
+
scale?: components["schemas"]["ContainerScale"];
|
|
3737
3867
|
runtime?: components["schemas"]["ContainerRuntime"];
|
|
3738
3868
|
resources?: components["schemas"]["ContainerResources"];
|
|
3739
3869
|
integrations?: components["schemas"]["ContainerIntegrations"];
|
|
@@ -4571,20 +4701,98 @@ export interface components {
|
|
|
4571
4701
|
disable: boolean;
|
|
4572
4702
|
};
|
|
4573
4703
|
};
|
|
4574
|
-
/**
|
|
4575
|
-
|
|
4576
|
-
|
|
4577
|
-
|
|
4578
|
-
|
|
4579
|
-
|
|
4580
|
-
|
|
4581
|
-
|
|
4582
|
-
|
|
4583
|
-
|
|
4584
|
-
|
|
4585
|
-
|
|
4704
|
+
/**
|
|
4705
|
+
* StackContainerScaleThresholdRam
|
|
4706
|
+
* @description Describes the RAM threshold at which scaling will occur
|
|
4707
|
+
*/
|
|
4708
|
+
StackContainerScaleThresholdRam: {
|
|
4709
|
+
/** @enum {string} */
|
|
4710
|
+
type: "ram";
|
|
4711
|
+
details: {
|
|
4712
|
+
/**
|
|
4713
|
+
* @description The limit (maximum) amount of RAM each instance of the given container can use before triggering a scaling event.
|
|
4714
|
+
* @example 1G, 2M
|
|
4715
|
+
*/
|
|
4716
|
+
used: string;
|
|
4717
|
+
};
|
|
4718
|
+
};
|
|
4719
|
+
/**
|
|
4720
|
+
* StackContainerScaleThresholdCpu
|
|
4721
|
+
* @description Describes the CPU threshold at which scaling will occur
|
|
4722
|
+
*/
|
|
4723
|
+
StackContainerScaleThresholdCpu: {
|
|
4724
|
+
/** @enum {string} */
|
|
4725
|
+
type: "cpu";
|
|
4726
|
+
details: {
|
|
4727
|
+
utilization: number;
|
|
4728
|
+
};
|
|
4729
|
+
};
|
|
4730
|
+
/**
|
|
4731
|
+
* StackContainerScaleThresholdNetworkConnections
|
|
4732
|
+
* @description Describes the network connections threshold at which scaling will occur
|
|
4733
|
+
*/
|
|
4734
|
+
StackContainerScaleThresholdNetworkConnections: {
|
|
4735
|
+
/** @enum {string} */
|
|
4736
|
+
type: "network-connections";
|
|
4737
|
+
details: {
|
|
4738
|
+
connections_total: number;
|
|
4739
|
+
};
|
|
4740
|
+
};
|
|
4741
|
+
/**
|
|
4742
|
+
* StackContainerScaleThresholdNetworkRequests
|
|
4743
|
+
* @description Describes the network requests threshold at which scaling will occur
|
|
4744
|
+
*/
|
|
4745
|
+
StackContainerScaleThresholdNetworkRequests: {
|
|
4746
|
+
/** @enum {string} */
|
|
4747
|
+
type: "network-requests";
|
|
4748
|
+
details: {
|
|
4749
|
+
requests_total: number;
|
|
4750
|
+
};
|
|
4751
|
+
};
|
|
4752
|
+
/**
|
|
4753
|
+
* StackContainerScaleThresholdNetworkThroughput
|
|
4754
|
+
* @description Describes the network throughput threshold at which scaling will occur
|
|
4755
|
+
*/
|
|
4756
|
+
StackContainerScaleThresholdNetworkThroughput: {
|
|
4757
|
+
/** @enum {string} */
|
|
4758
|
+
type: "network-throughput";
|
|
4759
|
+
details: {
|
|
4760
|
+
private: boolean;
|
|
4761
|
+
/**
|
|
4762
|
+
* @description The limit (maximum) amount of throughput each instance of the given container can use before triggering a scaling event.
|
|
4763
|
+
* @example 1G, 2M
|
|
4764
|
+
*/
|
|
4765
|
+
bandwidth: string;
|
|
4586
4766
|
};
|
|
4587
4767
|
};
|
|
4768
|
+
/**
|
|
4769
|
+
* StackContainerScaleThreshold
|
|
4770
|
+
* @description Discriminated union describing the different types of scaling threshold and their respective details
|
|
4771
|
+
*/
|
|
4772
|
+
StackContainerScaleThreshold: components["schemas"]["StackContainerScaleThresholdRam"] | components["schemas"]["StackContainerScaleThresholdCpu"] | components["schemas"]["StackContainerScaleThresholdNetworkConnections"] | components["schemas"]["StackContainerScaleThresholdNetworkRequests"] | components["schemas"]["StackContainerScaleThresholdNetworkThroughput"];
|
|
4773
|
+
/**
|
|
4774
|
+
* StackContainerConfigScaling.yml
|
|
4775
|
+
* @description Network configuration for a container.
|
|
4776
|
+
*/
|
|
4777
|
+
StackContainerConfigScaling: {
|
|
4778
|
+
/** @description The autoscaling group describes which servers should be deployed */
|
|
4779
|
+
autoscale_group: string;
|
|
4780
|
+
/** @description Describes how many instances should be running */
|
|
4781
|
+
instances: {
|
|
4782
|
+
/** @description Number of additional instances the auto-scaler will add/subtract per scaling event */
|
|
4783
|
+
delta: number;
|
|
4784
|
+
/** @description Maximum additional instances the auto-scaler will run at any time */
|
|
4785
|
+
max: number;
|
|
4786
|
+
/** @description Minimum number of instances per server */
|
|
4787
|
+
max_server: number;
|
|
4788
|
+
/** @description Minimum amount of time an instance will live */
|
|
4789
|
+
min_ttl: components["schemas"]["Duration"];
|
|
4790
|
+
};
|
|
4791
|
+
/** @description Duration in which the auto-scaler will watch for changes */
|
|
4792
|
+
window: components["schemas"]["Duration"];
|
|
4793
|
+
/** @description An array of rules that dictate when a scaling event will be triggered */
|
|
4794
|
+
thresholds: components["schemas"]["StackContainerScaleThreshold"][];
|
|
4795
|
+
};
|
|
4588
4796
|
/** StackContainerConfigIntegrations */
|
|
4589
4797
|
StackContainerConfigIntegrations: {
|
|
4590
4798
|
webhooks?: {
|
|
@@ -5196,6 +5404,16 @@ export interface components {
|
|
|
5196
5404
|
cluster: string;
|
|
5197
5405
|
features: components["schemas"]["ServerFeatures"];
|
|
5198
5406
|
constraints: components["schemas"]["ServerConstraints"];
|
|
5407
|
+
autoscale: {
|
|
5408
|
+
group_id: components["schemas"]["ID"];
|
|
5409
|
+
} | null;
|
|
5410
|
+
/** @description Set to true when a server is created as part of an auto-scale event. */
|
|
5411
|
+
ephemeral: boolean;
|
|
5412
|
+
/** @description Details about a server's evacuation status. When an evacuation is in progress, no new container instances will be permitted on the server. */
|
|
5413
|
+
evacuate?: {
|
|
5414
|
+
/** @description The time when this server began evacuating instances. */
|
|
5415
|
+
started: components["schemas"]["DateTime"];
|
|
5416
|
+
} | null;
|
|
5199
5417
|
state: components["schemas"]["ServerState"];
|
|
5200
5418
|
/**
|
|
5201
5419
|
* ServerEvents
|
|
@@ -5208,10 +5426,14 @@ export interface components {
|
|
|
5208
5426
|
updated: components["schemas"]["DateTime"];
|
|
5209
5427
|
/** @description The timestamp of when the server was deleted. */
|
|
5210
5428
|
deleted: components["schemas"]["DateTime"];
|
|
5429
|
+
/** @description The timestamp of when the latest instance was deployed to this server. */
|
|
5430
|
+
latest_instance: components["schemas"]["DateTime"];
|
|
5211
5431
|
/** @description Information about the provisioning of the server. */
|
|
5212
5432
|
provisioning: {
|
|
5213
5433
|
/** @description A timestamp of when the server started provisioning. */
|
|
5214
5434
|
started: components["schemas"]["DateTime"];
|
|
5435
|
+
/** @description A timestamp of when the server failed provisioning. */
|
|
5436
|
+
failed: components["schemas"]["DateTime"];
|
|
5215
5437
|
/** @description A timestamp of when the server completed provisioning. */
|
|
5216
5438
|
completed: components["schemas"]["DateTime"];
|
|
5217
5439
|
};
|
|
@@ -5254,6 +5476,7 @@ export interface components {
|
|
|
5254
5476
|
location: string;
|
|
5255
5477
|
/** @description A location code returned from the provider. */
|
|
5256
5478
|
code: string;
|
|
5479
|
+
availability_zones?: string[];
|
|
5257
5480
|
};
|
|
5258
5481
|
/**
|
|
5259
5482
|
* InfrastructureProviderLocation
|
|
@@ -5511,6 +5734,14 @@ export interface components {
|
|
|
5511
5734
|
updated: components["schemas"]["DateTime"];
|
|
5512
5735
|
}) | null;
|
|
5513
5736
|
}) & components["schemas"]["State"];
|
|
5737
|
+
/**
|
|
5738
|
+
* InstanceAutoScale
|
|
5739
|
+
* @description Auto-scale details for instances created by auto-scale events
|
|
5740
|
+
*/
|
|
5741
|
+
InstanceAutoScale: {
|
|
5742
|
+
sibling_id: components["schemas"]["ID"];
|
|
5743
|
+
min_ttl: components["schemas"]["DateTime"];
|
|
5744
|
+
};
|
|
5514
5745
|
/**
|
|
5515
5746
|
* Instance
|
|
5516
5747
|
* @description A container instance resource.
|
|
@@ -5573,6 +5804,7 @@ export interface components {
|
|
|
5573
5804
|
*/
|
|
5574
5805
|
service: "discovery" | "vpn" | "loadbalancer" | null;
|
|
5575
5806
|
state: components["schemas"]["InstanceState"];
|
|
5807
|
+
autoscale: components["schemas"]["InstanceAutoScale"] | null;
|
|
5576
5808
|
/**
|
|
5577
5809
|
* InstanceEvents
|
|
5578
5810
|
* @description A collection of timestamps for each event in the instnaces lifetime.
|
|
@@ -6397,7 +6629,7 @@ export interface components {
|
|
|
6397
6629
|
* @description The activity event.
|
|
6398
6630
|
* @enum {string}
|
|
6399
6631
|
*/
|
|
6400
|
-
event: "hub.images.prune" | "hub.update" | "hub.create" | "hub.task.delete" | "hub.task.images.prune" | "environment.services.discovery.reconfigure" | "environment.services.lb.reconfigure" | "environment.services.vpn.reconfigure" | "environment.delete" | "environment.initialize" | "environment.start" | "environment.stop" | "environment.create" | "environment.update" | "environment.task.delete" | "environment.services.discovery.task.reconfigure" | "environment.services.lb.task.reconfigure" | "environment.services.vpn.task.reconfigure" | "environment.services.vpn.user.create" | "environment.services.vpn.login" | "environment.task.initialize" | "environment.task.start" | "environment.task.stop" | "environment.scoped-variable.delete" | "environment.scoped-variable.update" | "environment.scoped-variable.task.delete" | "environment.scoped-variable.create" | "image.delete" | "image.import" | "image.create" | "image.update" | "image.task.delete" | "image.task.import" | "image.source.delete" | "image.source.create" | "image.source.update" | "image.source.task.delete" | "billing.invoice.task.void" | "billing.invoice.task.credit" | "billing.invoice.task.refund" | "billing.invoice.pay" | "billing.invoice.task.pay" | "billing.order.confirm" | "billing.order.task.confirm" | "billing.method.update" | "billing.method.delete" | "billing.method.task.delete" | "billing.method.create" | "
|
|
6632
|
+
event: "hub.images.prune" | "hub.update" | "hub.create" | "hub.task.delete" | "hub.task.images.prune" | "environment.services.discovery.reconfigure" | "environment.services.lb.reconfigure" | "environment.services.vpn.reconfigure" | "environment.delete" | "environment.initialize" | "environment.start" | "environment.stop" | "environment.create" | "environment.update" | "environment.task.delete" | "environment.services.discovery.task.reconfigure" | "environment.services.lb.task.reconfigure" | "environment.services.vpn.task.reconfigure" | "environment.services.vpn.user.create" | "environment.services.vpn.login" | "environment.task.initialize" | "environment.task.start" | "environment.task.stop" | "environment.scoped-variable.delete" | "environment.scoped-variable.update" | "environment.scoped-variable.task.delete" | "environment.scoped-variable.create" | "image.delete" | "image.import" | "image.create" | "image.update" | "image.task.delete" | "image.task.import" | "image.source.delete" | "image.source.create" | "image.source.update" | "image.source.task.delete" | "billing.invoice.task.void" | "billing.invoice.task.credit" | "billing.invoice.task.refund" | "billing.invoice.pay" | "billing.invoice.task.pay" | "billing.order.confirm" | "billing.order.task.confirm" | "billing.method.update" | "billing.method.delete" | "billing.method.task.delete" | "billing.method.create" | "hub.apikey.update" | "hub.apikey.delete" | "hub.apikey.create" | "hub.membership.delete" | "hub.membership.create" | "hub.membership.update" | "container.initialize" | "container.task.start" | "container.start" | "container.task.stop" | "container.stop" | "container.task.reconfigure" | "container.reconfigure" | "container.task.reconfigure.volumes" | "container.reconfigure.volumes" | "container.create" | "container.restart" | "container.task.reimage" | "container.reimage" | "container.update" | "container.task.delete" | "container.delete" | "container.task.scale" | "container.scale" | "container.instances.create" | "container.instances.delete" | "container.instances.autoscale.up" | "container.instances.autoscale.down" | "container.instance.healthcheck.restarted" | "container.instance.error" | "container.instance.ssh.login" | "container.instance.migration.start" | "container.instance.migration.revert" | "container.instance.delete" | "container.instance.task.migrate_revert" | "container.instance.task.migrate" | "container.backup.create" | "container.backup.restore" | "container.backup.delete" | "container.backup.task.delete" | "container.backup.task.restore" | "dns.zone.verify" | "dns.zone.delete" | "dns.zone.task.verify" | "dns.zone.update" | "dns.zone.task.delete" | "dns.zone.create" | "dns.zone.record.delete" | "dns.zone.record.cert.generate" | "dns.zone.record.cert.generate.auto" | "dns.zone.record.task.cert.generate" | "dns.zone.record.update" | "dns.zone.record.task.delete" | "dns.zone.record.create" | "stack.update" | "stack.task.delete" | "stack.create" | "stack.task.prune" | "stack.build.create" | "stack.build.generate" | "stack.build.deploy" | "stack.build.delete" | "stack.build.task.delete" | "stack.build.task.generate" | "stack.build.task.deploy" | "infrastructure.provider.update" | "infrastructure.provider.task.delete" | "infrastructure.provider.create" | "infrastructure.provider.task.verify" | "infrastructure.server.task.delete" | "infrastructure.server.task.restart" | "infrastructure.server.services.sftp.auth" | "infrastructure.server.live" | "infrastructure.server.delete" | "infrastructure.server.restart" | "infrastructure.server.compute.restart" | "infrastructure.server.compute.spawner.restart" | "infrastructure.server.reconfigure.features" | "infrastructure.server.provision" | "infrastructure.server.console" | "infrastructure.server.update" | "infrastructure.server.task.provision" | "infrastructure.server.ssh.token" | "infrastructure.server.task.reconfigure.features" | "infrastructure.server.services.sftp.lockdown" | "infrastructure.server.services.internal-api.throttle" | "infrastructure.autoscale.group.create" | "infrastructure.autoscale.group.update" | "infrastructure.autoscale.group.task.delete" | "infrastructure.autoscale.group.delete" | "infrastructure.ips.pool.task.delete" | "sdn.network.update" | "sdn.network.task.delete" | "sdn.network.create" | "sdn.network.task.reconfigure" | "pipeline.delete" | "pipeline.trigger" | "pipeline.update" | "pipeline.task.delete" | "pipeline.create" | "pipeline.task.trigger" | "pipeline.key.update" | "pipeline.key.delete" | "pipeline.key.create";
|
|
6401
6633
|
/** @description A timestamp for when the activity took place. */
|
|
6402
6634
|
time: components["schemas"]["DateTime"];
|
|
6403
6635
|
};
|
|
@@ -7191,12 +7423,73 @@ export interface components {
|
|
|
7191
7423
|
/** @description An array of ips this trigger key is usable from. */
|
|
7192
7424
|
ips: string[];
|
|
7193
7425
|
};
|
|
7426
|
+
/** AutoScaleGroupScale */
|
|
7427
|
+
AutoScaleGroupScale: {
|
|
7428
|
+
/** AutoScaleGroupScaleDown */
|
|
7429
|
+
down?: {
|
|
7430
|
+
/** @description The minimum TTL for the server once deployed through an autoscale event. */
|
|
7431
|
+
min_ttl?: components["schemas"]["Duration"];
|
|
7432
|
+
/** @description The amount of time between last instance deployed and when the server can begin to get deleted. */
|
|
7433
|
+
inactivity_period?: components["schemas"]["Duration"];
|
|
7434
|
+
/** @enum {string} */
|
|
7435
|
+
method?: "fifo" | "lifo";
|
|
7436
|
+
};
|
|
7437
|
+
/** AutoScaleGroupScaleUp */
|
|
7438
|
+
up?: {
|
|
7439
|
+
maximum?: number;
|
|
7440
|
+
};
|
|
7441
|
+
};
|
|
7442
|
+
/** AutoScaleGroupInfrastructure */
|
|
7443
|
+
AutoScaleGroupInfrastructure: {
|
|
7444
|
+
models: {
|
|
7445
|
+
provider: string;
|
|
7446
|
+
model_id: string;
|
|
7447
|
+
priority: number;
|
|
7448
|
+
locations: {
|
|
7449
|
+
id: string;
|
|
7450
|
+
availability_zones: string[];
|
|
7451
|
+
}[];
|
|
7452
|
+
}[];
|
|
7453
|
+
};
|
|
7454
|
+
/** AutoScaleGroup */
|
|
7455
|
+
AutoScaleGroup: {
|
|
7456
|
+
id: string;
|
|
7457
|
+
name: string;
|
|
7458
|
+
identifier: string;
|
|
7459
|
+
creator: components["schemas"]["CreatorScope"];
|
|
7460
|
+
hub_id: string;
|
|
7461
|
+
cluster: string;
|
|
7462
|
+
scale?: components["schemas"]["AutoScaleGroupScale"];
|
|
7463
|
+
infrastructure: components["schemas"]["AutoScaleGroupInfrastructure"];
|
|
7464
|
+
/** AutoScaleGroupState */
|
|
7465
|
+
state: ({
|
|
7466
|
+
/**
|
|
7467
|
+
* @description The current state of the auto-scale group.
|
|
7468
|
+
* @enum {string}
|
|
7469
|
+
*/
|
|
7470
|
+
current: "new" | "live" | "deleting" | "deleted";
|
|
7471
|
+
}) & components["schemas"]["State"];
|
|
7472
|
+
/**
|
|
7473
|
+
* AutoScaleGroupEvents
|
|
7474
|
+
* @description A collection of timestamps for each event in the auto-scale group's lifetime.
|
|
7475
|
+
*/
|
|
7476
|
+
events: {
|
|
7477
|
+
/** @description The timestamp of when the auto-scale group was created. */
|
|
7478
|
+
created: components["schemas"]["DateTime"];
|
|
7479
|
+
/** @description The timestamp of when the auto-scale group was updated. */
|
|
7480
|
+
updated: components["schemas"]["DateTime"];
|
|
7481
|
+
/** @description The timestamp of when the auto-scale group was deleted. */
|
|
7482
|
+
deleted: components["schemas"]["DateTime"];
|
|
7483
|
+
/** @description The timestamp of when the auto-scale group was last synced. */
|
|
7484
|
+
last_sync: components["schemas"]["DateTime"];
|
|
7485
|
+
};
|
|
7486
|
+
};
|
|
7194
7487
|
/**
|
|
7195
7488
|
* ComponentIncludes
|
|
7196
7489
|
* @description A resource thats assocaited with activity.
|
|
7197
7490
|
*/
|
|
7198
7491
|
ComponentsIncludes: {
|
|
7199
|
-
[key: string]: (components["schemas"]["Container"] | components["schemas"]["Instance"] | components["schemas"]["Environment"] | components["schemas"]["Image"] | components["schemas"]["ImageSource"] | components["schemas"]["Server"] | components["schemas"]["Pool"] | components["schemas"]["Provider"] | components["schemas"]["Stack"] | components["schemas"]["StackBuild"] | components["schemas"]["Zone"] | components["schemas"]["Record"] | components["schemas"]["ApiKey"] | components["schemas"]["Network"] | components["schemas"]["HubMembership"] | components["schemas"]["Pipeline"] | components["schemas"]["TriggerKey"] | components["schemas"]["ScopedVariable"] | components["schemas"]["Hub"] | components["schemas"]["Invoice"] | components["schemas"]["Method"]) | undefined;
|
|
7492
|
+
[key: string]: (components["schemas"]["Container"] | components["schemas"]["Instance"] | components["schemas"]["Environment"] | components["schemas"]["Image"] | components["schemas"]["ImageSource"] | components["schemas"]["Server"] | components["schemas"]["Pool"] | components["schemas"]["Provider"] | components["schemas"]["Stack"] | components["schemas"]["StackBuild"] | components["schemas"]["Zone"] | components["schemas"]["Record"] | components["schemas"]["ApiKey"] | components["schemas"]["Network"] | components["schemas"]["HubMembership"] | components["schemas"]["Pipeline"] | components["schemas"]["TriggerKey"] | components["schemas"]["ScopedVariable"] | components["schemas"]["Hub"] | components["schemas"]["Invoice"] | components["schemas"]["Method"] | components["schemas"]["AutoScaleGroup"]) | undefined;
|
|
7200
7493
|
};
|
|
7201
7494
|
/**
|
|
7202
7495
|
* ActivityIncludes
|
|
@@ -7455,6 +7748,22 @@ export interface components {
|
|
|
7455
7748
|
};
|
|
7456
7749
|
features: string[];
|
|
7457
7750
|
};
|
|
7751
|
+
/**
|
|
7752
|
+
* ServerModelsIncludes
|
|
7753
|
+
* @description A resource associated with a server models.
|
|
7754
|
+
*/
|
|
7755
|
+
ServerModelsIncludes: {
|
|
7756
|
+
[key: string]: components["schemas"]["ProviderServer"] | undefined;
|
|
7757
|
+
};
|
|
7758
|
+
/**
|
|
7759
|
+
* AutoScaleGroupIncludes
|
|
7760
|
+
* @description All includable resource linkable to the given auto-scale group.
|
|
7761
|
+
*/
|
|
7762
|
+
AutoScaleGroupIncludes: {
|
|
7763
|
+
providers?: components["schemas"]["ProvidersIncludes"];
|
|
7764
|
+
models?: components["schemas"]["ServerModelsIncludes"];
|
|
7765
|
+
locations?: components["schemas"]["LocationsIncludes"];
|
|
7766
|
+
};
|
|
7458
7767
|
/** ServerStatsCpuUsageTelemetry */
|
|
7459
7768
|
ServerStatsCpuUsageTelemetry: {
|
|
7460
7769
|
/** Format: float */
|
|
@@ -8240,7 +8549,7 @@ export interface operations {
|
|
|
8240
8549
|
* Update Account Invite
|
|
8241
8550
|
* @description Update a given invite.
|
|
8242
8551
|
*/
|
|
8243
|
-
|
|
8552
|
+
updatePassword: {
|
|
8244
8553
|
/** @description Req body for updating account invite */
|
|
8245
8554
|
requestBody?: {
|
|
8246
8555
|
content: {
|
|
@@ -8264,6 +8573,38 @@ export interface operations {
|
|
|
8264
8573
|
default: components["responses"]["DefaultError"];
|
|
8265
8574
|
};
|
|
8266
8575
|
};
|
|
8576
|
+
/**
|
|
8577
|
+
* Update Account Invite
|
|
8578
|
+
* @description Update a given invite.
|
|
8579
|
+
*/
|
|
8580
|
+
resetPassword: {
|
|
8581
|
+
/** @description Req body for updating account invite */
|
|
8582
|
+
requestBody?: {
|
|
8583
|
+
content: {
|
|
8584
|
+
"application/json": OneOf<[{
|
|
8585
|
+
email: {
|
|
8586
|
+
address: string;
|
|
8587
|
+
};
|
|
8588
|
+
}, {
|
|
8589
|
+
token: string;
|
|
8590
|
+
password: string;
|
|
8591
|
+
}]>;
|
|
8592
|
+
};
|
|
8593
|
+
};
|
|
8594
|
+
responses: {
|
|
8595
|
+
/** @description Returns success true */
|
|
8596
|
+
200: {
|
|
8597
|
+
content: {
|
|
8598
|
+
"application/json": {
|
|
8599
|
+
data?: {
|
|
8600
|
+
success: boolean;
|
|
8601
|
+
};
|
|
8602
|
+
};
|
|
8603
|
+
};
|
|
8604
|
+
};
|
|
8605
|
+
default: components["responses"]["DefaultError"];
|
|
8606
|
+
};
|
|
8607
|
+
};
|
|
8267
8608
|
/**
|
|
8268
8609
|
* Get TwoFa setup info
|
|
8269
8610
|
* @description Get barcode and secret for TwoFa authentication
|
|
@@ -8956,6 +9297,8 @@ export interface operations {
|
|
|
8956
9297
|
* The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
|
|
8957
9298
|
*/
|
|
8958
9299
|
filter?: {
|
|
9300
|
+
/** @description `filter[creator]=account-ID` filter for environments matching a particular creator, such as `account-ID`. */
|
|
9301
|
+
creator?: string;
|
|
8959
9302
|
/** @description `filter[identifier]=value` List only those environments matching this identifier. May return multiple results. */
|
|
8960
9303
|
identifier?: string;
|
|
8961
9304
|
/** @description `filter[search]=value` search for a value associated with a field on the given environment(s). */
|
|
@@ -9731,6 +10074,8 @@ export interface operations {
|
|
|
9731
10074
|
* The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
|
|
9732
10075
|
*/
|
|
9733
10076
|
filter?: {
|
|
10077
|
+
/** @description `filter[creator]=account-ID` filter for containers matching a particular creator, such as `account-ID` or `environment-ID` */
|
|
10078
|
+
creator?: string;
|
|
9734
10079
|
/** @description `filter[identifier]=value` List only those containers matching this identifier. May return multiple results. */
|
|
9735
10080
|
identifier?: string;
|
|
9736
10081
|
/** @description `filter[search]=value` search containers for a value associated with a field on the given container(s). */
|
|
@@ -12364,6 +12709,160 @@ export interface operations {
|
|
|
12364
12709
|
default: components["responses"]["DefaultError"];
|
|
12365
12710
|
};
|
|
12366
12711
|
};
|
|
12712
|
+
/**
|
|
12713
|
+
* Get Auto-Scale Groups list
|
|
12714
|
+
* @description Requires the `autoscale-groups-manage` capability.
|
|
12715
|
+
*/
|
|
12716
|
+
getAutoScaleGroups: {
|
|
12717
|
+
parameters: {
|
|
12718
|
+
query?: {
|
|
12719
|
+
page?: components["parameters"]["PageParam"];
|
|
12720
|
+
/** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
|
|
12721
|
+
include?: ("providers" | "models" | "locations")[];
|
|
12722
|
+
/**
|
|
12723
|
+
* @description ## Filter Field
|
|
12724
|
+
* The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
|
|
12725
|
+
*/
|
|
12726
|
+
filter?: {
|
|
12727
|
+
/** @description `filter[search]=value` search for a value associated with a field on the given auto-scale group(s). */
|
|
12728
|
+
search?: string;
|
|
12729
|
+
/** @description `filter[cluster]=value` return a list of auto-scale groups that are associated with the specified cluster. */
|
|
12730
|
+
cluster?: string;
|
|
12731
|
+
/** @description `filter[identifier]=value` list only those auto-scale groups matching this identifier. May return multiple results. */
|
|
12732
|
+
identifier?: string;
|
|
12733
|
+
/** @description `filter[state]=value1,value2` state filtering will allow you to filter by the provider's current state. */
|
|
12734
|
+
state?: string;
|
|
12735
|
+
};
|
|
12736
|
+
};
|
|
12737
|
+
};
|
|
12738
|
+
responses: {
|
|
12739
|
+
/** @description A collection of autoscale group resources. */
|
|
12740
|
+
200: {
|
|
12741
|
+
content: {
|
|
12742
|
+
"application/json": {
|
|
12743
|
+
data?: components["schemas"]["AutoScaleGroup"][];
|
|
12744
|
+
includes?: components["schemas"]["AutoScaleGroupIncludes"];
|
|
12745
|
+
};
|
|
12746
|
+
};
|
|
12747
|
+
};
|
|
12748
|
+
default: components["responses"]["DefaultError"];
|
|
12749
|
+
};
|
|
12750
|
+
};
|
|
12751
|
+
/**
|
|
12752
|
+
* Create Auto-Scale Group
|
|
12753
|
+
* @description Requires the 'autoscale-groups-manage'
|
|
12754
|
+
*/
|
|
12755
|
+
createAutoScaleGroup: {
|
|
12756
|
+
/** @description Parameters for creating an auto-scale group */
|
|
12757
|
+
requestBody?: {
|
|
12758
|
+
content: {
|
|
12759
|
+
"application/json": {
|
|
12760
|
+
name: string;
|
|
12761
|
+
identifier: string;
|
|
12762
|
+
cluster: string;
|
|
12763
|
+
scale: components["schemas"]["AutoScaleGroupScale"];
|
|
12764
|
+
infrastructure: components["schemas"]["AutoScaleGroupInfrastructure"];
|
|
12765
|
+
};
|
|
12766
|
+
};
|
|
12767
|
+
};
|
|
12768
|
+
responses: {
|
|
12769
|
+
/** @description Returns an auto-scale group resource. */
|
|
12770
|
+
201: {
|
|
12771
|
+
content: {
|
|
12772
|
+
"application/json": {
|
|
12773
|
+
data?: components["schemas"]["AutoScaleGroup"];
|
|
12774
|
+
};
|
|
12775
|
+
};
|
|
12776
|
+
};
|
|
12777
|
+
default: components["responses"]["DefaultError"];
|
|
12778
|
+
};
|
|
12779
|
+
};
|
|
12780
|
+
/**
|
|
12781
|
+
* Fetch Auto-Scale Group
|
|
12782
|
+
* @description Requires the `autoscale-groups-view` capability.
|
|
12783
|
+
*/
|
|
12784
|
+
getAutoScaleGroup: {
|
|
12785
|
+
parameters: {
|
|
12786
|
+
query?: {
|
|
12787
|
+
/** @description A comma separated list of include values. Included resources will show up under the root document's `include` field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return. */
|
|
12788
|
+
include?: ("providers" | "models" | "locations")[];
|
|
12789
|
+
};
|
|
12790
|
+
path: {
|
|
12791
|
+
/** @description The ID for the given auto-scale group. */
|
|
12792
|
+
groupId: string;
|
|
12793
|
+
};
|
|
12794
|
+
};
|
|
12795
|
+
responses: {
|
|
12796
|
+
/** @description A single auto-scale group resource. */
|
|
12797
|
+
200: {
|
|
12798
|
+
content: {
|
|
12799
|
+
"application/json": {
|
|
12800
|
+
data?: components["schemas"]["AutoScaleGroup"];
|
|
12801
|
+
includes?: components["schemas"]["AutoScaleGroupIncludes"];
|
|
12802
|
+
};
|
|
12803
|
+
};
|
|
12804
|
+
};
|
|
12805
|
+
default: components["responses"]["DefaultError"];
|
|
12806
|
+
};
|
|
12807
|
+
};
|
|
12808
|
+
/**
|
|
12809
|
+
* Remove Auto-Scale Group
|
|
12810
|
+
* @description Requires the `autoscale-group-manage` capability.
|
|
12811
|
+
*/
|
|
12812
|
+
removeAutoScaleGroup: {
|
|
12813
|
+
parameters: {
|
|
12814
|
+
path: {
|
|
12815
|
+
/** @description The ID for the given autoscale group. */
|
|
12816
|
+
groupId: string;
|
|
12817
|
+
};
|
|
12818
|
+
};
|
|
12819
|
+
responses: {
|
|
12820
|
+
/** @description Returns a task descriptor. */
|
|
12821
|
+
202: {
|
|
12822
|
+
content: {
|
|
12823
|
+
"application/json": {
|
|
12824
|
+
data?: components["schemas"]["TaskDescriptor"];
|
|
12825
|
+
};
|
|
12826
|
+
};
|
|
12827
|
+
};
|
|
12828
|
+
default: components["responses"]["DefaultError"];
|
|
12829
|
+
};
|
|
12830
|
+
};
|
|
12831
|
+
/**
|
|
12832
|
+
* Update Auto-Scale Group
|
|
12833
|
+
* @description Requires the `autoscale-groups-manage` capability.
|
|
12834
|
+
*/
|
|
12835
|
+
updateAutoScaleGroup: {
|
|
12836
|
+
parameters: {
|
|
12837
|
+
path: {
|
|
12838
|
+
/** @description The ID for the given auto-scale group. */
|
|
12839
|
+
groupId: string;
|
|
12840
|
+
};
|
|
12841
|
+
};
|
|
12842
|
+
/** @description Parameters for creating an auto-scale group */
|
|
12843
|
+
requestBody?: {
|
|
12844
|
+
content: {
|
|
12845
|
+
"application/json": {
|
|
12846
|
+
name: string;
|
|
12847
|
+
identifier: string;
|
|
12848
|
+
cluster: string;
|
|
12849
|
+
scale: components["schemas"]["AutoScaleGroupScale"];
|
|
12850
|
+
infrastructure: components["schemas"]["AutoScaleGroupInfrastructure"];
|
|
12851
|
+
};
|
|
12852
|
+
};
|
|
12853
|
+
};
|
|
12854
|
+
responses: {
|
|
12855
|
+
/** @description Returns an autoscale group resource. */
|
|
12856
|
+
200: {
|
|
12857
|
+
content: {
|
|
12858
|
+
"application/json": {
|
|
12859
|
+
data?: components["schemas"]["AutoScaleGroup"];
|
|
12860
|
+
};
|
|
12861
|
+
};
|
|
12862
|
+
};
|
|
12863
|
+
default: components["responses"]["DefaultError"];
|
|
12864
|
+
};
|
|
12865
|
+
};
|
|
12367
12866
|
/**
|
|
12368
12867
|
* List Servers
|
|
12369
12868
|
* @description Requires the `servers-view` capability.
|