@cycleplatform/api-client-typescript 0.3.10 → 0.3.12
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 +349 -149
package/package.json
CHANGED
package/src/generated/types.ts
CHANGED
|
@@ -1419,27 +1419,6 @@ export interface paths {
|
|
|
1419
1419
|
patch?: never;
|
|
1420
1420
|
trace?: never;
|
|
1421
1421
|
};
|
|
1422
|
-
"/v1/environments/monitoring-tiers": {
|
|
1423
|
-
parameters: {
|
|
1424
|
-
query?: never;
|
|
1425
|
-
header?: never;
|
|
1426
|
-
path?: never;
|
|
1427
|
-
cookie?: never;
|
|
1428
|
-
};
|
|
1429
|
-
/**
|
|
1430
|
-
* Get Environment Monitoring Tiers
|
|
1431
|
-
* @description Gets all the available monitoring tiers that can be enabled for an environment.
|
|
1432
|
-
*
|
|
1433
|
-
*/
|
|
1434
|
-
get: operations["getEnvironmentMonitoringTiers"];
|
|
1435
|
-
put?: never;
|
|
1436
|
-
post?: never;
|
|
1437
|
-
delete?: never;
|
|
1438
|
-
options?: never;
|
|
1439
|
-
head?: never;
|
|
1440
|
-
patch?: never;
|
|
1441
|
-
trace?: never;
|
|
1442
|
-
};
|
|
1443
1422
|
"/v1/environments/{environmentId}": {
|
|
1444
1423
|
parameters: {
|
|
1445
1424
|
query?: never;
|
|
@@ -2649,6 +2628,27 @@ export interface paths {
|
|
|
2649
2628
|
patch?: never;
|
|
2650
2629
|
trace?: never;
|
|
2651
2630
|
};
|
|
2631
|
+
"/v1/infrastructure/monitoring-tiers": {
|
|
2632
|
+
parameters: {
|
|
2633
|
+
query?: never;
|
|
2634
|
+
header?: never;
|
|
2635
|
+
path?: never;
|
|
2636
|
+
cookie?: never;
|
|
2637
|
+
};
|
|
2638
|
+
/**
|
|
2639
|
+
* Get Cluster Monitoring Tiers
|
|
2640
|
+
* @description Gets all the available monitoring tiers that can be enabled for a cluster.
|
|
2641
|
+
*
|
|
2642
|
+
*/
|
|
2643
|
+
get: operations["getClusterMonitoringTiers"];
|
|
2644
|
+
put?: never;
|
|
2645
|
+
post?: never;
|
|
2646
|
+
delete?: never;
|
|
2647
|
+
options?: never;
|
|
2648
|
+
head?: never;
|
|
2649
|
+
patch?: never;
|
|
2650
|
+
trace?: never;
|
|
2651
|
+
};
|
|
2652
2652
|
"/v1/infrastructure/auto-scale/groups": {
|
|
2653
2653
|
parameters: {
|
|
2654
2654
|
query?: never;
|
|
@@ -2930,6 +2930,26 @@ export interface paths {
|
|
|
2930
2930
|
patch: operations["updateClusterAccess"];
|
|
2931
2931
|
trace?: never;
|
|
2932
2932
|
};
|
|
2933
|
+
"/v1/infrastructure/clusters/{clusterId}/tasks": {
|
|
2934
|
+
parameters: {
|
|
2935
|
+
query?: never;
|
|
2936
|
+
header?: never;
|
|
2937
|
+
path?: never;
|
|
2938
|
+
cookie?: never;
|
|
2939
|
+
};
|
|
2940
|
+
get?: never;
|
|
2941
|
+
put?: never;
|
|
2942
|
+
/**
|
|
2943
|
+
* Create Cluster Job
|
|
2944
|
+
* @description Used to perform different actions on a given cluster. Requires the `clusters-manage` capability.
|
|
2945
|
+
*/
|
|
2946
|
+
post: operations["createClusterJob"];
|
|
2947
|
+
delete?: never;
|
|
2948
|
+
options?: never;
|
|
2949
|
+
head?: never;
|
|
2950
|
+
patch?: never;
|
|
2951
|
+
trace?: never;
|
|
2952
|
+
};
|
|
2933
2953
|
"/v1/infrastructure/servers": {
|
|
2934
2954
|
parameters: {
|
|
2935
2955
|
query?: never;
|
|
@@ -4305,7 +4325,7 @@ export interface components {
|
|
|
4305
4325
|
};
|
|
4306
4326
|
/** @description Two factor auth verification information. */
|
|
4307
4327
|
two_factor_auth?: {
|
|
4308
|
-
/** @description A boolean representing if the
|
|
4328
|
+
/** @description A boolean representing if the account has verified with two-factor authentication. */
|
|
4309
4329
|
verified: boolean;
|
|
4310
4330
|
} | null;
|
|
4311
4331
|
/** @description Indicates whether or not Cycle employees have authorization to log in to this Account in a support capacity. */
|
|
@@ -5041,6 +5061,7 @@ export interface components {
|
|
|
5041
5061
|
InvoiceMeta: {
|
|
5042
5062
|
/** @description The amount due for a given invoice. */
|
|
5043
5063
|
due?: number;
|
|
5064
|
+
hub?: components["schemas"]["Hub"];
|
|
5044
5065
|
};
|
|
5045
5066
|
/**
|
|
5046
5067
|
* BillingInvoice
|
|
@@ -5507,6 +5528,7 @@ export interface components {
|
|
|
5507
5528
|
autoscale: boolean;
|
|
5508
5529
|
geodns: boolean;
|
|
5509
5530
|
provider_multi_account: boolean;
|
|
5531
|
+
virtual_provider: boolean;
|
|
5510
5532
|
};
|
|
5511
5533
|
max_daily_api_requests: number | null;
|
|
5512
5534
|
ram: components["schemas"]["BillingRam"];
|
|
@@ -5646,6 +5668,14 @@ export interface components {
|
|
|
5646
5668
|
/** @description The container identifier, usually the key to the container section of a stack file. */
|
|
5647
5669
|
identifier?: string;
|
|
5648
5670
|
};
|
|
5671
|
+
/**
|
|
5672
|
+
* L2Domain
|
|
5673
|
+
* @description A standardized name for different layer-2 networks that can be configured on virtual provider hosts.
|
|
5674
|
+
* Containers will utilize this name to determine which network to attach to on the host, if set in the config.
|
|
5675
|
+
*
|
|
5676
|
+
* @enum {string}
|
|
5677
|
+
*/
|
|
5678
|
+
L2Domain: "public" | "shared" | "private";
|
|
5649
5679
|
/**
|
|
5650
5680
|
* ContainerNetwork
|
|
5651
5681
|
* @description Network configuration for a container.
|
|
@@ -5660,6 +5690,14 @@ export interface components {
|
|
|
5660
5690
|
hostname: string;
|
|
5661
5691
|
/** @description An array of port mappings for the container. */
|
|
5662
5692
|
ports?: string[];
|
|
5693
|
+
/** @description Layer 2 network configuration options for containers running on virtual provider servers. */
|
|
5694
|
+
l2?: {
|
|
5695
|
+
/** @description The layer 2 'domains' that this container's instances should bridge to on the host server.
|
|
5696
|
+
* If the host has a matching layer 2 NIC configured via a virtual provider ISO, this container's instances
|
|
5697
|
+
* will be joined directly to the host's network.
|
|
5698
|
+
* */
|
|
5699
|
+
domains: components["schemas"]["L2Domain"][];
|
|
5700
|
+
};
|
|
5663
5701
|
};
|
|
5664
5702
|
/**
|
|
5665
5703
|
* DeploymentStrategyName
|
|
@@ -6068,16 +6106,6 @@ export interface components {
|
|
|
6068
6106
|
mount_point: string;
|
|
6069
6107
|
};
|
|
6070
6108
|
} | null;
|
|
6071
|
-
/** @description When enabled, allows more customization to be applied to logging for the container. */
|
|
6072
|
-
logs?: {
|
|
6073
|
-
/** @description When enabled, log drain allows logs to be exported to a third party service. */
|
|
6074
|
-
drain?: {
|
|
6075
|
-
/** @description The URL to the third party logging service where logs will be sent. */
|
|
6076
|
-
url: string;
|
|
6077
|
-
/** @description The format Cycle will use to send the logs. */
|
|
6078
|
-
format?: ("ndjson-headers" | "ndjson-raw") | null;
|
|
6079
|
-
} | null;
|
|
6080
|
-
} | null;
|
|
6081
6109
|
};
|
|
6082
6110
|
/**
|
|
6083
6111
|
* ContainerConfig
|
|
@@ -6351,6 +6379,13 @@ export interface components {
|
|
|
6351
6379
|
state: components["schemas"]["DnsRecordState"];
|
|
6352
6380
|
events: components["schemas"]["Events"];
|
|
6353
6381
|
};
|
|
6382
|
+
/**
|
|
6383
|
+
* IpAddress
|
|
6384
|
+
* Format: ip-address
|
|
6385
|
+
* @description An IP address is a numerical label that uniquely identifies a device on a network and enables it to send and receive data.
|
|
6386
|
+
*
|
|
6387
|
+
*/
|
|
6388
|
+
IpAddress: string;
|
|
6354
6389
|
/**
|
|
6355
6390
|
* Cidr
|
|
6356
6391
|
* Format: cidr
|
|
@@ -6379,6 +6414,8 @@ export interface components {
|
|
|
6379
6414
|
* @enum {string}
|
|
6380
6415
|
*/
|
|
6381
6416
|
kind: "ipv4" | "ipv6";
|
|
6417
|
+
/** @description The IP string this IP represents. */
|
|
6418
|
+
ip: components["schemas"]["IpAddress"];
|
|
6382
6419
|
/** @description Information about the assignment of this IP. */
|
|
6383
6420
|
assignment?: {
|
|
6384
6421
|
container_id: components["schemas"]["ID"];
|
|
@@ -6390,7 +6427,9 @@ export interface components {
|
|
|
6390
6427
|
};
|
|
6391
6428
|
} | null;
|
|
6392
6429
|
/** @description A unique identifier that associates the IP with an IP pool. */
|
|
6393
|
-
pool_id:
|
|
6430
|
+
pool_id: components["schemas"]["ID"];
|
|
6431
|
+
/** @description A unique identifier that associates the IP with a network. */
|
|
6432
|
+
network_id: components["schemas"]["ID"];
|
|
6394
6433
|
/** @description The IP address. */
|
|
6395
6434
|
address: string;
|
|
6396
6435
|
/** @description The IP gateway. */
|
|
@@ -6486,7 +6525,28 @@ export interface components {
|
|
|
6486
6525
|
* @description The tier of monitoring, that determines the frequency that metrics are aggregated by the platform, on a per-environment basis.
|
|
6487
6526
|
* @enum {string}
|
|
6488
6527
|
*/
|
|
6489
|
-
MonitoringTier: "
|
|
6528
|
+
MonitoringTier: "standard" | "plus" | "premium" | "scale";
|
|
6529
|
+
/**
|
|
6530
|
+
* LogFormat
|
|
6531
|
+
* @enum {string}
|
|
6532
|
+
*/
|
|
6533
|
+
LogFormat: "ndjson-headers" | "ndjson-raw";
|
|
6534
|
+
/**
|
|
6535
|
+
* EnvironmentMonitoringConfig
|
|
6536
|
+
* @description The configuration for environment monitoring.
|
|
6537
|
+
*/
|
|
6538
|
+
EnvironmentMonitoringConfig: {
|
|
6539
|
+
/** @description An object describing the log configuration for the environment. */
|
|
6540
|
+
logs?: {
|
|
6541
|
+
/** @description An object describing log drain configuration for the environment. */
|
|
6542
|
+
drain?: {
|
|
6543
|
+
/** @description The destination URL for the log drain. */
|
|
6544
|
+
url: string;
|
|
6545
|
+
/** @description The format of the logs that will be sent to the drain URL. */
|
|
6546
|
+
format?: components["schemas"]["LogFormat"];
|
|
6547
|
+
} | null;
|
|
6548
|
+
} | null;
|
|
6549
|
+
};
|
|
6490
6550
|
/**
|
|
6491
6551
|
* EnvironmentFeatures
|
|
6492
6552
|
* @description An object representing specialized features configured for this environment.
|
|
@@ -6497,6 +6557,7 @@ export interface components {
|
|
|
6497
6557
|
/** @description The level of monitoring to enable for this environment. There is a cost associated with higher levels of monitoring. */
|
|
6498
6558
|
monitoring?: {
|
|
6499
6559
|
tier: components["schemas"]["MonitoringTier"];
|
|
6560
|
+
config?: components["schemas"]["EnvironmentMonitoringConfig"];
|
|
6500
6561
|
} | null;
|
|
6501
6562
|
};
|
|
6502
6563
|
/** HAProxyConfigSet */
|
|
@@ -6809,7 +6870,7 @@ export interface components {
|
|
|
6809
6870
|
sticky_sessions: boolean;
|
|
6810
6871
|
/** @description If a destination is unavailable, retry up to [x] times, instead of immediately failing with a 503/504 error. */
|
|
6811
6872
|
destination_retries: number;
|
|
6812
|
-
destination_prioritization?: ("latency" | "random") | null;
|
|
6873
|
+
destination_prioritization?: ("latency" | "random" | "fixed") | null;
|
|
6813
6874
|
/** @description TLS termination configuration. If null, the platform will use the default configuration. Port 443 by default has TLS termination enabled. */
|
|
6814
6875
|
tls?: {
|
|
6815
6876
|
/** @description [Advanced] Change the domain the controller listens on.
|
|
@@ -7298,7 +7359,6 @@ export interface components {
|
|
|
7298
7359
|
/** @description An optional branch arguement. Default value is `master`. */
|
|
7299
7360
|
branch?: string;
|
|
7300
7361
|
auth?: null | (components["schemas"]["CredentialsHTTP"] | components["schemas"]["CredentialsSSH"]);
|
|
7301
|
-
/** @description Repository reference information. */
|
|
7302
7362
|
ref?: {
|
|
7303
7363
|
/** @description The type of reference being used. */
|
|
7304
7364
|
type: string;
|
|
@@ -7646,7 +7706,6 @@ export interface components {
|
|
|
7646
7706
|
};
|
|
7647
7707
|
source?: components["schemas"]["DirectImageSourceType"] | components["schemas"]["StackImageSourceType"] | components["schemas"]["BucketImageSourceType"];
|
|
7648
7708
|
creator?: components["schemas"]["CreatorScope"];
|
|
7649
|
-
/** @description Information about the Factory service that built/imported the Image into Cycle. */
|
|
7650
7709
|
factory?: {
|
|
7651
7710
|
/** @description The node holding the factory service that was responsible for building the image. */
|
|
7652
7711
|
node_id: string;
|
|
@@ -8173,16 +8232,6 @@ export interface components {
|
|
|
8173
8232
|
mount_point: components["schemas"]["StackVariable"] | string;
|
|
8174
8233
|
} | components["schemas"]["StackVariable"];
|
|
8175
8234
|
} | null) | components["schemas"]["StackVariable"];
|
|
8176
|
-
/** @description When enabled, allows more customization to be applied to logging for the container. */
|
|
8177
|
-
logs?: {
|
|
8178
|
-
/** @description When enabled, log drain allows logs to be exported to a third party service. */
|
|
8179
|
-
drain?: {
|
|
8180
|
-
/** @description The URL to the third party logging service where logs will be sent. */
|
|
8181
|
-
url: string | components["schemas"]["StackVariable"];
|
|
8182
|
-
/** @description The format Cycle will use to send the logs. */
|
|
8183
|
-
format?: ("ndjson-headers" | "ndjson-raw") | null | components["schemas"]["StackVariable"];
|
|
8184
|
-
} | null | components["schemas"]["StackVariable"];
|
|
8185
|
-
} | null | components["schemas"]["StackVariable"];
|
|
8186
8235
|
};
|
|
8187
8236
|
/**
|
|
8188
8237
|
* StackSpecContainerVolume
|
|
@@ -8255,6 +8304,28 @@ export interface components {
|
|
|
8255
8304
|
/** @description If true, the container is marked as `locked` and cannot be deleted in any way until the lock is lifted. */
|
|
8256
8305
|
lock?: boolean | components["schemas"]["StackVariable"];
|
|
8257
8306
|
};
|
|
8307
|
+
/**
|
|
8308
|
+
* StackSpecMonitoringLogs
|
|
8309
|
+
* @description Log configuration for containers in this stack.
|
|
8310
|
+
*/
|
|
8311
|
+
StackSpecMonitoringLogs: {
|
|
8312
|
+
logs?: {
|
|
8313
|
+
/** @description When enabled, log drain allows logs to be exported to a third party service. */
|
|
8314
|
+
drain?: {
|
|
8315
|
+
/** @description The URL to the third party logging service where logs will be sent. */
|
|
8316
|
+
url: string | components["schemas"]["StackVariable"];
|
|
8317
|
+
/** @description The format Cycle will use to send the logs. */
|
|
8318
|
+
format?: ("ndjson-headers" | "ndjson-raw") | null | components["schemas"]["StackVariable"];
|
|
8319
|
+
} | null | components["schemas"]["StackVariable"];
|
|
8320
|
+
} | null | components["schemas"]["StackVariable"];
|
|
8321
|
+
};
|
|
8322
|
+
/**
|
|
8323
|
+
* StackSpecMonitoringConfig
|
|
8324
|
+
* @description Monitoring options for the stack build & containers within this stack.
|
|
8325
|
+
*/
|
|
8326
|
+
StackSpecMonitoringConfig: {
|
|
8327
|
+
logs?: components["schemas"]["StackSpecMonitoringLogs"] | null | components["schemas"]["StackVariable"];
|
|
8328
|
+
};
|
|
8258
8329
|
/**
|
|
8259
8330
|
* StackService
|
|
8260
8331
|
* @description Stack spec configuration options common to all environment services. If one of these properties is defined, all must be.
|
|
@@ -8573,7 +8644,7 @@ export interface components {
|
|
|
8573
8644
|
sticky_sessions: boolean | components["schemas"]["StackVariable"];
|
|
8574
8645
|
/** @description If a destination is unavailable, retry up to [x] times, instead of immediately failing with a 503/504 error. */
|
|
8575
8646
|
destination_retries: number | components["schemas"]["StackVariable"];
|
|
8576
|
-
destination_prioritization?: ("latency" | "random") | components["schemas"]["StackVariable"] | null;
|
|
8647
|
+
destination_prioritization?: ("latency" | "random" | "fixed") | components["schemas"]["StackVariable"] | null;
|
|
8577
8648
|
/** @description TLS termination configuration. If null, the platform will use the default configuration. Port 443 by default has TLS termination enabled. */
|
|
8578
8649
|
tls?: ({
|
|
8579
8650
|
/** @description [Advanced] Change the domain the controller listens on.
|
|
@@ -8763,6 +8834,8 @@ export interface components {
|
|
|
8763
8834
|
containers: {
|
|
8764
8835
|
[key: string]: components["schemas"]["StackSpecContainer"];
|
|
8765
8836
|
} | components["schemas"]["StackVariable"];
|
|
8837
|
+
/** @description Monitoring options for containers within this stack. */
|
|
8838
|
+
monitoring?: components["schemas"]["StackSpecMonitoringConfig"] | components["schemas"]["StackVariable"];
|
|
8766
8839
|
/** @description Settings for any auxillary services deployed as part of the environment, such as load balancer and discovery services. */
|
|
8767
8840
|
services?: ({
|
|
8768
8841
|
discovery?: components["schemas"]["StackSpecDiscoveryService"] | components["schemas"]["StackVariable"] | null;
|
|
@@ -9180,6 +9253,7 @@ export interface components {
|
|
|
9180
9253
|
*/
|
|
9181
9254
|
current: "new" | "offline" | "authorizing" | "online" | "decommissioned";
|
|
9182
9255
|
changed: components["schemas"]["DateTime"];
|
|
9256
|
+
desired?: ("new" | "offline" | "authorizing" | "online" | "decommissioned") | null;
|
|
9183
9257
|
} & components["schemas"]["State"];
|
|
9184
9258
|
/**
|
|
9185
9259
|
* ServerStatsNetwork
|
|
@@ -9568,6 +9642,12 @@ export interface components {
|
|
|
9568
9642
|
hub_id: components["schemas"]["HubID"];
|
|
9569
9643
|
acl?: components["schemas"]["ACL"] | null;
|
|
9570
9644
|
state: components["schemas"]["ClusterState"];
|
|
9645
|
+
features: {
|
|
9646
|
+
/** @description The level of monitoring to enable for this cluster. There is a cost associated with higher levels of monitoring. */
|
|
9647
|
+
monitoring?: {
|
|
9648
|
+
tier: components["schemas"]["MonitoringTier"];
|
|
9649
|
+
} | null;
|
|
9650
|
+
};
|
|
9571
9651
|
/**
|
|
9572
9652
|
* ClusterEvents
|
|
9573
9653
|
* @description A collection of timestamps for each event in the cluster's lifetime.
|
|
@@ -9860,7 +9940,7 @@ export interface components {
|
|
|
9860
9940
|
identifier: components["schemas"]["Identifier"];
|
|
9861
9941
|
/** @description Authentication information for the integration, can be null. */
|
|
9862
9942
|
auth?: components["schemas"]["IntegrationAuth"] | null;
|
|
9863
|
-
/** @description
|
|
9943
|
+
/** @description Updated key-value pairs associated with the integration. */
|
|
9864
9944
|
extra?: {
|
|
9865
9945
|
[key: string]: string;
|
|
9866
9946
|
} | null;
|
|
@@ -10000,6 +10080,7 @@ export interface components {
|
|
|
10000
10080
|
last_checkin?: components["schemas"]["DateTime"];
|
|
10001
10081
|
state?: components["schemas"]["NodeState"];
|
|
10002
10082
|
};
|
|
10083
|
+
sdn_pool_ips?: components["schemas"]["Ip"][];
|
|
10003
10084
|
};
|
|
10004
10085
|
/**
|
|
10005
10086
|
* Instance
|
|
@@ -10765,8 +10846,8 @@ export interface components {
|
|
|
10765
10846
|
ips?: components["schemas"]["Ip"][] | null;
|
|
10766
10847
|
/** @description The server the virtual machine is deployed to. */
|
|
10767
10848
|
server?: components["schemas"]["Server"] | null;
|
|
10768
|
-
/** @description An array of private IP addresses associated with this virtual machine
|
|
10769
|
-
|
|
10849
|
+
/** @description An array of private IP addresses associated with the hypervisor for this virtual machine.. */
|
|
10850
|
+
hypervisor_ips?: {
|
|
10770
10851
|
ipv4?: string;
|
|
10771
10852
|
ipv6?: string;
|
|
10772
10853
|
} | null;
|
|
@@ -10897,43 +10978,6 @@ export interface components {
|
|
|
10897
10978
|
generated: components["schemas"]["DateTime"];
|
|
10898
10979
|
};
|
|
10899
10980
|
};
|
|
10900
|
-
/**
|
|
10901
|
-
* MonitoringTierDetails
|
|
10902
|
-
* @description Detailed information about a monitoring tier's features.
|
|
10903
|
-
*/
|
|
10904
|
-
MonitoringTierDetails: {
|
|
10905
|
-
/** @description Whether or not this tier is a selectable monitoring tier for an environment. A disabled tier may be either one coming in the future, or a legacy tier that is no longer available, but saved for historical reasons. */
|
|
10906
|
-
enabled: boolean;
|
|
10907
|
-
/** @description Details on how metrics are handled for this tier. */
|
|
10908
|
-
metrics: {
|
|
10909
|
-
service_granularity: components["schemas"]["Duration"];
|
|
10910
|
-
container_telemetry_granularity: components["schemas"]["Duration"];
|
|
10911
|
-
retention_period: components["schemas"]["Duration"];
|
|
10912
|
-
downsample_period: components["schemas"]["Duration"];
|
|
10913
|
-
/** @description Whether or not custom user-submitted metrics are supported on this tier. */
|
|
10914
|
-
custom: boolean;
|
|
10915
|
-
};
|
|
10916
|
-
/** @description Details on how events are handled for this tier. */
|
|
10917
|
-
events: {
|
|
10918
|
-
retention_period: components["schemas"]["Duration"];
|
|
10919
|
-
/** @description Whether or not custom user-submitted events are supported on this tier. */
|
|
10920
|
-
custom: boolean;
|
|
10921
|
-
};
|
|
10922
|
-
/** @description Details on how logs are handled for this tier. */
|
|
10923
|
-
logs: {
|
|
10924
|
-
/** @description Whether or not log analysis is enabled on this tier. */
|
|
10925
|
-
analysis: boolean;
|
|
10926
|
-
/** @description Whether or not log aggregation is enabled on this tier. */
|
|
10927
|
-
aggregation: boolean;
|
|
10928
|
-
/** @description Whether or not custom user-submitted logs are supported on this tier. */
|
|
10929
|
-
custom: boolean;
|
|
10930
|
-
};
|
|
10931
|
-
features: {
|
|
10932
|
-
public_ping_monitor: boolean;
|
|
10933
|
-
};
|
|
10934
|
-
/** @description The monthly cost (in mills) of enabling this tier on an environment. */
|
|
10935
|
-
cost_mills: number;
|
|
10936
|
-
};
|
|
10937
10981
|
/**
|
|
10938
10982
|
* ClusterIncludes
|
|
10939
10983
|
* @description A resource associated with a cluster.
|
|
@@ -10988,8 +11032,22 @@ export interface components {
|
|
|
10988
11032
|
tags: components["schemas"]["EnvironmentDeploymentTags"];
|
|
10989
11033
|
};
|
|
10990
11034
|
};
|
|
11035
|
+
/**
|
|
11036
|
+
* EnvironmentReconfigureMonitoringAction
|
|
11037
|
+
* @description A task to reconfigure monitoring on an environment.
|
|
11038
|
+
*/
|
|
11039
|
+
EnvironmentReconfigureMonitoringAction: {
|
|
11040
|
+
/**
|
|
11041
|
+
* @description The action to take. (enum property replaced by openapi-typescript)
|
|
11042
|
+
* @enum {string}
|
|
11043
|
+
*/
|
|
11044
|
+
action: "monitoring.reconfigure";
|
|
11045
|
+
contents: {
|
|
11046
|
+
config: components["schemas"]["EnvironmentMonitoringConfig"];
|
|
11047
|
+
};
|
|
11048
|
+
};
|
|
10991
11049
|
/** EnvironmentTask */
|
|
10992
|
-
EnvironmentTask: components["schemas"]["EnvironmentStartAction"] | components["schemas"]["EnvironmentStopAction"] | components["schemas"]["EnvironmentInitializeAction"] | components["schemas"]["EnvironmentReconfigureDeploymentsAction"];
|
|
11050
|
+
EnvironmentTask: components["schemas"]["EnvironmentStartAction"] | components["schemas"]["EnvironmentStopAction"] | components["schemas"]["EnvironmentInitializeAction"] | components["schemas"]["EnvironmentReconfigureDeploymentsAction"] | components["schemas"]["EnvironmentReconfigureMonitoringAction"];
|
|
10993
11051
|
/**
|
|
10994
11052
|
* EnvironmentServiceContainerSummary
|
|
10995
11053
|
* @description An object containing information about a service container associated with this environment.
|
|
@@ -11145,6 +11203,7 @@ export interface components {
|
|
|
11145
11203
|
scope: components["schemas"]["ScopedVariableScope"];
|
|
11146
11204
|
access: components["schemas"]["ScopedVariableAccess"];
|
|
11147
11205
|
source: null | (components["schemas"]["URLSource"] | components["schemas"]["RawSource"]);
|
|
11206
|
+
deployment?: components["schemas"]["Deployment"] | null;
|
|
11148
11207
|
state: components["schemas"]["ScopedVariableState"];
|
|
11149
11208
|
/**
|
|
11150
11209
|
* ScopedVariableEvents
|
|
@@ -11701,17 +11760,10 @@ export interface components {
|
|
|
11701
11760
|
* @description The activity event.
|
|
11702
11761
|
* @enum {string}
|
|
11703
11762
|
*/
|
|
11704
|
-
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.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.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.cluster.create" | "infrastructure.cluster.update" | "infrastructure.cluster.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.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.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";
|
|
11763
|
+
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.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.cluster.create" | "infrastructure.cluster.update" | "infrastructure.cluster.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.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.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";
|
|
11705
11764
|
/** @description A timestamp for when the activity took place. */
|
|
11706
11765
|
time: components["schemas"]["DateTime"];
|
|
11707
11766
|
};
|
|
11708
|
-
/**
|
|
11709
|
-
* IpAddress
|
|
11710
|
-
* Format: ip-address
|
|
11711
|
-
* @description An IP address is a numerical label that uniquely identifies a device on a network and enables it to send and receive data.
|
|
11712
|
-
*
|
|
11713
|
-
*/
|
|
11714
|
-
IpAddress: string;
|
|
11715
11767
|
/**
|
|
11716
11768
|
* VirtualProviderIsoNic
|
|
11717
11769
|
* @description Server ISO network interface.
|
|
@@ -11740,6 +11792,10 @@ export interface components {
|
|
|
11740
11792
|
/** @enum {string} */
|
|
11741
11793
|
mode: "all" | "none" | "ipv4" | "ipv6";
|
|
11742
11794
|
} | null;
|
|
11795
|
+
/** @description Configuration options for extending the L2 network into containers directly via a bridge. */
|
|
11796
|
+
l2?: {
|
|
11797
|
+
domain: components["schemas"]["L2Domain"];
|
|
11798
|
+
} | null;
|
|
11743
11799
|
};
|
|
11744
11800
|
/**
|
|
11745
11801
|
* VirtualProviderIsoBond
|
|
@@ -11753,8 +11809,17 @@ export interface components {
|
|
|
11753
11809
|
/** @description The mac address of the server. */
|
|
11754
11810
|
mac_address?: string | null;
|
|
11755
11811
|
}[];
|
|
11756
|
-
/**
|
|
11757
|
-
|
|
11812
|
+
/**
|
|
11813
|
+
* @description balance-rr - Rotate packets evenly across all links.
|
|
11814
|
+
* active-backup - One link active, failover to backup if needed.
|
|
11815
|
+
* balance-xor - Distributes based on a hash (MAC/IP/port).
|
|
11816
|
+
* lacp - Standard link aggregations using LACP.
|
|
11817
|
+
* balance-tlb - Adaptive transmit-side balancing (no switch config needed)..
|
|
11818
|
+
* balance-alb - TLB + receive load balancing (no switch config needed)..
|
|
11819
|
+
*
|
|
11820
|
+
* @enum {string}
|
|
11821
|
+
*/
|
|
11822
|
+
mode: "balance-rr" | "active-backup" | "balance-xor" | "lacp" | "balance-tlb" | "balance-alb";
|
|
11758
11823
|
};
|
|
11759
11824
|
/**
|
|
11760
11825
|
* VirtualProviderIso
|
|
@@ -11793,6 +11858,8 @@ export interface components {
|
|
|
11793
11858
|
nics: components["schemas"]["VirtualProviderIsoNic"][];
|
|
11794
11859
|
/** @description An array of bonds */
|
|
11795
11860
|
bonds?: components["schemas"]["VirtualProviderIsoBond"][];
|
|
11861
|
+
/** @description Appends additional kernel arguments when booting CycleOS. */
|
|
11862
|
+
additional_kernel_args?: string | null;
|
|
11796
11863
|
} | null;
|
|
11797
11864
|
};
|
|
11798
11865
|
backend?: {
|
|
@@ -11935,8 +12002,8 @@ export interface components {
|
|
|
11935
12002
|
*/
|
|
11936
12003
|
current: "live" | "deleting" | "deleted";
|
|
11937
12004
|
} & components["schemas"]["State"];
|
|
11938
|
-
/**
|
|
11939
|
-
|
|
12005
|
+
/** NetworkL2DhcpDetails */
|
|
12006
|
+
NetworkL2DhcpDetails: {
|
|
11940
12007
|
/**
|
|
11941
12008
|
* @description discriminator enum property added by openapi-typescript
|
|
11942
12009
|
* @enum {string}
|
|
@@ -11944,8 +12011,8 @@ export interface components {
|
|
|
11944
12011
|
method: "dhcp";
|
|
11945
12012
|
details?: Record<string, never>;
|
|
11946
12013
|
};
|
|
11947
|
-
/**
|
|
11948
|
-
|
|
12014
|
+
/** NetworkL2StaticDetails */
|
|
12015
|
+
NetworkL2StaticDetails: {
|
|
11949
12016
|
/**
|
|
11950
12017
|
* @description discriminator enum property added by openapi-typescript
|
|
11951
12018
|
* @enum {string}
|
|
@@ -11971,19 +12038,20 @@ export interface components {
|
|
|
11971
12038
|
};
|
|
11972
12039
|
};
|
|
11973
12040
|
/**
|
|
11974
|
-
*
|
|
11975
|
-
* @description
|
|
12041
|
+
* NetworkL2
|
|
12042
|
+
* @description Layer 2 network information for a Cycle SDN.
|
|
11976
12043
|
*/
|
|
11977
|
-
|
|
12044
|
+
NetworkL2: {
|
|
12045
|
+
domain?: components["schemas"]["L2Domain"] | null;
|
|
11978
12046
|
location_ids: components["schemas"]["ID"][];
|
|
11979
|
-
vid
|
|
12047
|
+
vid?: number | null;
|
|
11980
12048
|
host_interface?: string | null;
|
|
11981
|
-
/** @description An array of
|
|
12049
|
+
/** @description An array of L2 routes that are added to this SDN */
|
|
11982
12050
|
routes?: {
|
|
11983
12051
|
network: components["schemas"]["Cidr"];
|
|
11984
12052
|
gateway?: components["schemas"]["IpAddress"];
|
|
11985
12053
|
}[];
|
|
11986
|
-
ips: components["schemas"]["
|
|
12054
|
+
ips: components["schemas"]["NetworkL2DhcpDetails"] | components["schemas"]["NetworkL2StaticDetails"];
|
|
11987
12055
|
};
|
|
11988
12056
|
/**
|
|
11989
12057
|
* NetworkPrivacySettings
|
|
@@ -12019,7 +12087,7 @@ export interface components {
|
|
|
12019
12087
|
creator: components["schemas"]["CreatorScope"];
|
|
12020
12088
|
hub_id: components["schemas"]["HubID"];
|
|
12021
12089
|
state: components["schemas"]["NetworkState"];
|
|
12022
|
-
|
|
12090
|
+
l2?: components["schemas"]["NetworkL2"] | null;
|
|
12023
12091
|
private_network?: components["schemas"]["NetworkPrivacySettings"] | null;
|
|
12024
12092
|
/** @description An array of environments and timestamps. */
|
|
12025
12093
|
environments?: {
|
|
@@ -12620,6 +12688,10 @@ export interface components {
|
|
|
12620
12688
|
add_new: boolean;
|
|
12621
12689
|
/** @description When deploying to the environment, any scoped variables defined in the build that match an existing scoped variable in the environment will cause the existing scoped variable to be updated to the new value. */
|
|
12622
12690
|
replace_existing: boolean;
|
|
12691
|
+
/** @description If set to true and `add_new` is enabled, any variables that dont exist FOR THAT DEPLOYMENT will be created.
|
|
12692
|
+
* If set to true and `replace_existing` is enabled, any matching variables FOR THAT DEPLOYMENT will be replaced.
|
|
12693
|
+
* */
|
|
12694
|
+
associate_deployment: boolean;
|
|
12623
12695
|
} | null;
|
|
12624
12696
|
};
|
|
12625
12697
|
/**
|
|
@@ -13263,6 +13335,81 @@ export interface components {
|
|
|
13263
13335
|
/** @description A description for the deployment strategy. */
|
|
13264
13336
|
description: string;
|
|
13265
13337
|
};
|
|
13338
|
+
/** MonitoringUsage */
|
|
13339
|
+
MonitoringUsage: {
|
|
13340
|
+
/** @description Number that, when used in conjunction with unit, describes the included usage. */
|
|
13341
|
+
included: number;
|
|
13342
|
+
/** @description A string describing the metric unit. */
|
|
13343
|
+
unit: string;
|
|
13344
|
+
/** @description A boolean indicating if there is hard usage limit on the tier. */
|
|
13345
|
+
hard_cap: boolean;
|
|
13346
|
+
/** @description An object describing the additonal cost of monitoring exceeding the included usage. */
|
|
13347
|
+
additional?: {
|
|
13348
|
+
size: number;
|
|
13349
|
+
price: components["schemas"]["BillingAmount"];
|
|
13350
|
+
} | null;
|
|
13351
|
+
};
|
|
13352
|
+
/** MonitoringTierDetailsLogsCollectionTier */
|
|
13353
|
+
MonitoringTierDetailsLogsCollectionTier: {
|
|
13354
|
+
retention_period: components["schemas"]["Duration"];
|
|
13355
|
+
storage: components["schemas"]["MonitoringUsage"];
|
|
13356
|
+
bandwidth: components["schemas"]["MonitoringUsage"];
|
|
13357
|
+
};
|
|
13358
|
+
/**
|
|
13359
|
+
* MonitoringTierDetails
|
|
13360
|
+
* @description Detailed information about a monitoring tier's features.
|
|
13361
|
+
*/
|
|
13362
|
+
MonitoringTierDetails: {
|
|
13363
|
+
/** @description Whether or not this tier is a selectable monitoring tier for an environment. A disabled tier may be either one coming in the future, or a legacy tier that is no longer available, but saved for historical reasons. */
|
|
13364
|
+
enabled: boolean;
|
|
13365
|
+
/** @description A hamanized description of the monitoring tier. */
|
|
13366
|
+
description: string;
|
|
13367
|
+
/** @description Details on how metrics are handled for this tier. */
|
|
13368
|
+
metrics: {
|
|
13369
|
+
service_granularity: components["schemas"]["Duration"];
|
|
13370
|
+
container_telemetry_granularity: components["schemas"]["Duration"];
|
|
13371
|
+
retention_period: components["schemas"]["Duration"];
|
|
13372
|
+
downsample_period: components["schemas"]["Duration"];
|
|
13373
|
+
/** @description Whether or not custom user-submitted metrics are supported on this tier. */
|
|
13374
|
+
custom: boolean;
|
|
13375
|
+
usage: components["schemas"]["MonitoringUsage"];
|
|
13376
|
+
};
|
|
13377
|
+
/** @description Details on how events are handled for this tier. */
|
|
13378
|
+
events: {
|
|
13379
|
+
retention_period: components["schemas"]["Duration"];
|
|
13380
|
+
/** @description Whether or not custom user-submitted events are supported on this tier. */
|
|
13381
|
+
custom: boolean;
|
|
13382
|
+
usage: components["schemas"]["MonitoringUsage"];
|
|
13383
|
+
};
|
|
13384
|
+
/** @description Details on how logs are handled for this tier. */
|
|
13385
|
+
logs: {
|
|
13386
|
+
/** @description Details on log analysis features for this tier. */
|
|
13387
|
+
analysis: {
|
|
13388
|
+
/** @description Indicates if log analysis is supported on this tier. */
|
|
13389
|
+
supported: boolean;
|
|
13390
|
+
rules: number;
|
|
13391
|
+
retention_period: components["schemas"]["Duration"];
|
|
13392
|
+
usage: components["schemas"]["MonitoringUsage"];
|
|
13393
|
+
};
|
|
13394
|
+
/** @description Details on log collection features for this tier. */
|
|
13395
|
+
collection: {
|
|
13396
|
+
/** @description Indicates if log collection is supported on this tier. */
|
|
13397
|
+
supported: boolean;
|
|
13398
|
+
cold?: components["schemas"]["MonitoringTierDetailsLogsCollectionTier"] | null;
|
|
13399
|
+
hot?: components["schemas"]["MonitoringTierDetailsLogsCollectionTier"] | null;
|
|
13400
|
+
};
|
|
13401
|
+
};
|
|
13402
|
+
forwarding: {
|
|
13403
|
+
/** @description Indicates if metric forwarding is supported on this tier. */
|
|
13404
|
+
supported: boolean;
|
|
13405
|
+
/** @description Describes maximum included bandwidth and overage costs, if applicable. */
|
|
13406
|
+
bandwidth: components["schemas"]["MonitoringUsage"];
|
|
13407
|
+
};
|
|
13408
|
+
features: {
|
|
13409
|
+
public_ping_monitor: boolean;
|
|
13410
|
+
};
|
|
13411
|
+
price: components["schemas"]["BillingAmount"];
|
|
13412
|
+
};
|
|
13266
13413
|
/**
|
|
13267
13414
|
* ServerModelsIncludes
|
|
13268
13415
|
* @description A resource associated with a server models.
|
|
@@ -13298,6 +13445,22 @@ export interface components {
|
|
|
13298
13445
|
};
|
|
13299
13446
|
/** VirtualProviderIsoTask */
|
|
13300
13447
|
VirtualProviderIsoTask: components["schemas"]["VirtualProviderGenerateIsoAction"];
|
|
13448
|
+
/**
|
|
13449
|
+
* ClusterReconfigureMonitoringTierAction
|
|
13450
|
+
* @description A job that reconfigures the monitoring tier for the cluster.
|
|
13451
|
+
*/
|
|
13452
|
+
ClusterReconfigureMonitoringTierAction: {
|
|
13453
|
+
/**
|
|
13454
|
+
* @description The action to take. (enum property replaced by openapi-typescript)
|
|
13455
|
+
* @enum {string}
|
|
13456
|
+
*/
|
|
13457
|
+
action: "features.monitoring.tier.reconfigure";
|
|
13458
|
+
contents?: {
|
|
13459
|
+
tier?: components["schemas"]["MonitoringTier"];
|
|
13460
|
+
};
|
|
13461
|
+
};
|
|
13462
|
+
/** ClusterTask */
|
|
13463
|
+
ClusterTask: components["schemas"]["ClusterReconfigureMonitoringTierAction"];
|
|
13301
13464
|
/** ServerStatsCpuUsageTelemetry */
|
|
13302
13465
|
ServerStatsCpuUsageTelemetry: {
|
|
13303
13466
|
/** Format: float */
|
|
@@ -13740,7 +13903,7 @@ export interface components {
|
|
|
13740
13903
|
* EventType
|
|
13741
13904
|
* @enum {string}
|
|
13742
13905
|
*/
|
|
13743
|
-
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" | "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.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.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.power.power-off";
|
|
13906
|
+
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" | "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.power.power-off";
|
|
13744
13907
|
/**
|
|
13745
13908
|
* Event
|
|
13746
13909
|
* @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.
|
|
@@ -14810,7 +14973,9 @@ export interface operations {
|
|
|
14810
14973
|
parameters: {
|
|
14811
14974
|
query?: {
|
|
14812
14975
|
/** @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. */
|
|
14813
|
-
meta?: "due"[];
|
|
14976
|
+
meta?: ("due" | "hub")[];
|
|
14977
|
+
/** @description Token can be optionally provided for authentication outside of the hub context. */
|
|
14978
|
+
token?: string;
|
|
14814
14979
|
};
|
|
14815
14980
|
header?: never;
|
|
14816
14981
|
path: {
|
|
@@ -15813,7 +15978,7 @@ export interface operations {
|
|
|
15813
15978
|
/** @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. */
|
|
15814
15979
|
include?: ("creators" | "servers" | "locations" | "integrations" | "containers" | "environments")[];
|
|
15815
15980
|
/** @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. */
|
|
15816
|
-
meta?: "node"[];
|
|
15981
|
+
meta?: ("node" | "sdn_pool_ips")[];
|
|
15817
15982
|
/** @description ## Filter Field
|
|
15818
15983
|
* 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.
|
|
15819
15984
|
* */
|
|
@@ -15926,7 +16091,7 @@ export interface operations {
|
|
|
15926
16091
|
parameters: {
|
|
15927
16092
|
query?: {
|
|
15928
16093
|
/** @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. */
|
|
15929
|
-
meta?: "node"[];
|
|
16094
|
+
meta?: ("node" | "sdn_pool_ips")[];
|
|
15930
16095
|
/** @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. */
|
|
15931
16096
|
include?: ("creators" | "servers" | "locations" | "integrations" | "containers" | "environments")[];
|
|
15932
16097
|
};
|
|
@@ -17152,31 +17317,6 @@ export interface operations {
|
|
|
17152
17317
|
default: components["responses"]["DefaultError"];
|
|
17153
17318
|
};
|
|
17154
17319
|
};
|
|
17155
|
-
getEnvironmentMonitoringTiers: {
|
|
17156
|
-
parameters: {
|
|
17157
|
-
query?: never;
|
|
17158
|
-
header?: never;
|
|
17159
|
-
path?: never;
|
|
17160
|
-
cookie?: never;
|
|
17161
|
-
};
|
|
17162
|
-
requestBody?: never;
|
|
17163
|
-
responses: {
|
|
17164
|
-
/** @description A list of monitoring tiers. */
|
|
17165
|
-
200: {
|
|
17166
|
-
headers: {
|
|
17167
|
-
[name: string]: unknown;
|
|
17168
|
-
};
|
|
17169
|
-
content: {
|
|
17170
|
-
"application/json": {
|
|
17171
|
-
data: {
|
|
17172
|
-
[key: string]: components["schemas"]["MonitoringTierDetails"];
|
|
17173
|
-
};
|
|
17174
|
-
};
|
|
17175
|
-
};
|
|
17176
|
-
};
|
|
17177
|
-
default: components["responses"]["DefaultError"];
|
|
17178
|
-
};
|
|
17179
|
-
};
|
|
17180
17320
|
getEnvironment: {
|
|
17181
17321
|
parameters: {
|
|
17182
17322
|
query?: {
|
|
@@ -17256,10 +17396,6 @@ export interface operations {
|
|
|
17256
17396
|
identifier?: string | null;
|
|
17257
17397
|
version?: string | null;
|
|
17258
17398
|
about?: components["schemas"]["EnvironmentAbout"] | null;
|
|
17259
|
-
/** @description The level of monitoring to enable for this environment. There is a cost associated with higher levels of monitoring. */
|
|
17260
|
-
monitoring?: {
|
|
17261
|
-
tier: components["schemas"]["MonitoringTier"];
|
|
17262
|
-
} | null;
|
|
17263
17399
|
};
|
|
17264
17400
|
};
|
|
17265
17401
|
};
|
|
@@ -17515,6 +17651,7 @@ export interface operations {
|
|
|
17515
17651
|
access?: components["schemas"]["ScopedVariableAccess"];
|
|
17516
17652
|
/** @description The source or value of the Scoped Variable. */
|
|
17517
17653
|
source: components["schemas"]["RawSource"] | components["schemas"]["URLSource"];
|
|
17654
|
+
deployment?: components["schemas"]["Deployment"] | null;
|
|
17518
17655
|
};
|
|
17519
17656
|
};
|
|
17520
17657
|
};
|
|
@@ -19965,6 +20102,31 @@ export interface operations {
|
|
|
19965
20102
|
default: components["responses"]["DefaultError"];
|
|
19966
20103
|
};
|
|
19967
20104
|
};
|
|
20105
|
+
getClusterMonitoringTiers: {
|
|
20106
|
+
parameters: {
|
|
20107
|
+
query?: never;
|
|
20108
|
+
header?: never;
|
|
20109
|
+
path?: never;
|
|
20110
|
+
cookie?: never;
|
|
20111
|
+
};
|
|
20112
|
+
requestBody?: never;
|
|
20113
|
+
responses: {
|
|
20114
|
+
/** @description A list of monitoring tiers. */
|
|
20115
|
+
200: {
|
|
20116
|
+
headers: {
|
|
20117
|
+
[name: string]: unknown;
|
|
20118
|
+
};
|
|
20119
|
+
content: {
|
|
20120
|
+
"application/json": {
|
|
20121
|
+
data: {
|
|
20122
|
+
[key: string]: components["schemas"]["MonitoringTierDetails"];
|
|
20123
|
+
};
|
|
20124
|
+
};
|
|
20125
|
+
};
|
|
20126
|
+
};
|
|
20127
|
+
default: components["responses"]["DefaultError"];
|
|
20128
|
+
};
|
|
20129
|
+
};
|
|
19968
20130
|
getAutoScaleGroups: {
|
|
19969
20131
|
parameters: {
|
|
19970
20132
|
query?: {
|
|
@@ -20312,6 +20474,8 @@ export interface operations {
|
|
|
20312
20474
|
nics?: components["schemas"]["VirtualProviderIsoNic"][];
|
|
20313
20475
|
/** @description An array of bonds */
|
|
20314
20476
|
bonds?: components["schemas"]["VirtualProviderIsoBond"][];
|
|
20477
|
+
/** @description Appends additional kernel arguments when booting CycleOS. */
|
|
20478
|
+
additional_kernel_args?: string | null;
|
|
20315
20479
|
} | null;
|
|
20316
20480
|
};
|
|
20317
20481
|
};
|
|
@@ -20420,6 +20584,8 @@ export interface operations {
|
|
|
20420
20584
|
nics: components["schemas"]["VirtualProviderIsoNic"][];
|
|
20421
20585
|
/** @description An array of bonds */
|
|
20422
20586
|
bonds?: components["schemas"]["VirtualProviderIsoBond"][];
|
|
20587
|
+
/** @description Appends additional kernel arguments when booting CycleOS. */
|
|
20588
|
+
additional_kernel_args?: string | null;
|
|
20423
20589
|
} | null;
|
|
20424
20590
|
};
|
|
20425
20591
|
};
|
|
@@ -20565,7 +20731,7 @@ export interface operations {
|
|
|
20565
20731
|
query?: never;
|
|
20566
20732
|
header?: never;
|
|
20567
20733
|
path: {
|
|
20568
|
-
/** @description The ID of the requested cluster. */
|
|
20734
|
+
/** @description The ID or identifier of the requested cluster. */
|
|
20569
20735
|
clusterId: string;
|
|
20570
20736
|
};
|
|
20571
20737
|
cookie?: never;
|
|
@@ -20676,6 +20842,37 @@ export interface operations {
|
|
|
20676
20842
|
default: components["responses"]["DefaultError"];
|
|
20677
20843
|
};
|
|
20678
20844
|
};
|
|
20845
|
+
createClusterJob: {
|
|
20846
|
+
parameters: {
|
|
20847
|
+
query?: never;
|
|
20848
|
+
header?: never;
|
|
20849
|
+
path: {
|
|
20850
|
+
/** @description The ID for the given cluster. */
|
|
20851
|
+
clusterId: string;
|
|
20852
|
+
};
|
|
20853
|
+
cookie?: never;
|
|
20854
|
+
};
|
|
20855
|
+
/** @description Parameters for creating the new cluster Job. */
|
|
20856
|
+
requestBody?: {
|
|
20857
|
+
content: {
|
|
20858
|
+
"application/json": components["schemas"]["ClusterTask"];
|
|
20859
|
+
};
|
|
20860
|
+
};
|
|
20861
|
+
responses: {
|
|
20862
|
+
/** @description Returns a Job Descriptor. */
|
|
20863
|
+
202: {
|
|
20864
|
+
headers: {
|
|
20865
|
+
[name: string]: unknown;
|
|
20866
|
+
};
|
|
20867
|
+
content: {
|
|
20868
|
+
"application/json": {
|
|
20869
|
+
data: components["schemas"]["JobDescriptor"];
|
|
20870
|
+
};
|
|
20871
|
+
};
|
|
20872
|
+
};
|
|
20873
|
+
default: components["responses"]["DefaultError"];
|
|
20874
|
+
};
|
|
20875
|
+
};
|
|
20679
20876
|
getServers: {
|
|
20680
20877
|
parameters: {
|
|
20681
20878
|
query?: {
|
|
@@ -22219,6 +22416,9 @@ export interface operations {
|
|
|
22219
22416
|
* 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.
|
|
22220
22417
|
* */
|
|
22221
22418
|
filter?: {
|
|
22419
|
+
/** @description `filter[environment]=ID` Filter networks based on linked environment. Submit the ID of the environment you wish to filter for.
|
|
22420
|
+
* */
|
|
22421
|
+
environment?: string;
|
|
22222
22422
|
/** @description `filter[search]=value` search for a value associated with a field on the given Network(s).
|
|
22223
22423
|
* */
|
|
22224
22424
|
search?: string;
|
|
@@ -22270,7 +22470,7 @@ export interface operations {
|
|
|
22270
22470
|
name: string;
|
|
22271
22471
|
/** @description A network identifier used to construct http calls that specifically use this network over another. */
|
|
22272
22472
|
identifier: string;
|
|
22273
|
-
|
|
22473
|
+
l2?: components["schemas"]["NetworkL2"] | null;
|
|
22274
22474
|
acl?: components["schemas"]["ACL"] | null;
|
|
22275
22475
|
/** @description The infrastructure cluster the environments belonging to this network belong to. */
|
|
22276
22476
|
cluster: string;
|
|
@@ -22370,10 +22570,10 @@ export interface operations {
|
|
|
22370
22570
|
"application/json": {
|
|
22371
22571
|
/** @description The name of the network. */
|
|
22372
22572
|
name?: string;
|
|
22373
|
-
|
|
22573
|
+
l2?: {
|
|
22374
22574
|
location_ids?: components["schemas"]["ID"][];
|
|
22375
22575
|
host_interface?: string | null;
|
|
22376
|
-
/** @description An array of defined
|
|
22576
|
+
/** @description An array of defined L2 routes */
|
|
22377
22577
|
routes?: {
|
|
22378
22578
|
usable?: components["schemas"]["Cidr"];
|
|
22379
22579
|
gateway?: components["schemas"]["IpAddress"];
|
|
@@ -22974,7 +23174,7 @@ export interface operations {
|
|
|
22974
23174
|
* In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
|
|
22975
23175
|
* In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
|
|
22976
23176
|
* */
|
|
22977
|
-
meta?: ("domains" | "ips" | "
|
|
23177
|
+
meta?: ("domains" | "ips" | "hypervisor_ips" | "server")[];
|
|
22978
23178
|
/** @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
|
|
22979
23179
|
* In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
|
|
22980
23180
|
* */
|
|
@@ -23106,7 +23306,7 @@ export interface operations {
|
|
|
23106
23306
|
* In the case of applying a meta to a collection of resources, each resource will have its own relevant meta data.
|
|
23107
23307
|
* In some rare cases, meta may not apply to individual resources, and may appear in the root document. These will be clearly labeled.
|
|
23108
23308
|
* */
|
|
23109
|
-
meta?: ("domains" | "ips" | "server" | "
|
|
23309
|
+
meta?: ("domains" | "ips" | "server" | "hypervisor_ips")[];
|
|
23110
23310
|
/** @description A comma-separated list of include values. Included resources will show up under the root document's `include` field.
|
|
23111
23311
|
* In the case of applying an include to a collection of resources, if multiple resources share the same include, it will only appear once in the return.
|
|
23112
23312
|
* */
|