@cycleplatform/api-client-typescript 0.3.19 → 0.3.23
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 +521 -119
package/package.json
CHANGED
package/src/generated/types.ts
CHANGED
|
@@ -1289,6 +1289,28 @@ export interface paths {
|
|
|
1289
1289
|
patch?: never;
|
|
1290
1290
|
trace?: never;
|
|
1291
1291
|
};
|
|
1292
|
+
"/v1/dns/tls/certificates": {
|
|
1293
|
+
parameters: {
|
|
1294
|
+
query?: never;
|
|
1295
|
+
header?: never;
|
|
1296
|
+
path?: never;
|
|
1297
|
+
cookie?: never;
|
|
1298
|
+
};
|
|
1299
|
+
/**
|
|
1300
|
+
* List all TLS Certificates whether user generated or automatically generated by the platform.
|
|
1301
|
+
* @description Retrieve a list of TLS certificates.
|
|
1302
|
+
*
|
|
1303
|
+
* Requires the `dns-certs-view` capability.
|
|
1304
|
+
*/
|
|
1305
|
+
get: operations["getAllTlsCertificates"];
|
|
1306
|
+
put?: never;
|
|
1307
|
+
post?: never;
|
|
1308
|
+
delete?: never;
|
|
1309
|
+
options?: never;
|
|
1310
|
+
head?: never;
|
|
1311
|
+
patch?: never;
|
|
1312
|
+
trace?: never;
|
|
1313
|
+
};
|
|
1292
1314
|
"/v1/dns/tls/certificates/lookup": {
|
|
1293
1315
|
parameters: {
|
|
1294
1316
|
query?: never;
|
|
@@ -2830,15 +2852,15 @@ export interface paths {
|
|
|
2830
2852
|
patch: operations["updateAutoScaleGroupAccess"];
|
|
2831
2853
|
trace?: never;
|
|
2832
2854
|
};
|
|
2833
|
-
"/v1/infrastructure/providers/{
|
|
2855
|
+
"/v1/infrastructure/providers/{integrationId}/servers": {
|
|
2834
2856
|
parameters: {
|
|
2835
2857
|
query?: never;
|
|
2836
2858
|
header?: never;
|
|
2837
2859
|
path?: never;
|
|
2838
2860
|
cookie?: never;
|
|
2839
2861
|
};
|
|
2840
|
-
/** List Provider
|
|
2841
|
-
get: operations["
|
|
2862
|
+
/** List Provider Server Models */
|
|
2863
|
+
get: operations["getProviderServerModels"];
|
|
2842
2864
|
put?: never;
|
|
2843
2865
|
post?: never;
|
|
2844
2866
|
delete?: never;
|
|
@@ -2847,7 +2869,7 @@ export interface paths {
|
|
|
2847
2869
|
patch?: never;
|
|
2848
2870
|
trace?: never;
|
|
2849
2871
|
};
|
|
2850
|
-
"/v1/infrastructure/providers/{
|
|
2872
|
+
"/v1/infrastructure/providers/{integrationId}/locations": {
|
|
2851
2873
|
parameters: {
|
|
2852
2874
|
query?: never;
|
|
2853
2875
|
header?: never;
|
|
@@ -3069,10 +3091,10 @@ export interface paths {
|
|
|
3069
3091
|
get: operations["getServers"];
|
|
3070
3092
|
put?: never;
|
|
3071
3093
|
/**
|
|
3072
|
-
* Create
|
|
3094
|
+
* Create Servers
|
|
3073
3095
|
* @description Requires the `servers-provision` capability.
|
|
3074
3096
|
*/
|
|
3075
|
-
post: operations["
|
|
3097
|
+
post: operations["createServers"];
|
|
3076
3098
|
delete?: never;
|
|
3077
3099
|
options?: never;
|
|
3078
3100
|
head?: never;
|
|
@@ -3593,6 +3615,28 @@ export interface paths {
|
|
|
3593
3615
|
patch: operations["updatePipelineAccess"];
|
|
3594
3616
|
trace?: never;
|
|
3595
3617
|
};
|
|
3618
|
+
"/v1/pipelines/runs": {
|
|
3619
|
+
parameters: {
|
|
3620
|
+
query?: never;
|
|
3621
|
+
header?: never;
|
|
3622
|
+
path?: never;
|
|
3623
|
+
cookie?: never;
|
|
3624
|
+
};
|
|
3625
|
+
/**
|
|
3626
|
+
* List All Pipeline Runs
|
|
3627
|
+
* @description Lists all pipeline runs, regardless of the pipeline they are associated with.
|
|
3628
|
+
*
|
|
3629
|
+
* Requires the `pipelines-view` capability.
|
|
3630
|
+
*/
|
|
3631
|
+
get: operations["getAllPipelineRuns"];
|
|
3632
|
+
put?: never;
|
|
3633
|
+
post?: never;
|
|
3634
|
+
delete?: never;
|
|
3635
|
+
options?: never;
|
|
3636
|
+
head?: never;
|
|
3637
|
+
patch?: never;
|
|
3638
|
+
trace?: never;
|
|
3639
|
+
};
|
|
3596
3640
|
"/v1/pipelines/{pipelineId}/runs": {
|
|
3597
3641
|
parameters: {
|
|
3598
3642
|
query?: never;
|
|
@@ -3951,6 +3995,28 @@ export interface paths {
|
|
|
3951
3995
|
patch?: never;
|
|
3952
3996
|
trace?: never;
|
|
3953
3997
|
};
|
|
3998
|
+
"/v1/stacks/builds": {
|
|
3999
|
+
parameters: {
|
|
4000
|
+
query?: never;
|
|
4001
|
+
header?: never;
|
|
4002
|
+
path?: never;
|
|
4003
|
+
cookie?: never;
|
|
4004
|
+
};
|
|
4005
|
+
/**
|
|
4006
|
+
* List All Builds
|
|
4007
|
+
* @description Fetches all stack builds regardless of their association to a stack.
|
|
4008
|
+
*
|
|
4009
|
+
* Requires the `stacks-view` capability.
|
|
4010
|
+
*/
|
|
4011
|
+
get: operations["getAllStackBuilds"];
|
|
4012
|
+
put?: never;
|
|
4013
|
+
post?: never;
|
|
4014
|
+
delete?: never;
|
|
4015
|
+
options?: never;
|
|
4016
|
+
head?: never;
|
|
4017
|
+
patch?: never;
|
|
4018
|
+
trace?: never;
|
|
4019
|
+
};
|
|
3954
4020
|
"/v1/stacks/builds/{buildId}": {
|
|
3955
4021
|
parameters: {
|
|
3956
4022
|
query?: never;
|
|
@@ -4327,7 +4393,48 @@ export interface paths {
|
|
|
4327
4393
|
trace?: never;
|
|
4328
4394
|
};
|
|
4329
4395
|
}
|
|
4330
|
-
export
|
|
4396
|
+
export interface webhooks {
|
|
4397
|
+
environmentMetricsPush: {
|
|
4398
|
+
parameters: {
|
|
4399
|
+
query?: never;
|
|
4400
|
+
header?: never;
|
|
4401
|
+
path?: never;
|
|
4402
|
+
cookie?: never;
|
|
4403
|
+
};
|
|
4404
|
+
get?: never;
|
|
4405
|
+
put?: never;
|
|
4406
|
+
/**
|
|
4407
|
+
* Environment Metrics Push
|
|
4408
|
+
* @description Regularly sends metrics from an environment to an endpoint.
|
|
4409
|
+
*/
|
|
4410
|
+
post: operations["environmentMetricsPush"];
|
|
4411
|
+
delete?: never;
|
|
4412
|
+
options?: never;
|
|
4413
|
+
head?: never;
|
|
4414
|
+
patch?: never;
|
|
4415
|
+
trace?: never;
|
|
4416
|
+
};
|
|
4417
|
+
environmentEventsPush: {
|
|
4418
|
+
parameters: {
|
|
4419
|
+
query?: never;
|
|
4420
|
+
header?: never;
|
|
4421
|
+
path?: never;
|
|
4422
|
+
cookie?: never;
|
|
4423
|
+
};
|
|
4424
|
+
get?: never;
|
|
4425
|
+
put?: never;
|
|
4426
|
+
/**
|
|
4427
|
+
* Environment Events Push
|
|
4428
|
+
* @description Regularly sends events from an environment to an endpoint.
|
|
4429
|
+
*/
|
|
4430
|
+
post: operations["environmentEventsPush"];
|
|
4431
|
+
delete?: never;
|
|
4432
|
+
options?: never;
|
|
4433
|
+
head?: never;
|
|
4434
|
+
patch?: never;
|
|
4435
|
+
trace?: never;
|
|
4436
|
+
};
|
|
4437
|
+
}
|
|
4331
4438
|
export interface components {
|
|
4332
4439
|
schemas: {
|
|
4333
4440
|
/**
|
|
@@ -5887,7 +5994,7 @@ export interface components {
|
|
|
5887
5994
|
* @description The public network settings for the given container
|
|
5888
5995
|
* @enum {string}
|
|
5889
5996
|
*/
|
|
5890
|
-
public: "enable" | "egress-only" | "disable";
|
|
5997
|
+
public: "enable" | "egress-only" | "environment-limited" | "disable";
|
|
5891
5998
|
/** @description The hostname for the given container. */
|
|
5892
5999
|
hostname: string;
|
|
5893
6000
|
/** @description An array of port mappings for the container. */
|
|
@@ -5927,7 +6034,7 @@ export interface components {
|
|
|
5927
6034
|
/** @description The number of initial desired instances for a given container. */
|
|
5928
6035
|
instances: number;
|
|
5929
6036
|
/** @description The deployment strategy to use when scaling the given container. */
|
|
5930
|
-
strategy?: components["schemas"]["DeploymentStrategyName"];
|
|
6037
|
+
strategy?: components["schemas"]["DeploymentStrategyName"] | null;
|
|
5931
6038
|
/** @description Configuration options for containers using the 'function' deployment strategy. */
|
|
5932
6039
|
function?: {
|
|
5933
6040
|
/** @description The maximum number of instances that Cycle can pre-allocate (includes auto-scaled instances). */
|
|
@@ -5939,42 +6046,45 @@ export interface components {
|
|
|
5939
6046
|
/** @description The maximum amount of time Cycle will wait for an instance to be available. */
|
|
5940
6047
|
max_queue_time?: components["schemas"]["Duration"] | null;
|
|
5941
6048
|
} | null;
|
|
6049
|
+
/** @description Configuration options for stateful deployments. */
|
|
5942
6050
|
stateful?: {
|
|
6051
|
+
/** @description Options that modify behavior for stateful deployments. */
|
|
5943
6052
|
options?: {
|
|
6053
|
+
/** @description When set, the base hostname will be used instead of a generated hostname. */
|
|
5944
6054
|
use_base_hostname?: boolean | null;
|
|
5945
6055
|
} | null;
|
|
5946
|
-
};
|
|
6056
|
+
} | null;
|
|
5947
6057
|
/** @description Settings that give more granular control over deployment targets and conditions. */
|
|
5948
6058
|
constraints?: {
|
|
5949
|
-
/** @description Constraint settings related to which nodes an instance can be deployed to. */
|
|
5950
6059
|
node?: {
|
|
5951
6060
|
/** @description Lists of server tags that formally declair servers that match the criteria for deployment. */
|
|
5952
6061
|
tags: {
|
|
5953
6062
|
/** @description A list of tags where a server matching any tags from the list is qualified as a deployment target. */
|
|
5954
|
-
any?: string[];
|
|
6063
|
+
any?: string[] | null;
|
|
5955
6064
|
/** @description A list of tags where a server matching all tags from the list is the only scenario where the server is qualified as a deployment target. */
|
|
5956
|
-
all?: string[];
|
|
6065
|
+
all?: string[] | null;
|
|
5957
6066
|
};
|
|
5958
|
-
};
|
|
5959
|
-
|
|
5960
|
-
|
|
6067
|
+
} | null;
|
|
6068
|
+
/** @description A list of secret identifiers that will be made available to the container. */
|
|
6069
|
+
secrets?: string[] | null;
|
|
6070
|
+
} | null;
|
|
5961
6071
|
/** @description Configuration for what to do during container shutdown. */
|
|
5962
6072
|
shutdown?: {
|
|
5963
6073
|
/** @description How long the platform will wait for a container to stop gracefully. */
|
|
5964
6074
|
graceful_timeout?: components["schemas"]["Duration"] | null;
|
|
5965
6075
|
/** @description Process signal sent to the container process. */
|
|
5966
6076
|
signals?: components["schemas"]["ShutdownSignal"][] | null;
|
|
5967
|
-
};
|
|
6077
|
+
} | null;
|
|
5968
6078
|
/** @description Configurations for container startup. */
|
|
5969
6079
|
startup?: {
|
|
5970
6080
|
/** @description How long the platform will wait before sending the start signal to the given container. */
|
|
5971
6081
|
delay?: components["schemas"]["Duration"];
|
|
5972
|
-
};
|
|
6082
|
+
} | null;
|
|
5973
6083
|
/** @description Configurations for container updates. */
|
|
5974
6084
|
update?: {
|
|
5975
6085
|
/** @description When set, Cycle will pick a random time from `0 - this duration`, and stagger the instances so they all start at different times (up to the time specified here). */
|
|
5976
6086
|
stagger?: components["schemas"]["Duration"];
|
|
5977
|
-
};
|
|
6087
|
+
} | null;
|
|
5978
6088
|
/** @description Configurations for container restart events. */
|
|
5979
6089
|
restart?: {
|
|
5980
6090
|
/**
|
|
@@ -5986,7 +6096,14 @@ export interface components {
|
|
|
5986
6096
|
delay: components["schemas"]["Duration"];
|
|
5987
6097
|
/** @description The amount of times the platform will attempt the restart policies. */
|
|
5988
6098
|
max_attempts: number;
|
|
5989
|
-
};
|
|
6099
|
+
} | null;
|
|
6100
|
+
/** @description Configuration for determining readiness of a container. */
|
|
6101
|
+
readiness_check?: {
|
|
6102
|
+
/** @description The command that will be run to verify readiness of the container. */
|
|
6103
|
+
command: string;
|
|
6104
|
+
interval: components["schemas"]["Duration"];
|
|
6105
|
+
timeout: components["schemas"]["Duration"];
|
|
6106
|
+
} | null;
|
|
5990
6107
|
/** @description Configuration for determining the health of a container. */
|
|
5991
6108
|
health_check?: {
|
|
5992
6109
|
/** @description The command that will be run to verify the health of the container. */
|
|
@@ -5994,14 +6111,14 @@ export interface components {
|
|
|
5994
6111
|
/** @description The number of times the platform will retry the command before marking the container unhealthy. */
|
|
5995
6112
|
retries: number;
|
|
5996
6113
|
/** @description How long to wait before performing an initial health check when the instance starts. The `state.health.healthy` field of the instance will be `null`` until the first check is performed. */
|
|
5997
|
-
delay: components["schemas"]["Duration"]
|
|
6114
|
+
delay: components["schemas"]["Duration"];
|
|
5998
6115
|
/** @description How long to wait between restarts. */
|
|
5999
6116
|
interval: components["schemas"]["Duration"];
|
|
6000
6117
|
/** @description How long before a health check attempt times out. */
|
|
6001
6118
|
timeout: components["schemas"]["Duration"];
|
|
6002
6119
|
/** @description A boolean where `true` represents the desire for a container to restart if unhealthy. */
|
|
6003
6120
|
restart: boolean;
|
|
6004
|
-
};
|
|
6121
|
+
} | null;
|
|
6005
6122
|
/** @description Configuration settings for container telemetery reporting. */
|
|
6006
6123
|
telemetry?: {
|
|
6007
6124
|
/** @description How long telemetry data should be retained. */
|
|
@@ -6010,7 +6127,7 @@ export interface components {
|
|
|
6010
6127
|
interval: components["schemas"]["Duration"];
|
|
6011
6128
|
/** @description A boolean where true disables all telemetry reporting for this container. */
|
|
6012
6129
|
disable: boolean;
|
|
6013
|
-
};
|
|
6130
|
+
} | null;
|
|
6014
6131
|
};
|
|
6015
6132
|
/**
|
|
6016
6133
|
* ScaleThresholdMetricRam
|
|
@@ -6476,6 +6593,8 @@ export interface components {
|
|
|
6476
6593
|
external?: {
|
|
6477
6594
|
id?: components["schemas"]["ID"];
|
|
6478
6595
|
} | null;
|
|
6596
|
+
/** @description The timestamp of the volume's removal, if applicable. */
|
|
6597
|
+
removed?: components["schemas"]["DateTime"] | null;
|
|
6479
6598
|
};
|
|
6480
6599
|
/** ContainerState */
|
|
6481
6600
|
ContainerState: {
|
|
@@ -6581,6 +6700,16 @@ export interface components {
|
|
|
6581
6700
|
};
|
|
6582
6701
|
/** @description A LINKED record is a record special to Cycle. It represents a URL that points to a specific container or deployment of a container, however the IP address mapping in handled automatically by the platform. */
|
|
6583
6702
|
linked?: {
|
|
6703
|
+
/** @description Rules for routing traffic at the load balancer for this linked record. */
|
|
6704
|
+
routing: {
|
|
6705
|
+
http?: {
|
|
6706
|
+
/**
|
|
6707
|
+
* @description If set, this record will configure the load balancer to only match for paths of this domain matching this string.
|
|
6708
|
+
* If the string starts with a /, it will be a literal prefix match (/test matches /test*). Otherwise, regex is used.
|
|
6709
|
+
*/
|
|
6710
|
+
match_path?: string | null;
|
|
6711
|
+
} | null;
|
|
6712
|
+
};
|
|
6584
6713
|
/** @description Features associated with this record. */
|
|
6585
6714
|
features: {
|
|
6586
6715
|
/** @description TLS properties of the record. */
|
|
@@ -6838,7 +6967,7 @@ export interface components {
|
|
|
6838
6967
|
* @description The configuration for environment monitoring.
|
|
6839
6968
|
*/
|
|
6840
6969
|
EnvironmentMonitoringConfig: {
|
|
6841
|
-
/** @description An object describing the log configuration for the environment. */
|
|
6970
|
+
/** @description An object describing the log monitoring configuration for the environment. */
|
|
6842
6971
|
logs?: {
|
|
6843
6972
|
/** @description An object describing log drain configuration for the environment. */
|
|
6844
6973
|
drain?: {
|
|
@@ -6850,6 +6979,28 @@ export interface components {
|
|
|
6850
6979
|
exclude_services: boolean;
|
|
6851
6980
|
} | null;
|
|
6852
6981
|
} | null;
|
|
6982
|
+
/** @description An object describing the metrics monitoring configuration for the environment. */
|
|
6983
|
+
metrics?: {
|
|
6984
|
+
/**
|
|
6985
|
+
* @description Configuration options for pushing metrics externally.
|
|
6986
|
+
* For payload see webhook `environmentMetricsPush`
|
|
6987
|
+
*/
|
|
6988
|
+
endpoint?: {
|
|
6989
|
+
/** @description The destination URL for the metrics. */
|
|
6990
|
+
url: string;
|
|
6991
|
+
} | null;
|
|
6992
|
+
} | null;
|
|
6993
|
+
/** @description An object describing the events monitoring configuration for the environment. */
|
|
6994
|
+
events?: {
|
|
6995
|
+
/**
|
|
6996
|
+
* @description Configuration options for pushing events externally.
|
|
6997
|
+
* For payload see webhook `environmentEventsPush`
|
|
6998
|
+
*/
|
|
6999
|
+
endpoint?: {
|
|
7000
|
+
/** @description The destination URL for events. */
|
|
7001
|
+
url: string;
|
|
7002
|
+
} | null;
|
|
7003
|
+
} | null;
|
|
6853
7004
|
};
|
|
6854
7005
|
/**
|
|
6855
7006
|
* EnvironmentFeatures
|
|
@@ -7316,8 +7467,6 @@ export interface components {
|
|
|
7316
7467
|
*/
|
|
7317
7468
|
DiscoveryConfig: {
|
|
7318
7469
|
empty_set_delay?: components["schemas"]["Duration"] | null;
|
|
7319
|
-
/** @description When enabled, discovery will return both IPv6 and IPv4 when in legacy mode. Otherwise, only IPv4 will be returned. */
|
|
7320
|
-
dual_stack_legacy?: boolean | null;
|
|
7321
7470
|
/** @description A mapping of hostnames to IP addresses for custom internal resolutions. Acts as a custom /etc/resolv.conf file that works environment wide. */
|
|
7322
7471
|
hosts?: {
|
|
7323
7472
|
[key: string]: {
|
|
@@ -7329,6 +7478,12 @@ export interface components {
|
|
|
7329
7478
|
} | null;
|
|
7330
7479
|
/** @description A list of custom DNS resolver strings. Can specifify domains or ips. */
|
|
7331
7480
|
custom_resolvers?: string[] | null;
|
|
7481
|
+
/** @description When enabled, discovery will return both IPv6 and IPv4 when in legacy mode. Otherwise, only IPv4 will be returned. */
|
|
7482
|
+
dual_stack_legacy?: boolean | null;
|
|
7483
|
+
external_resolution?: {
|
|
7484
|
+
/** @enum {string} */
|
|
7485
|
+
preference: "default" | "ipv4" | "ipv6";
|
|
7486
|
+
} | null;
|
|
7332
7487
|
};
|
|
7333
7488
|
/**
|
|
7334
7489
|
* DiscoveryEnvironmentService
|
|
@@ -7502,6 +7657,18 @@ export interface components {
|
|
|
7502
7657
|
image: components["schemas"]["ContainerImageSummary"];
|
|
7503
7658
|
environment: components["schemas"]["ContainerEnvironmentSummary"];
|
|
7504
7659
|
}[];
|
|
7660
|
+
/** @description A map where the key is the service and the value describes the version and date of last update. */
|
|
7661
|
+
service_versions?: {
|
|
7662
|
+
[key: string]: {
|
|
7663
|
+
/**
|
|
7664
|
+
* @description A string depicting the service version.
|
|
7665
|
+
* @example v2025.01.01.01
|
|
7666
|
+
*/
|
|
7667
|
+
version: string;
|
|
7668
|
+
/** @description The time the version was last updated. */
|
|
7669
|
+
last_updated: components["schemas"]["DateTime"];
|
|
7670
|
+
};
|
|
7671
|
+
};
|
|
7505
7672
|
};
|
|
7506
7673
|
/**
|
|
7507
7674
|
* Environment
|
|
@@ -8193,7 +8360,7 @@ export interface components {
|
|
|
8193
8360
|
*/
|
|
8194
8361
|
StackSpecContainerConfigNetwork: {
|
|
8195
8362
|
/** @description The level of public network access this container should have. */
|
|
8196
|
-
public: ("enable" | "disable" | "egress-only") | components["schemas"]["StackVariable"];
|
|
8363
|
+
public: ("enable" | "disable" | "egress-only" | "environment-limited") | components["schemas"]["StackVariable"];
|
|
8197
8364
|
/** @description The hostname of the container. This is how it can be referenced by other containers in the same environment. */
|
|
8198
8365
|
hostname: string | components["schemas"]["StackVariable"];
|
|
8199
8366
|
/** @description A list of port mappings on this container. */
|
|
@@ -8218,65 +8385,74 @@ export interface components {
|
|
|
8218
8385
|
* - ** function **: Every ingress request/connection receives its own instance.
|
|
8219
8386
|
* - ** manual **: Cycle will not make any decisions on where instances are deployed. Instead, instances must be deployed manually using the portal or API.
|
|
8220
8387
|
*/
|
|
8221
|
-
strategy?: ("resource-density" | "manual" | "high-availability" | "first-available" | "node" | "edge" | "function" | null
|
|
8388
|
+
strategy?: ("resource-density" | "manual" | "high-availability" | "first-available" | "node" | "edge" | "function") | null | components["schemas"]["StackVariable"];
|
|
8222
8389
|
/** @description Configuration options for containers using the 'function' deployment strategy. */
|
|
8223
|
-
function?:
|
|
8390
|
+
function?: {
|
|
8224
8391
|
/** @description The maximum number of instances that Cycle can pre-allocate (includes auto-scaled instances). */
|
|
8225
|
-
max_pool_size?:
|
|
8392
|
+
max_pool_size?: number | null | components["schemas"]["StackVariable"];
|
|
8226
8393
|
/** @description For each shard (scheduler), the maximum number of tasks it can run in parallel. */
|
|
8227
|
-
max_shard_concurrency?:
|
|
8394
|
+
max_shard_concurrency?: number | null | components["schemas"]["StackVariable"];
|
|
8228
8395
|
/** @description The maximum amount of time a function instance can run before timing out. */
|
|
8229
|
-
max_runtime?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"]
|
|
8396
|
+
max_runtime?: components["schemas"]["Duration"] | null | components["schemas"]["StackVariable"];
|
|
8230
8397
|
/** @description The maximum amount of time Cycle will wait for an instance to be available. */
|
|
8231
|
-
max_queue_time?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"]
|
|
8232
|
-
} | null
|
|
8398
|
+
max_queue_time?: components["schemas"]["Duration"] | null | components["schemas"]["StackVariable"];
|
|
8399
|
+
} | null | components["schemas"]["StackVariable"];
|
|
8233
8400
|
/** @description Configuration options for stateful containers. */
|
|
8234
|
-
stateful?:
|
|
8401
|
+
stateful?: {
|
|
8235
8402
|
/** @description Stateful container options. */
|
|
8236
8403
|
options: {
|
|
8237
8404
|
/** @description When enabled, instances will utilize stateless base hostnames instead of being prefixed with a unique ID. */
|
|
8238
8405
|
use_base_hostname?: boolean | null;
|
|
8239
|
-
} | null;
|
|
8240
|
-
} | null
|
|
8406
|
+
} | null | components["schemas"]["StackVariable"];
|
|
8407
|
+
} | null | components["schemas"]["StackVariable"];
|
|
8241
8408
|
/** @description Configuration options that provide the ability to set restrictions on which nodes instances of this container are able to be deployed to. (i.e. if you have a GPU container, it should only go on nodes with a GPU). */
|
|
8242
|
-
constraints?:
|
|
8409
|
+
constraints?: {
|
|
8410
|
+
/** @description Constraint settings related to which nodes an instance can be deployed to. */
|
|
8243
8411
|
node?: {
|
|
8244
8412
|
/** @description Tags applied to a node. Cycle generates some automatically, but additional, custom tags can be applied on a per-node basis. */
|
|
8245
8413
|
tags: {
|
|
8246
8414
|
/** @description If a node has at least one of these tags, it is considered a valid deployment target for this container. */
|
|
8247
|
-
any?: string[] | components["schemas"]["StackVariable"];
|
|
8415
|
+
any?: string[] | null | components["schemas"]["StackVariable"];
|
|
8248
8416
|
/** @description A node must have **ALL** of these tags to be considered a valid deployment target for this container. */
|
|
8249
|
-
all?: string[] | components["schemas"]["StackVariable"];
|
|
8250
|
-
} | components["schemas"]["StackVariable"];
|
|
8251
|
-
} | null;
|
|
8252
|
-
} | null
|
|
8417
|
+
all?: string[] | null | components["schemas"]["StackVariable"];
|
|
8418
|
+
} | null | components["schemas"]["StackVariable"];
|
|
8419
|
+
} | null | components["schemas"]["StackVariable"];
|
|
8420
|
+
} | null | components["schemas"]["StackVariable"];
|
|
8253
8421
|
/** @description Configuration options for how this container behaves during shutdown. */
|
|
8254
|
-
shutdown?:
|
|
8422
|
+
shutdown?: {
|
|
8255
8423
|
/** @description How long the platform will wait for a container to stop gracefully. */
|
|
8256
8424
|
graceful_timeout?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
|
|
8257
|
-
|
|
8258
|
-
|
|
8425
|
+
/** @description Signals that should be sent to the container on shutdown. */
|
|
8426
|
+
signals?: components["schemas"]["ShutdownSignal"][] | null | components["schemas"]["StackVariable"];
|
|
8427
|
+
} | null | components["schemas"]["StackVariable"];
|
|
8259
8428
|
/** @description Configuration options for how this container behaves during startup. */
|
|
8260
|
-
startup?:
|
|
8429
|
+
startup?: {
|
|
8261
8430
|
/** @description How long the platform will wait before sending the start signal to the given container. */
|
|
8262
8431
|
delay?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
|
|
8263
|
-
} | null
|
|
8432
|
+
} | null | components["schemas"]["StackVariable"];
|
|
8264
8433
|
/** @description Configurations for how the container behaves during updates. */
|
|
8265
|
-
update?:
|
|
8434
|
+
update?: {
|
|
8266
8435
|
/** @description When set, Cycle will pick a random time from `0 - this duration`, and stagger the instances so they all start at different times (up to the time specified here). */
|
|
8267
8436
|
stagger?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
|
|
8268
|
-
} | null
|
|
8437
|
+
} | null | components["schemas"]["StackVariable"];
|
|
8269
8438
|
/** @description Configuration options for how Cycle should handle restarting this container (i.e. in case the process inside the container dies). */
|
|
8270
|
-
restart?:
|
|
8439
|
+
restart?: {
|
|
8271
8440
|
/** @description Under what circumstances Cycle should try to restart this container. */
|
|
8272
8441
|
condition: ("always" | "never" | "failure") | components["schemas"]["StackVariable"];
|
|
8273
8442
|
/** @description How long the platform will wait between restart attempts. */
|
|
8274
8443
|
delay: components["schemas"]["Duration"] | components["schemas"]["StackVariable"];
|
|
8275
8444
|
/** @description The maximum number of restart attempts Cycle will make. */
|
|
8276
8445
|
max_attempts: number | components["schemas"]["StackVariable"];
|
|
8277
|
-
} | null
|
|
8446
|
+
} | null | components["schemas"]["StackVariable"];
|
|
8447
|
+
/** @description Configuration for determining readiness of a container. */
|
|
8448
|
+
readiness_check?: {
|
|
8449
|
+
/** @description The command that will be run to verify readiness of the container. */
|
|
8450
|
+
command: string;
|
|
8451
|
+
interval: components["schemas"]["Duration"];
|
|
8452
|
+
timeout: components["schemas"]["Duration"];
|
|
8453
|
+
} | null | components["schemas"]["StackVariable"];
|
|
8278
8454
|
/** @description Configuration options for automated container health checks. */
|
|
8279
|
-
health_check?:
|
|
8455
|
+
health_check?: {
|
|
8280
8456
|
/**
|
|
8281
8457
|
* @description The command or script to run to verify the health of the container. This script is run inside the container by Cycle.
|
|
8282
8458
|
* This command accepts two types of entries:
|
|
@@ -8293,18 +8469,18 @@ export interface components {
|
|
|
8293
8469
|
restart: boolean | components["schemas"]["StackVariable"];
|
|
8294
8470
|
/** @description How long to wait after a container start event before running health checks. */
|
|
8295
8471
|
delay?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
|
|
8296
|
-
} | null
|
|
8472
|
+
} | null | components["schemas"]["StackVariable"];
|
|
8297
8473
|
/** @description Configuration options for how the instance telemetry (CPU usage, etc) is handled. */
|
|
8298
|
-
telemetry?:
|
|
8474
|
+
telemetry?: {
|
|
8299
8475
|
/** @description How long telemetry data should be retained. */
|
|
8300
|
-
retention?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"]
|
|
8476
|
+
retention?: components["schemas"]["Duration"] | null | components["schemas"]["StackVariable"];
|
|
8301
8477
|
/** @description The duration between samples. */
|
|
8302
|
-
interval?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"]
|
|
8478
|
+
interval?: components["schemas"]["Duration"] | null | components["schemas"]["StackVariable"];
|
|
8303
8479
|
/** @description A URL where Cycle will send telemetry data to. The payload will be an instance resource snapshot. */
|
|
8304
|
-
webhook?:
|
|
8480
|
+
webhook?: string | null | components["schemas"]["StackVariable"];
|
|
8305
8481
|
/** @description If true, Cycle will not aggregate telemetry for this container's instances. */
|
|
8306
8482
|
disable: boolean | components["schemas"]["StackVariable"];
|
|
8307
|
-
} | null
|
|
8483
|
+
} | null | components["schemas"]["StackVariable"];
|
|
8308
8484
|
};
|
|
8309
8485
|
/**
|
|
8310
8486
|
* StackSpecContainerScaleThresholdRam
|
|
@@ -8737,8 +8913,6 @@ export interface components {
|
|
|
8737
8913
|
/** StackSpecDiscoveryConfig */
|
|
8738
8914
|
StackSpecDiscoveryConfig: {
|
|
8739
8915
|
empty_set_delay?: components["schemas"]["Duration"] | components["schemas"]["StackVariable"] | null;
|
|
8740
|
-
/** @description When enabled, discovery will return both IPv6 and IPv4 when in legacy mode. Otherwise, only IPv4 will be returned. */
|
|
8741
|
-
dual_stack_legacy?: boolean | components["schemas"]["StackVariable"] | null;
|
|
8742
8916
|
/** @description A custom mapping of hosts - for forced resolution of specific IPs for a domain. */
|
|
8743
8917
|
hosts?: ({
|
|
8744
8918
|
[key: string]: {
|
|
@@ -8748,6 +8922,12 @@ export interface components {
|
|
|
8748
8922
|
} | null) | components["schemas"]["StackVariable"];
|
|
8749
8923
|
/** @description A list of custom DNS resolver strings. Can specifify domains or ips. */
|
|
8750
8924
|
custom_resolvers?: string[] | components["schemas"]["StackVariable"] | null;
|
|
8925
|
+
/** @description When enabled, discovery will return both IPv6 and IPv4 when in legacy mode. Otherwise, only IPv4 will be returned. */
|
|
8926
|
+
dual_stack_legacy?: boolean | components["schemas"]["StackVariable"] | null;
|
|
8927
|
+
external_resolution?: {
|
|
8928
|
+
/** @enum {string} */
|
|
8929
|
+
preference: "default" | "ipv4" | "ipv6";
|
|
8930
|
+
} | components["schemas"]["StackVariable"] | null;
|
|
8751
8931
|
};
|
|
8752
8932
|
/**
|
|
8753
8933
|
* StackSpecDiscoveryService
|
|
@@ -9998,8 +10178,8 @@ export interface components {
|
|
|
9998
10178
|
region: string;
|
|
9999
10179
|
};
|
|
10000
10180
|
/**
|
|
10001
|
-
*
|
|
10002
|
-
* @description Information about the
|
|
10181
|
+
* ProviderLocationDetails
|
|
10182
|
+
* @description Information about the location of the provider.
|
|
10003
10183
|
*/
|
|
10004
10184
|
ProviderLocationDetails: {
|
|
10005
10185
|
/** @description An identifier for the given provider */
|
|
@@ -10065,6 +10245,8 @@ export interface components {
|
|
|
10065
10245
|
creator: components["schemas"]["CreatorScope"];
|
|
10066
10246
|
hub_id: components["schemas"]["HubID"];
|
|
10067
10247
|
acl?: components["schemas"]["ACL"] | null;
|
|
10248
|
+
/** @description Marks a cluster as non-essential. Non-essential cluster resources are excluded by default from certain metrics and summaries unless opted in. */
|
|
10249
|
+
non_essential: boolean;
|
|
10068
10250
|
state: components["schemas"]["ClusterState"];
|
|
10069
10251
|
features: {
|
|
10070
10252
|
/** @description The level of monitoring to enable for this cluster. There is a cost associated with higher levels of monitoring. */
|
|
@@ -10187,10 +10369,10 @@ export interface components {
|
|
|
10187
10369
|
} | null;
|
|
10188
10370
|
};
|
|
10189
10371
|
/**
|
|
10190
|
-
*
|
|
10372
|
+
* ProviderServerModelSpec
|
|
10191
10373
|
* @description Specs for a given server
|
|
10192
10374
|
*/
|
|
10193
|
-
|
|
10375
|
+
ProviderServerModelSpec: {
|
|
10194
10376
|
cpu: components["schemas"]["CPUSpec"];
|
|
10195
10377
|
gpu: components["schemas"]["GPUSpec"];
|
|
10196
10378
|
memory: components["schemas"]["MemorySpec"];
|
|
@@ -10199,11 +10381,13 @@ export interface components {
|
|
|
10199
10381
|
features: components["schemas"]["FeaturesSpec"];
|
|
10200
10382
|
};
|
|
10201
10383
|
/**
|
|
10202
|
-
*
|
|
10384
|
+
* ProviderServerModelProviderSpec
|
|
10203
10385
|
* @description Higher level information about a providers server.
|
|
10204
10386
|
*/
|
|
10205
|
-
|
|
10206
|
-
/** @description
|
|
10387
|
+
ProviderServerModelProviderSpec: {
|
|
10388
|
+
/** @description The infrastructure vendor for the provider. */
|
|
10389
|
+
vendor?: string;
|
|
10390
|
+
/** @description A provider identifier. */
|
|
10207
10391
|
identifier: string;
|
|
10208
10392
|
integration_id?: components["schemas"]["ID"] | null;
|
|
10209
10393
|
/** @description A category for the server. */
|
|
@@ -10228,8 +10412,8 @@ export interface components {
|
|
|
10228
10412
|
name: string;
|
|
10229
10413
|
/** @description A description of the server. */
|
|
10230
10414
|
description: string;
|
|
10231
|
-
specs: components["schemas"]["
|
|
10232
|
-
provider: components["schemas"]["
|
|
10415
|
+
specs: components["schemas"]["ProviderServerModelSpec"];
|
|
10416
|
+
provider: components["schemas"]["ProviderServerModelProviderSpec"];
|
|
10233
10417
|
price: components["schemas"]["BillingAmount"];
|
|
10234
10418
|
/** @description A boolean where true signifies this server is compatible with the platform. */
|
|
10235
10419
|
compatible: boolean;
|
|
@@ -10239,10 +10423,10 @@ export interface components {
|
|
|
10239
10423
|
location_ids: string[];
|
|
10240
10424
|
};
|
|
10241
10425
|
/**
|
|
10242
|
-
*
|
|
10243
|
-
* @description A
|
|
10426
|
+
* ProviderServerModelsIncludes
|
|
10427
|
+
* @description A resource associated with a server models.
|
|
10244
10428
|
*/
|
|
10245
|
-
|
|
10429
|
+
ProviderServerModelsIncludes: {
|
|
10246
10430
|
[key: string]: components["schemas"]["ProviderServerModel"];
|
|
10247
10431
|
};
|
|
10248
10432
|
/** IntegrationAuth */
|
|
@@ -10403,7 +10587,7 @@ export interface components {
|
|
|
10403
10587
|
clusters?: {
|
|
10404
10588
|
[key: string]: components["schemas"]["Cluster"];
|
|
10405
10589
|
};
|
|
10406
|
-
models?: components["schemas"]["
|
|
10590
|
+
models?: components["schemas"]["ProviderServerModelsIncludes"];
|
|
10407
10591
|
integrations?: components["schemas"]["IntegrationsIncludes"];
|
|
10408
10592
|
};
|
|
10409
10593
|
/**
|
|
@@ -10454,6 +10638,18 @@ export interface components {
|
|
|
10454
10638
|
/** @description A timestamp of the last time the instance health was updated. */
|
|
10455
10639
|
updated: components["schemas"]["DateTime"];
|
|
10456
10640
|
} | null;
|
|
10641
|
+
/** @description information about the readiness of the instance. */
|
|
10642
|
+
readiness?: {
|
|
10643
|
+
/**
|
|
10644
|
+
* @description Describes the readiness of the instance.
|
|
10645
|
+
* - `true`: The instance is ready.
|
|
10646
|
+
* - `false`: The instance is not ready.
|
|
10647
|
+
* - `null`: The instance has not yet reported its readiness, or a readiness check has not yet been performed.
|
|
10648
|
+
*/
|
|
10649
|
+
ready: boolean | null;
|
|
10650
|
+
/** @description A timestamp of the last time the instance readiness was updated. */
|
|
10651
|
+
updated: components["schemas"]["DateTime"];
|
|
10652
|
+
} | null;
|
|
10457
10653
|
} & components["schemas"]["State"];
|
|
10458
10654
|
/**
|
|
10459
10655
|
* InstanceAutoScale
|
|
@@ -11047,7 +11243,7 @@ export interface components {
|
|
|
11047
11243
|
* @description Controls the public network mode for the virtual machine.
|
|
11048
11244
|
* @enum {string}
|
|
11049
11245
|
*/
|
|
11050
|
-
public: "enable" | "disable" | "egress-only";
|
|
11246
|
+
public: "enable" | "disable" | "egress-only" | "environment-limited";
|
|
11051
11247
|
/** @description The hostname assigned to the virtual machine. */
|
|
11052
11248
|
hostname: string;
|
|
11053
11249
|
/** @description Port configurations for the virtual machine. */
|
|
@@ -11346,6 +11542,8 @@ export interface components {
|
|
|
11346
11542
|
hash: string;
|
|
11347
11543
|
/** @description The configuration details for the virtual machine's volume. */
|
|
11348
11544
|
config: components["schemas"]["VirtualMachineVolumeConfig"];
|
|
11545
|
+
/** @description The timestamp of the volume's removal, if applicable. */
|
|
11546
|
+
removed?: components["schemas"]["DateTime"] | null;
|
|
11349
11547
|
};
|
|
11350
11548
|
/** VirtualMachineState */
|
|
11351
11549
|
VirtualMachineState: {
|
|
@@ -11749,6 +11947,22 @@ export interface components {
|
|
|
11749
11947
|
deleted: components["schemas"]["DateTime"];
|
|
11750
11948
|
};
|
|
11751
11949
|
};
|
|
11950
|
+
/**
|
|
11951
|
+
* LoadBalancerInfo
|
|
11952
|
+
* @description Information about an environments load balancer configuration, state, and availability settings.
|
|
11953
|
+
*/
|
|
11954
|
+
LoadBalancerInfo: {
|
|
11955
|
+
default_config: components["schemas"]["LoadBalancerConfig"];
|
|
11956
|
+
/** @enum {string} */
|
|
11957
|
+
default_type: "haproxy" | "v1";
|
|
11958
|
+
/** @enum {string} */
|
|
11959
|
+
current_type: "haproxy" | "v1";
|
|
11960
|
+
base_configs?: {
|
|
11961
|
+
haproxy: components["schemas"]["HaProxyConfig"];
|
|
11962
|
+
v1: components["schemas"]["V1LbConfig"];
|
|
11963
|
+
};
|
|
11964
|
+
service: components["schemas"]["LoadBalancerEnvironmentService"] | null;
|
|
11965
|
+
};
|
|
11752
11966
|
/**
|
|
11753
11967
|
* Range
|
|
11754
11968
|
* @description A start and end date-time pair indicating a range of time
|
|
@@ -12323,7 +12537,7 @@ export interface components {
|
|
|
12323
12537
|
* @description The activity event.
|
|
12324
12538
|
* @enum {string}
|
|
12325
12539
|
*/
|
|
12326
|
-
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.services.scheduler.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.scheduler.task.reconfigure" | "environment.services.vpn.user.create" | "environment.services.vpn.login" | "environment.services.vpn.reset" | "environment.services.vpn.task.reset" | "environment.task.initialize" | "environment.task.start" | "environment.task.stop" | "environment.task.deployments.reconfigure" | "environment.deployments.reconfigure" | "environment.task.monitoring.reconfigure" | "environment.monitoring.reconfigure" | "environment.deployments.prune" | "environment.deployment.start" | "environment.deployment.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.role.update" | "hub.role.delete" | "hub.role.create" | "hub.role.task.delete" | "hub.membership.delete" | "hub.membership.create" | "hub.membership.update" | "hub.integration.create" | "hub.integration.update" | "hub.integration.delete" | "hub.integration.task.verify" | "hub.integration.task.delete" | "hub.inactive" | "container.initialize" | "container.task.start" | "container.start" | "container.task.stop" | "container.stop" | "container.task.restart" | "container.restart" | "container.task.reconfigure" | "container.reconfigure" | "container.task.volumes.reconfigure" | "container.function.trigger" | "container.function.task.trigger" | "container.volumes.reconfigure" | "container.create" | "container.restart" | "container.task.reimage" | "container.reimage" | "container.deprecate" | "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.volume.extend" | "container.instance.task.volume.extend" | "container.instance.healthcheck.failed" | "container.instance.error" | "container.instance.ssh.login" | "container.instance.migration.start" | "container.instance.migration.revert" | "container.instance.delete" | "container.instance.task.migration.revert" | "container.instance.task.migration.start" | "container.instance.traffic-drain.reconfigure" | "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" | "dns.certificate.associate" | "dns.certificate.deprecate" | "dns.certificate.create" | "dns.certificate.task.deprecate" | "stack.update" | "stack.task.delete" | "stack.delete" | "stack.create" | "stack.task.prune" | "stack.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.virtual-providers.iso.create" | "infrastructure.virtual-providers.iso.generate" | "infrastructure.virtual-providers.iso.update" | "infrastructure.virtual-providers.iso.delete" | "infrastructure.virtual-providers.iso.task.delete" | "infrastructure.server.task.delete" | "infrastructure.server.task.restart" | "infrastructure.server.services.sftp.auth" | "infrastructure.server.live" | "infrastructure.server.delete" | "infrastructure.server.restart" | "infrastructure.server.unquarantine" | "infrastructure.server.compute.restart" | "infrastructure.server.compute.spawner.restart" | "infrastructure.server.features.reconfigure" | "infrastructure.server.sharedfs.reconfigure" | "infrastructure.server.provision" | "infrastructure.server.console" | "infrastructure.server.update" | "infrastructure.server.task.provision" | "infrastructure.server.ssh.token" | "infrastructure.server.task.features.reconfigure" | "infrastructure.server.task.sharedfs.reconfigure" | "infrastructure.server.services.sftp.lockdown" | "infrastructure.server.services.internal-api.throttle" | "infrastructure.server.evacuation.start" | "infrastructure.server.task.evacuation.start" | "infrastructure.server.evacuation.reset" | "infrastructure.server.task.evacuation.reset" | "infrastructure.server.power-off" | "infrastructure.server.auth.reset" | "infrastructure.autoscale.group.create" | "infrastructure.autoscale.group.update" | "infrastructure.autoscale.group.task.delete" | "infrastructure.autoscale.group.delete" | "infrastructure.external-volume.create" | "infrastructure.external-volume.update" | "infrastructure.external-volume.task.delete" | "infrastructure.external-volume.delete" | "infrastructure.external-volume.task.servers.reconfigure" | "infrastructure.external-volume.task.attachment.reconfigure" | "infrastructure.external-volume.servers.reconfigure" | "infrastructure.external-volume.attachment.reconfigure" | "infrastructure.external-volumes.task.scan" | "infrastructure.cluster.create" | "infrastructure.cluster.update" | "infrastructure.cluster.task.delete" | "infrastructure.cluster.delete" | "infrastructure.cluster.features.monitoring.tier.reconfigure" | "infrastructure.ips.pool.task.delete" | "infrastructure.ips.pool.create" | "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.run.completed" | "pipeline.key.update" | "pipeline.key.delete" | "pipeline.key.create" | "virtual-machine.create" | "virtual-machine.initialize" | "virtual-machine.task.start" | "virtual-machine.start" | "virtual-machine.task.stop" | "virtual-machine.stop" | "virtual-machine.reconfigure" | "virtual-machine.task.reconfigure" | "virtual-machine.update" | "virtual-machine.task.delete" | "virtual-machine.delete" | "virtual-machine.sos.login" | "virtual-machine.rootpw.change" | "virtual-machine.task.volumes.reconfigure" | "virtual-machine.volumes.reconfigure" | "virtual-machine.ssh-key.create" | "virtual-machine.ssh-key.update" | "virtual-machine.ssh-key.task.delete" | "virtual-machine.ssh-key.delete" | "virtual-machine.ip.allocate" | "virtual-machine.task.ip.allocate" | "virtual-machine.ip.unallocate" | "virtual-machine.task.ip.unallocate";
|
|
12540
|
+
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.services.scheduler.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.scheduler.task.reconfigure" | "environment.services.vpn.user.create" | "environment.services.vpn.login" | "environment.services.vpn.reset" | "environment.services.vpn.task.reset" | "environment.task.initialize" | "environment.task.start" | "environment.task.stop" | "environment.task.deployments.reconfigure" | "environment.deployments.reconfigure" | "environment.task.monitoring.reconfigure" | "environment.monitoring.reconfigure" | "environment.deployments.prune" | "environment.deployment.start" | "environment.deployment.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.role.update" | "hub.role.delete" | "hub.role.create" | "hub.role.task.delete" | "hub.membership.delete" | "hub.membership.create" | "hub.membership.update" | "hub.integration.create" | "hub.integration.update" | "hub.integration.delete" | "hub.integration.task.verify" | "hub.integration.task.delete" | "hub.inactive" | "container.initialize" | "container.task.start" | "container.start" | "container.task.stop" | "container.stop" | "container.task.restart" | "container.restart" | "container.task.reconfigure" | "container.reconfigure" | "container.task.volumes.reconfigure" | "container.function.trigger" | "container.function.task.trigger" | "container.volumes.reconfigure" | "container.create" | "container.restart" | "container.task.reimage" | "container.reimage" | "container.deprecate" | "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.volume.extend" | "container.instance.task.volume.extend" | "container.instance.healthcheck.failed" | "container.instance.error" | "container.instance.ssh.login" | "container.instance.migration.start" | "container.instance.migration.revert" | "container.instance.delete" | "container.instance.task.migration.revert" | "container.instance.task.migration.start" | "container.instance.traffic-drain.reconfigure" | "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" | "dns.certificate.associate" | "dns.certificate.deprecate" | "dns.certificate.create" | "dns.certificate.task.deprecate" | "stack.update" | "stack.task.delete" | "stack.delete" | "stack.create" | "stack.task.prune" | "stack.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.virtual-providers.iso.create" | "infrastructure.virtual-providers.iso.generate" | "infrastructure.virtual-providers.iso.update" | "infrastructure.virtual-providers.iso.delete" | "infrastructure.virtual-providers.iso.task.delete" | "infrastructure.server.task.delete" | "infrastructure.server.task.restart" | "infrastructure.server.services.sftp.auth" | "infrastructure.server.live" | "infrastructure.server.delete" | "infrastructure.server.restart" | "infrastructure.server.unquarantine" | "infrastructure.server.compute.restart" | "infrastructure.server.compute.spawner.restart" | "infrastructure.server.features.reconfigure" | "infrastructure.server.sharedfs.reconfigure" | "infrastructure.server.provision" | "infrastructure.server.console" | "infrastructure.server.update" | "infrastructure.server.task.provision" | "infrastructure.server.ssh.token" | "infrastructure.server.task.features.reconfigure" | "infrastructure.server.task.sharedfs.reconfigure" | "infrastructure.server.services.sftp.lockdown" | "infrastructure.server.services.internal-api.throttle" | "infrastructure.server.evacuation.start" | "infrastructure.server.task.evacuation.start" | "infrastructure.server.evacuation.reset" | "infrastructure.server.task.evacuation.reset" | "infrastructure.server.power-off" | "infrastructure.server.auth.reset" | "infrastructure.autoscale.group.create" | "infrastructure.autoscale.group.update" | "infrastructure.autoscale.group.task.delete" | "infrastructure.autoscale.group.delete" | "infrastructure.external-volume.create" | "infrastructure.external-volume.update" | "infrastructure.external-volume.task.delete" | "infrastructure.external-volume.delete" | "infrastructure.external-volume.task.servers.reconfigure" | "infrastructure.external-volume.task.attachment.reconfigure" | "infrastructure.external-volume.servers.reconfigure" | "infrastructure.external-volume.attachment.reconfigure" | "infrastructure.external-volumes.task.scan" | "infrastructure.cluster.create" | "infrastructure.cluster.update" | "infrastructure.cluster.task.delete" | "infrastructure.cluster.delete" | "infrastructure.cluster.features.monitoring.tier.reconfigure" | "infrastructure.ips.pool.task.delete" | "infrastructure.ips.pool.create" | "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.run.completed" | "pipeline.key.update" | "pipeline.key.delete" | "pipeline.key.create" | "virtual-machine.create" | "virtual-machine.initialize" | "virtual-machine.task.start" | "virtual-machine.start" | "virtual-machine.task.stop" | "virtual-machine.stop" | "virtual-machine.reconfigure" | "virtual-machine.task.reconfigure" | "virtual-machine.update" | "virtual-machine.task.delete" | "virtual-machine.delete" | "virtual-machine.sos.login" | "virtual-machine.rootpw.change" | "virtual-machine.task.volumes.reconfigure" | "virtual-machine.volumes.reconfigure" | "virtual-machine.volumes.remove" | "virtual-machine.task.volumes.remove" | "virtual-machine.volumes.add" | "virtual-machine.task.volumes.add" | "virtual-machine.ssh-key.create" | "virtual-machine.ssh-key.update" | "virtual-machine.ssh-key.task.delete" | "virtual-machine.ssh-key.delete" | "virtual-machine.ip.allocate" | "virtual-machine.task.ip.allocate" | "virtual-machine.ip.unallocate" | "virtual-machine.task.ip.unallocate";
|
|
12327
12541
|
/** @description A timestamp for when the activity took place. */
|
|
12328
12542
|
time: components["schemas"]["DateTime"];
|
|
12329
12543
|
};
|
|
@@ -13739,7 +13953,7 @@ export interface components {
|
|
|
13739
13953
|
* @description The current lifecycle state of the volume.
|
|
13740
13954
|
* @enum {string}
|
|
13741
13955
|
*/
|
|
13742
|
-
current: "new" | "configuring" | "live" | "deleting" | "deleted";
|
|
13956
|
+
current: "new" | "ready" | "configuring" | "live" | "deleting" | "deleted";
|
|
13743
13957
|
} & components["schemas"]["State"];
|
|
13744
13958
|
/**
|
|
13745
13959
|
* ExternalVolumeEvents
|
|
@@ -13909,7 +14123,7 @@ export interface components {
|
|
|
13909
14123
|
* @description A resource that is associated with activity.
|
|
13910
14124
|
*/
|
|
13911
14125
|
ComponentsIncludes: {
|
|
13912
|
-
[key: string]: components["schemas"]["Container"] | components["schemas"]["VirtualMachine"] | components["schemas"]["Instance"] | components["schemas"]["Environment"] | components["schemas"]["Image"] | components["schemas"]["ImageSource"] | components["schemas"]["Server"] | components["schemas"]["VirtualProviderIso"] | components["schemas"]["IpPool"] | components["schemas"]["Integration"] | components["schemas"]["Stack"] | components["schemas"]["StackBuild"] | components["schemas"]["DnsZone"] | components["schemas"]["DnsRecord"] | components["schemas"]["TlsCertificate"] | 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"] | components["schemas"]["ExternalVolume"] | components["schemas"]["PipelineRun"] | components["schemas"]["Role"] | components["schemas"]["PublicAccount"] | components["schemas"]["VirtualMachineSshKey"];
|
|
14126
|
+
[key: string]: components["schemas"]["Container"] | components["schemas"]["VirtualMachine"] | components["schemas"]["Instance"] | components["schemas"]["Environment"] | components["schemas"]["Image"] | components["schemas"]["ImageSource"] | components["schemas"]["Server"] | components["schemas"]["VirtualProviderIso"] | components["schemas"]["IpPool"] | components["schemas"]["Integration"] | components["schemas"]["Stack"] | components["schemas"]["StackBuild"] | components["schemas"]["DnsZone"] | components["schemas"]["DnsRecord"] | components["schemas"]["TlsCertificate"] | 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"] | components["schemas"]["ExternalVolume"] | components["schemas"]["PipelineRun"] | components["schemas"]["Role"] | components["schemas"]["PublicAccount"] | components["schemas"]["VirtualMachineSshKey"] | components["schemas"]["Cluster"];
|
|
13913
14127
|
};
|
|
13914
14128
|
/**
|
|
13915
14129
|
* ActivityIncludes
|
|
@@ -14285,20 +14499,13 @@ export interface components {
|
|
|
14285
14499
|
};
|
|
14286
14500
|
/** ExternalVolumeTask */
|
|
14287
14501
|
ExternalVolumeTask: components["schemas"]["ExternalVolumeServersReconfigureAction"] | components["schemas"]["ExternalVolumeAttachmentReconfigureAction"];
|
|
14288
|
-
/**
|
|
14289
|
-
* ServerModelsIncludes
|
|
14290
|
-
* @description A resource associated with a server models.
|
|
14291
|
-
*/
|
|
14292
|
-
ServerModelsIncludes: {
|
|
14293
|
-
[key: string]: components["schemas"]["ProviderServerModel"];
|
|
14294
|
-
};
|
|
14295
14502
|
/**
|
|
14296
14503
|
* AutoScaleGroupIncludes
|
|
14297
14504
|
* @description All includable resource linkable to the given auto-scale group.
|
|
14298
14505
|
*/
|
|
14299
14506
|
AutoScaleGroupIncludes: {
|
|
14300
14507
|
integrations?: components["schemas"]["IntegrationsIncludes"];
|
|
14301
|
-
models?: components["schemas"]["
|
|
14508
|
+
models?: components["schemas"]["ProviderServerModelsIncludes"];
|
|
14302
14509
|
locations?: components["schemas"]["LocationsIncludes"];
|
|
14303
14510
|
};
|
|
14304
14511
|
/**
|
|
@@ -14798,7 +15005,7 @@ export interface components {
|
|
|
14798
15005
|
* EventType
|
|
14799
15006
|
* @enum {string}
|
|
14800
15007
|
*/
|
|
14801
|
-
EventType: "api.security_violation" | "console.ssh.login" | "console.ssh.login.failed" | "console.sos.login" | "console.sos.login.failed" | "container.instance.backup.completed" | "container.instance.backup.failed" | "container.instance.delete.failed" | "container.instance.error" | "container.instance.restart.max_restarts" | "container.instance.function.max_runtime" | "container.instance.healthcheck.failed" | "container.instance.healthcheck.recovered" | "container.instance.volume.extend.failed" | "container.instance.healthcheck.restarted" | "container.instance.migration.completed" | "container.instance.migration.failed" | "container.instance.network.interfaces.create.failed" | "container.instance.restart.failed" | "container.instance.start.failed" | "container.instance.start.privileged" | "container.instance.stop.failed" | "container.instances.autoscale.down" | "container.instances.autoscale.up" | "container.reconfigured.privileged" | "container.volumes.base.create.failed" | "container.volumes.create.failed" | "environment.service.auto_update" | "environment.service.lb.ips.sync.failed" | "environment.service.vpn.login.failed" | "environment.service.discovery.client.throttle.hit" | "environment.service.gateway.ips.sync.failed" | "infrastructure.cluster.resources.ram.full" | "infrastructure.server.compute.volumes.base.reconfigured" | "infrastructure.server.compute.full_restart" | "infrastructure.server.compute.sharedfs.mounts.mount" | "infrastructure.server.compute.sharedfs.mounts.mount.failed" | "infrastructure.server.compute.soft_restart" | "infrastructure.server.image.download.failed" | "infrastructure.server.monitoring.throttled" | "infrastructure.server.internal_api.throttled" | "infrastructure.server.manifest.sync.failed" | "infrastructure.server.mesh.connect.failed" | "infrastructure.server.neighbor.reachable" | "infrastructure.server.neighbor.rebuild" | "infrastructure.server.neighbors.rebuild" | "infrastructure.server.neighbor.unreachable" | "infrastructure.server.neighbor.upgraded" | "infrastructure.server.resources.load.high" | "infrastructure.server.resources.ram.full" | "infrastructure.server.resources.storage.volumes.base.full" | "infrastructure.server.resources.storage.cycle_pool.full" | "infrastructure.server.autoscale.up" | "infrastructure.server.sftp.lockdown" | "infrastructure.server.sftp.login" | "infrastructure.server.sftp.login.failed" | "infrastructure.server.evacuation.failed" | "infrastructure.server.evacuation.completed" | "infrastructure.server.checkin.missed" | "infrastructure.server.checkin.resumed" | "infrastructure.server.power.reboot" | "infrastructure.server.
|
|
15008
|
+
EventType: "api.security_violation" | "console.ssh.login" | "console.ssh.login.failed" | "console.sos.login" | "console.sos.login.failed" | "container.instance.backup.completed" | "container.instance.backup.failed" | "container.instance.delete.failed" | "container.instance.error" | "container.instance.restart.max_restarts" | "container.instance.function.max_runtime" | "container.instance.healthcheck.failed" | "container.instance.healthcheck.recovered" | "container.instance.volume.extend.failed" | "container.instance.healthcheck.restarted" | "container.instance.migration.completed" | "container.instance.migration.failed" | "container.instance.network.interfaces.create.failed" | "container.instance.restart.failed" | "container.instance.start.failed" | "container.instance.start.privileged" | "container.instance.stop.failed" | "container.instances.autoscale.down" | "container.instances.autoscale.up" | "container.reconfigured.privileged" | "container.volumes.base.create.failed" | "container.volumes.create.failed" | "environment.service.auto_update" | "environment.service.lb.ips.sync.failed" | "environment.service.vpn.login.failed" | "environment.service.discovery.client.throttle.hit" | "environment.service.gateway.ips.sync.failed" | "infrastructure.cluster.resources.ram.full" | "infrastructure.server.compute.volumes.base.reconfigured" | "infrastructure.server.compute.full_restart" | "infrastructure.server.compute.sharedfs.mounts.mount" | "infrastructure.server.compute.sharedfs.mounts.mount.failed" | "infrastructure.server.compute.soft_restart" | "infrastructure.server.compute.start.failure" | "infrastructure.server.compute.died" | "infrastructure.server.compute-spawner.full_restart" | "infrastructure.server.image.download.failed" | "infrastructure.server.monitoring.throttled" | "infrastructure.server.internal_api.throttled" | "infrastructure.server.manifest.sync.failed" | "infrastructure.server.mesh.connect.failed" | "infrastructure.server.neighbor.reachable" | "infrastructure.server.neighbor.rebuild" | "infrastructure.server.neighbors.rebuild" | "infrastructure.server.neighbor.unreachable" | "infrastructure.server.neighbor.upgraded" | "infrastructure.server.power.power_off" | "infrastructure.server.resources.load.high" | "infrastructure.server.resources.ram.full" | "infrastructure.server.resources.storage.volumes.base.full" | "infrastructure.server.resources.storage.cycle_pool.full" | "infrastructure.server.autoscale.up" | "infrastructure.server.sftp.lockdown" | "infrastructure.server.sftp.login" | "infrastructure.server.sftp.login.failed" | "infrastructure.server.evacuation.failed" | "infrastructure.server.evacuation.completed" | "infrastructure.server.checkin.missed" | "infrastructure.server.checkin.resumed" | "infrastructure.server.power.reboot" | "infrastructure.server.neighbor.incompatible";
|
|
14802
15009
|
/**
|
|
14803
15010
|
* Event
|
|
14804
15011
|
* @description A platform-generated event. Describes something happening on the platform at a specific time. Can be informational, security related, or a notice of something important.
|
|
@@ -14910,6 +15117,29 @@ export interface components {
|
|
|
14910
15117
|
};
|
|
14911
15118
|
"components:identifiers"?: components["schemas"]["IdentifierIncludes"];
|
|
14912
15119
|
};
|
|
15120
|
+
/**
|
|
15121
|
+
* IncludedPipelines
|
|
15122
|
+
* @description A map of pipelines, keyed by ID, included on endpoints that support it when passing the matching includes query parameter.
|
|
15123
|
+
*/
|
|
15124
|
+
IncludedPipelines: {
|
|
15125
|
+
[key: string]: components["schemas"]["Pipeline"];
|
|
15126
|
+
};
|
|
15127
|
+
/**
|
|
15128
|
+
* IncludedTriggerKeys
|
|
15129
|
+
* @description A map of trigger keys, keyed by ID, included on endpoints that support it when passing the matching includes query parameter.
|
|
15130
|
+
*/
|
|
15131
|
+
IncludedTriggerKeys: {
|
|
15132
|
+
[key: string]: components["schemas"]["TriggerKey"];
|
|
15133
|
+
};
|
|
15134
|
+
/**
|
|
15135
|
+
* PipelineRunIncludes
|
|
15136
|
+
* @description Resources related to a pipeline run, that can be included on supported endpoints when the matching includes query parameter is passed.
|
|
15137
|
+
*/
|
|
15138
|
+
PipelineRunIncludes: {
|
|
15139
|
+
creators?: components["schemas"]["CreatorInclude"];
|
|
15140
|
+
pipelines?: components["schemas"]["IncludedPipelines"];
|
|
15141
|
+
keys?: components["schemas"]["IncludedTriggerKeys"];
|
|
15142
|
+
};
|
|
14913
15143
|
/** TriggerPipelineAction */
|
|
14914
15144
|
PipelineTriggerAction: {
|
|
14915
15145
|
/**
|
|
@@ -15226,8 +15456,28 @@ export interface components {
|
|
|
15226
15456
|
[key: string]: components["schemas"]["VirtualMachineVolumeConfig"];
|
|
15227
15457
|
};
|
|
15228
15458
|
};
|
|
15459
|
+
/** VirtualMachineAddVolumesAction */
|
|
15460
|
+
VirtualMachineAddVolumesAction: {
|
|
15461
|
+
/**
|
|
15462
|
+
* @description discriminator enum property added by openapi-typescript
|
|
15463
|
+
* @enum {string}
|
|
15464
|
+
*/
|
|
15465
|
+
action: "volumes.add";
|
|
15466
|
+
/** @description Array of volume configs to add. */
|
|
15467
|
+
contents: components["schemas"]["VirtualMachineVolumeConfig"][];
|
|
15468
|
+
};
|
|
15469
|
+
/** VirtualMachineRemoveVolumesAction */
|
|
15470
|
+
VirtualMachineRemoveVolumesAction: {
|
|
15471
|
+
/**
|
|
15472
|
+
* @description discriminator enum property added by openapi-typescript
|
|
15473
|
+
* @enum {string}
|
|
15474
|
+
*/
|
|
15475
|
+
action: "volumes.remove";
|
|
15476
|
+
/** @description Array of volume IDs to remove. */
|
|
15477
|
+
contents: components["schemas"]["ID"][];
|
|
15478
|
+
};
|
|
15229
15479
|
/** VirtualMachineTask.yml */
|
|
15230
|
-
VirtualMachineTask: components["schemas"]["VirtualMachineStartAction"] | components["schemas"]["VirtualMachineStopAction"] | components["schemas"]["VirtualMachineRestartAction"] | components["schemas"]["VirtualMachineReconfigureAction"] | components["schemas"]["VirtualMachineRootPwChangeAction"] | components["schemas"]["VirtualMachineIpAllocateAction"] | components["schemas"]["VirtualMachineIpUnallocateAction"] | components["schemas"]["VirtualMachineReconfigureVolumesAction"];
|
|
15480
|
+
VirtualMachineTask: components["schemas"]["VirtualMachineStartAction"] | components["schemas"]["VirtualMachineStopAction"] | components["schemas"]["VirtualMachineRestartAction"] | components["schemas"]["VirtualMachineReconfigureAction"] | components["schemas"]["VirtualMachineRootPwChangeAction"] | components["schemas"]["VirtualMachineIpAllocateAction"] | components["schemas"]["VirtualMachineIpUnallocateAction"] | components["schemas"]["VirtualMachineReconfigureVolumesAction"] | components["schemas"]["VirtualMachineAddVolumesAction"] | components["schemas"]["VirtualMachineRemoveVolumesAction"];
|
|
15231
15481
|
/**
|
|
15232
15482
|
* VirtualMachineBaseImage
|
|
15233
15483
|
* @description Represents a virtual machine base OS image provided by Cycle.
|
|
@@ -16586,7 +16836,7 @@ export interface operations {
|
|
|
16586
16836
|
deprecated?: string;
|
|
16587
16837
|
/** @description `filter[service]=value` service filtering will allow you to filter by service type: `loadbalancer`, `discovery`, `vpn`. */
|
|
16588
16838
|
service?: string;
|
|
16589
|
-
/** @description `filter[public_network]=value` public network filtering will allow you to filter by the containers network settings: `enabled`, `disabled`, `egress-only`. */
|
|
16839
|
+
/** @description `filter[public_network]=value` public network filtering will allow you to filter by the containers network settings: `enabled`, `disabled`, `egress-only`, `environment-limited`. */
|
|
16590
16840
|
public_network?: string;
|
|
16591
16841
|
/** @description `filter[image]=ID` image filtering by ID. Submit the ID of the image you wish to filter for and the return will be any containers currently using the image. */
|
|
16592
16842
|
image?: string;
|
|
@@ -18006,6 +18256,49 @@ export interface operations {
|
|
|
18006
18256
|
default: components["responses"]["DefaultError"];
|
|
18007
18257
|
};
|
|
18008
18258
|
};
|
|
18259
|
+
getAllTlsCertificates: {
|
|
18260
|
+
parameters: {
|
|
18261
|
+
query?: {
|
|
18262
|
+
/**
|
|
18263
|
+
* @description ## Filter Field
|
|
18264
|
+
* 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.
|
|
18265
|
+
*/
|
|
18266
|
+
filter?: {
|
|
18267
|
+
/** @description `filter[domain]=value1` filter user certificates by associated domain. */
|
|
18268
|
+
domain?: string;
|
|
18269
|
+
/** @description `filter[state]=value1,value2` state filtering will allow filtering by the current state. */
|
|
18270
|
+
state?: string;
|
|
18271
|
+
/**
|
|
18272
|
+
* @description `filter[user-supplied]=true` List only those certificates that are user supplied.
|
|
18273
|
+
* `filter[user-supplied]=false` List only those certificates that are auto generated.
|
|
18274
|
+
*/
|
|
18275
|
+
"user-supplied"?: string;
|
|
18276
|
+
};
|
|
18277
|
+
/** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
|
|
18278
|
+
sort?: components["parameters"]["SortParam"];
|
|
18279
|
+
/** @description In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2` */
|
|
18280
|
+
page?: components["parameters"]["PageParam"];
|
|
18281
|
+
};
|
|
18282
|
+
header?: never;
|
|
18283
|
+
path?: never;
|
|
18284
|
+
cookie?: never;
|
|
18285
|
+
};
|
|
18286
|
+
requestBody?: never;
|
|
18287
|
+
responses: {
|
|
18288
|
+
/** @description Returns a TLS certificate. */
|
|
18289
|
+
200: {
|
|
18290
|
+
headers: {
|
|
18291
|
+
[name: string]: unknown;
|
|
18292
|
+
};
|
|
18293
|
+
content: {
|
|
18294
|
+
"application/json": {
|
|
18295
|
+
data: components["schemas"]["TlsCertificate"][];
|
|
18296
|
+
};
|
|
18297
|
+
};
|
|
18298
|
+
};
|
|
18299
|
+
default: components["responses"]["DefaultError"];
|
|
18300
|
+
};
|
|
18301
|
+
};
|
|
18009
18302
|
lookupTLSCertificate: {
|
|
18010
18303
|
parameters: {
|
|
18011
18304
|
query: {
|
|
@@ -18179,7 +18472,7 @@ export interface operations {
|
|
|
18179
18472
|
parameters: {
|
|
18180
18473
|
query?: {
|
|
18181
18474
|
/** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
|
|
18182
|
-
meta?: ("containers" | "containers_count" | "instances_count")[];
|
|
18475
|
+
meta?: ("containers" | "containers_count" | "instances_count" | "service_versions")[];
|
|
18183
18476
|
/** @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. */
|
|
18184
18477
|
include?: ("creators" | "stacks")[];
|
|
18185
18478
|
/**
|
|
@@ -18270,7 +18563,7 @@ export interface operations {
|
|
|
18270
18563
|
parameters: {
|
|
18271
18564
|
query?: {
|
|
18272
18565
|
/** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
|
|
18273
|
-
meta?: ("containers" | "containers_count" | "instances_count")[];
|
|
18566
|
+
meta?: ("containers" | "containers_count" | "instances_count" | "service_versions")[];
|
|
18274
18567
|
/** @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. */
|
|
18275
18568
|
include?: ("creators" | "stacks" | "clusters")[];
|
|
18276
18569
|
};
|
|
@@ -18816,19 +19109,7 @@ export interface operations {
|
|
|
18816
19109
|
};
|
|
18817
19110
|
content: {
|
|
18818
19111
|
"application/json": {
|
|
18819
|
-
|
|
18820
|
-
data: {
|
|
18821
|
-
default_config: components["schemas"]["LoadBalancerConfig"];
|
|
18822
|
-
/** @enum {string} */
|
|
18823
|
-
default_type: "haproxy" | "v1";
|
|
18824
|
-
/** @enum {string} */
|
|
18825
|
-
current_type: "haproxy" | "v1";
|
|
18826
|
-
base_configs?: {
|
|
18827
|
-
haproxy: components["schemas"]["HaProxyConfig"];
|
|
18828
|
-
v1: components["schemas"]["V1LbConfig"];
|
|
18829
|
-
};
|
|
18830
|
-
service: components["schemas"]["LoadBalancerEnvironmentService"] | null;
|
|
18831
|
-
};
|
|
19112
|
+
data: components["schemas"]["LoadBalancerInfo"];
|
|
18832
19113
|
};
|
|
18833
19114
|
};
|
|
18834
19115
|
};
|
|
@@ -21085,6 +21366,8 @@ export interface operations {
|
|
|
21085
21366
|
cluster?: string;
|
|
21086
21367
|
/** @description `filter[state]=value1,value2` state filtering will allow you to filter by the attached volume's current state. */
|
|
21087
21368
|
state?: string;
|
|
21369
|
+
/** @description `filter[unused]=true` List only those external volumes that are unused (not attached). */
|
|
21370
|
+
unused?: string;
|
|
21088
21371
|
};
|
|
21089
21372
|
/** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
|
|
21090
21373
|
sort?: components["parameters"]["SortParam"];
|
|
@@ -21617,7 +21900,7 @@ export interface operations {
|
|
|
21617
21900
|
default: components["responses"]["DefaultError"];
|
|
21618
21901
|
};
|
|
21619
21902
|
};
|
|
21620
|
-
|
|
21903
|
+
getProviderServerModels: {
|
|
21621
21904
|
parameters: {
|
|
21622
21905
|
query?: {
|
|
21623
21906
|
/** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
|
|
@@ -21635,8 +21918,11 @@ export interface operations {
|
|
|
21635
21918
|
};
|
|
21636
21919
|
header?: never;
|
|
21637
21920
|
path: {
|
|
21638
|
-
/**
|
|
21639
|
-
|
|
21921
|
+
/**
|
|
21922
|
+
* @description The infrastructure provider integration ID to query for server models.
|
|
21923
|
+
* Can also use a vendor string. Example `gcp`, `equinix-metal`, `abstraction`, etc.
|
|
21924
|
+
*/
|
|
21925
|
+
integrationId: string;
|
|
21640
21926
|
};
|
|
21641
21927
|
cookie?: never;
|
|
21642
21928
|
};
|
|
@@ -21666,8 +21952,11 @@ export interface operations {
|
|
|
21666
21952
|
};
|
|
21667
21953
|
header?: never;
|
|
21668
21954
|
path: {
|
|
21669
|
-
/**
|
|
21670
|
-
|
|
21955
|
+
/**
|
|
21956
|
+
* @description The infrastructure provider integration ID to query for server models.
|
|
21957
|
+
* Can also use a vendor string. Example `gcp`, `equinix-metal`, `abstraction`, etc.
|
|
21958
|
+
*/
|
|
21959
|
+
integrationId: string;
|
|
21671
21960
|
};
|
|
21672
21961
|
cookie?: never;
|
|
21673
21962
|
};
|
|
@@ -21979,6 +22268,19 @@ export interface operations {
|
|
|
21979
22268
|
query?: {
|
|
21980
22269
|
/** @description In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2` */
|
|
21981
22270
|
page?: components["parameters"]["PageParam"];
|
|
22271
|
+
/**
|
|
22272
|
+
* @description ## Filter Field
|
|
22273
|
+
* 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.
|
|
22274
|
+
*/
|
|
22275
|
+
filter?: {
|
|
22276
|
+
/** @description `filter[essential]=true` filter for essential/non-essential clusters. */
|
|
22277
|
+
essential?: string;
|
|
22278
|
+
/**
|
|
22279
|
+
* @description `filter[state]=value1,value2` state filtering will allow you to filter by the cluster's current state.
|
|
22280
|
+
* `filter[stack_build]=ID` stack build filtering by ID. Submit the ID of the stack build you wish to filter for and the return sill be any environments that have the stack build deployed to them.
|
|
22281
|
+
*/
|
|
22282
|
+
state?: string;
|
|
22283
|
+
};
|
|
21982
22284
|
};
|
|
21983
22285
|
header?: never;
|
|
21984
22286
|
path?: never;
|
|
@@ -22096,7 +22398,10 @@ export interface operations {
|
|
|
22096
22398
|
/** @description Parameters for updating a cluster. */
|
|
22097
22399
|
requestBody?: {
|
|
22098
22400
|
content: {
|
|
22099
|
-
"application/json":
|
|
22401
|
+
"application/json": {
|
|
22402
|
+
/** @description Set to true to mark the cluster as 'non-essential'. Non-essential cluster resources are excluded by default from certain metrics and summaries unless opted in. */
|
|
22403
|
+
non_essential?: boolean;
|
|
22404
|
+
};
|
|
22100
22405
|
};
|
|
22101
22406
|
};
|
|
22102
22407
|
responses: {
|
|
@@ -22227,7 +22532,7 @@ export interface operations {
|
|
|
22227
22532
|
default: components["responses"]["DefaultError"];
|
|
22228
22533
|
};
|
|
22229
22534
|
};
|
|
22230
|
-
|
|
22535
|
+
createServers: {
|
|
22231
22536
|
parameters: {
|
|
22232
22537
|
query?: never;
|
|
22233
22538
|
header?: never;
|
|
@@ -22248,14 +22553,12 @@ export interface operations {
|
|
|
22248
22553
|
model_id: string;
|
|
22249
22554
|
/** @description The location ID of the Server. */
|
|
22250
22555
|
location_id: string;
|
|
22251
|
-
/** @description The number of this Server at this location to deploy. */
|
|
22252
|
-
quantity: number;
|
|
22253
|
-
/** @description An array of hostnames for the given servers. */
|
|
22254
|
-
hostnames?: string[];
|
|
22255
22556
|
advanced?: {
|
|
22256
|
-
/** @description Advanced options to apply to the provisioning of a server. */
|
|
22257
22557
|
provision_options?: {
|
|
22258
|
-
/**
|
|
22558
|
+
/**
|
|
22559
|
+
* @description For providers that support setting this value dynamically;
|
|
22560
|
+
* A number representing the GB size of the volume to be attached to the server.
|
|
22561
|
+
*/
|
|
22259
22562
|
attached_storage_size?: number | null;
|
|
22260
22563
|
/** @description A reservation ID to be used to provision a server that has been reserved at the provider. */
|
|
22261
22564
|
reservation_id?: string | null;
|
|
@@ -22263,7 +22566,7 @@ export interface operations {
|
|
|
22263
22566
|
encrypt_storage?: boolean | null;
|
|
22264
22567
|
} | null;
|
|
22265
22568
|
zone?: string | null;
|
|
22266
|
-
}
|
|
22569
|
+
} | null;
|
|
22267
22570
|
}[];
|
|
22268
22571
|
};
|
|
22269
22572
|
};
|
|
@@ -23397,6 +23700,37 @@ export interface operations {
|
|
|
23397
23700
|
default: components["responses"]["DefaultError"];
|
|
23398
23701
|
};
|
|
23399
23702
|
};
|
|
23703
|
+
getAllPipelineRuns: {
|
|
23704
|
+
parameters: {
|
|
23705
|
+
query?: {
|
|
23706
|
+
/** @description In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2` */
|
|
23707
|
+
page?: components["parameters"]["PageParam"];
|
|
23708
|
+
/** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
|
|
23709
|
+
sort?: components["parameters"]["SortParam"];
|
|
23710
|
+
/** @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. */
|
|
23711
|
+
include?: ("creators" | "keys" | "pipelines")[];
|
|
23712
|
+
};
|
|
23713
|
+
header?: never;
|
|
23714
|
+
path?: never;
|
|
23715
|
+
cookie?: never;
|
|
23716
|
+
};
|
|
23717
|
+
requestBody?: never;
|
|
23718
|
+
responses: {
|
|
23719
|
+
/** @description Returns a list of pipeline runs. */
|
|
23720
|
+
200: {
|
|
23721
|
+
headers: {
|
|
23722
|
+
[name: string]: unknown;
|
|
23723
|
+
};
|
|
23724
|
+
content: {
|
|
23725
|
+
"application/json": {
|
|
23726
|
+
data: components["schemas"]["PipelineRun"][];
|
|
23727
|
+
includes?: components["schemas"]["PipelineRunIncludes"];
|
|
23728
|
+
};
|
|
23729
|
+
};
|
|
23730
|
+
};
|
|
23731
|
+
default: components["responses"]["DefaultError"];
|
|
23732
|
+
};
|
|
23733
|
+
};
|
|
23400
23734
|
getPipelineRuns: {
|
|
23401
23735
|
parameters: {
|
|
23402
23736
|
query?: {
|
|
@@ -23414,7 +23748,7 @@ export interface operations {
|
|
|
23414
23748
|
};
|
|
23415
23749
|
requestBody?: never;
|
|
23416
23750
|
responses: {
|
|
23417
|
-
/** @description Returns a list of
|
|
23751
|
+
/** @description Returns a list of pipeline runs. */
|
|
23418
23752
|
200: {
|
|
23419
23753
|
headers: {
|
|
23420
23754
|
[name: string]: unknown;
|
|
@@ -24261,6 +24595,46 @@ export interface operations {
|
|
|
24261
24595
|
default: components["responses"]["DefaultError"];
|
|
24262
24596
|
};
|
|
24263
24597
|
};
|
|
24598
|
+
getAllStackBuilds: {
|
|
24599
|
+
parameters: {
|
|
24600
|
+
query?: {
|
|
24601
|
+
/** @description A comma separated list of meta values. Meta values will show up under a resource's `meta` field. In the case of applying a meta to a collection of resources, each resource will have it's own relevant meta data. In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled. */
|
|
24602
|
+
meta?: "containers_count"[];
|
|
24603
|
+
/**
|
|
24604
|
+
* @description ## Filter Field
|
|
24605
|
+
* 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.
|
|
24606
|
+
*/
|
|
24607
|
+
filter?: {
|
|
24608
|
+
/** @description `filter[search]=value` search for a value associated with a field on the given Stack Build(s). */
|
|
24609
|
+
search?: string;
|
|
24610
|
+
/** @description `filter[state]=value1,value2` state filtering will allow you to filter by the Stack Build's current state. */
|
|
24611
|
+
state?: string;
|
|
24612
|
+
};
|
|
24613
|
+
/** @description An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`. */
|
|
24614
|
+
sort?: components["parameters"]["SortParam"];
|
|
24615
|
+
/** @description In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2` */
|
|
24616
|
+
page?: components["parameters"]["PageParam"];
|
|
24617
|
+
};
|
|
24618
|
+
header?: never;
|
|
24619
|
+
path?: never;
|
|
24620
|
+
cookie?: never;
|
|
24621
|
+
};
|
|
24622
|
+
requestBody?: never;
|
|
24623
|
+
responses: {
|
|
24624
|
+
/** @description Returns a list of stack builds. */
|
|
24625
|
+
200: {
|
|
24626
|
+
headers: {
|
|
24627
|
+
[name: string]: unknown;
|
|
24628
|
+
};
|
|
24629
|
+
content: {
|
|
24630
|
+
"application/json": {
|
|
24631
|
+
data: components["schemas"]["StackBuild"][];
|
|
24632
|
+
};
|
|
24633
|
+
};
|
|
24634
|
+
};
|
|
24635
|
+
default: components["responses"]["DefaultError"];
|
|
24636
|
+
};
|
|
24637
|
+
};
|
|
24264
24638
|
lookupStackBuild: {
|
|
24265
24639
|
parameters: {
|
|
24266
24640
|
query?: never;
|
|
@@ -25125,4 +25499,32 @@ export interface operations {
|
|
|
25125
25499
|
default: components["responses"]["DefaultError"];
|
|
25126
25500
|
};
|
|
25127
25501
|
};
|
|
25502
|
+
environmentMetricsPush: {
|
|
25503
|
+
parameters: {
|
|
25504
|
+
query?: never;
|
|
25505
|
+
header?: never;
|
|
25506
|
+
path?: never;
|
|
25507
|
+
cookie?: never;
|
|
25508
|
+
};
|
|
25509
|
+
requestBody?: {
|
|
25510
|
+
content: {
|
|
25511
|
+
"application/json": components["schemas"]["Metric"][];
|
|
25512
|
+
};
|
|
25513
|
+
};
|
|
25514
|
+
responses: never;
|
|
25515
|
+
};
|
|
25516
|
+
environmentEventsPush: {
|
|
25517
|
+
parameters: {
|
|
25518
|
+
query?: never;
|
|
25519
|
+
header?: never;
|
|
25520
|
+
path?: never;
|
|
25521
|
+
cookie?: never;
|
|
25522
|
+
};
|
|
25523
|
+
requestBody?: {
|
|
25524
|
+
content: {
|
|
25525
|
+
"application/json": components["schemas"]["Event"][];
|
|
25526
|
+
};
|
|
25527
|
+
};
|
|
25528
|
+
responses: never;
|
|
25529
|
+
};
|
|
25128
25530
|
}
|