@cycleplatform/api-client-typescript 0.1.5 → 0.1.7
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 +818 -216
package/src/generated/types.ts
CHANGED
|
@@ -81,6 +81,13 @@ export interface paths {
|
|
|
81
81
|
*/
|
|
82
82
|
post: operations["disableTwoFa"];
|
|
83
83
|
};
|
|
84
|
+
"/v1/account/2fa/recover": {
|
|
85
|
+
/**
|
|
86
|
+
* Disable TwoFa
|
|
87
|
+
* @description Disable TwoFa for an account
|
|
88
|
+
*/
|
|
89
|
+
post: operations["recoverTwoFa"];
|
|
90
|
+
};
|
|
84
91
|
"/v1/announcements": {
|
|
85
92
|
/**
|
|
86
93
|
* List Announcements
|
|
@@ -275,6 +282,28 @@ export interface paths {
|
|
|
275
282
|
*/
|
|
276
283
|
post: operations["reconfigureLoadBalancer"];
|
|
277
284
|
};
|
|
285
|
+
"/v1/environments/{environmentId}/services/lb/telemetry/report": {
|
|
286
|
+
/**
|
|
287
|
+
* Fetch load balancer v1 telemetry report
|
|
288
|
+
* @description ## Permissions
|
|
289
|
+
* Requires the `environments-view` capability. Also requires the user to have access specifically to the requested environment.
|
|
290
|
+
*
|
|
291
|
+
* ## Details
|
|
292
|
+
* Fetches a telemetry report for Cycle's native load balancer for the specified range.
|
|
293
|
+
*/
|
|
294
|
+
get: operations["getLoadBalancerTelemetryReport"];
|
|
295
|
+
};
|
|
296
|
+
"/v1/environments/{environmentId}/services/lb/telemetry/latest": {
|
|
297
|
+
/**
|
|
298
|
+
* Fetch the latest load balancer v1 telemetry.
|
|
299
|
+
* @description ## Permissions
|
|
300
|
+
* Requires the `environments-view` capability. Also requires the user to have access specifically to the requested environment.
|
|
301
|
+
*
|
|
302
|
+
* ## Details
|
|
303
|
+
* Fetches the latest telemetry report for Cycle's native load balancer. Provides detailed information on a per-instance basis.
|
|
304
|
+
*/
|
|
305
|
+
get: operations["getLoadBalancerLatestTelemetryReport"];
|
|
306
|
+
};
|
|
278
307
|
"/v1/environments/{environmentId}/services/discovery/tasks": {
|
|
279
308
|
/**
|
|
280
309
|
* Reconfigure Discovery
|
|
@@ -1096,29 +1125,29 @@ export interface paths {
|
|
|
1096
1125
|
};
|
|
1097
1126
|
"/v1/sdn/networks": {
|
|
1098
1127
|
/**
|
|
1099
|
-
* List
|
|
1128
|
+
* List SDN Network
|
|
1100
1129
|
* @description Requires the `sdn-networks-view` capability.
|
|
1101
1130
|
*/
|
|
1102
1131
|
get: operations["getNetworks"];
|
|
1103
1132
|
/**
|
|
1104
|
-
* Create SDN
|
|
1133
|
+
* Create SDN Network
|
|
1105
1134
|
* @description Requires the `sdn-networks-manage` capability.
|
|
1106
1135
|
*/
|
|
1107
1136
|
post: operations["createSDNNetwork"];
|
|
1108
1137
|
};
|
|
1109
1138
|
"/v1/sdn/networks/{networkId}": {
|
|
1110
1139
|
/**
|
|
1111
|
-
* Fetch SDN
|
|
1140
|
+
* Fetch SDN Network
|
|
1112
1141
|
* @description Requires the `sdn-networks-view` capability.
|
|
1113
1142
|
*/
|
|
1114
1143
|
get: operations["getNetwork"];
|
|
1115
1144
|
/**
|
|
1116
|
-
* Remove SDN
|
|
1145
|
+
* Remove SDN Network
|
|
1117
1146
|
* @description Requires the `sdn-networks-manage` capability.
|
|
1118
1147
|
*/
|
|
1119
1148
|
delete: operations["removeSDNNetwork"];
|
|
1120
1149
|
/**
|
|
1121
|
-
* Update SDN
|
|
1150
|
+
* Update SDN Network
|
|
1122
1151
|
* @description Requires the `sdn-networks-manage` capability.
|
|
1123
1152
|
*/
|
|
1124
1153
|
patch: operations["updateSDNNetwork"];
|
|
@@ -1130,6 +1159,35 @@ export interface paths {
|
|
|
1130
1159
|
*/
|
|
1131
1160
|
post: operations["createNetworkJob"];
|
|
1132
1161
|
};
|
|
1162
|
+
"/v1/sdn/global-lbs": {
|
|
1163
|
+
/**
|
|
1164
|
+
* List Global Load Balancers
|
|
1165
|
+
* @description Requires the `sdn-global-lbs-view` capability.
|
|
1166
|
+
*/
|
|
1167
|
+
get: operations["getGlobalLoadBalancers"];
|
|
1168
|
+
/**
|
|
1169
|
+
* Create Global Load Balancer
|
|
1170
|
+
* @description Requires the `sdn-global-lbs-manage` capability.
|
|
1171
|
+
*/
|
|
1172
|
+
post: operations["createGlobalLoadBalancer"];
|
|
1173
|
+
};
|
|
1174
|
+
"/v1/sdn/global-lbs/{lbId}": {
|
|
1175
|
+
/**
|
|
1176
|
+
* Fetch a Global Load Balancer
|
|
1177
|
+
* @description Requires the `sdn-global-lbs-view` capability.
|
|
1178
|
+
*/
|
|
1179
|
+
get: operations["getGlobalLoadBalancer"];
|
|
1180
|
+
/**
|
|
1181
|
+
* Remove Global Load Balancer
|
|
1182
|
+
* @description Requires the `sdn-global-lbs-manage` capability.
|
|
1183
|
+
*/
|
|
1184
|
+
delete: operations["removeGlobalLoadBalancer"];
|
|
1185
|
+
/**
|
|
1186
|
+
* Update Global Load Balancer
|
|
1187
|
+
* @description Requires the `sdn-global-lbs-manage` capability.
|
|
1188
|
+
*/
|
|
1189
|
+
patch: operations["updateGlobalLoadBalancer"];
|
|
1190
|
+
};
|
|
1133
1191
|
"/v1/pipelines": {
|
|
1134
1192
|
/**
|
|
1135
1193
|
* List Pipelines
|
|
@@ -1259,7 +1317,7 @@ export interface components {
|
|
|
1259
1317
|
ErrorEnvelope: {
|
|
1260
1318
|
error: components["schemas"]["Error"];
|
|
1261
1319
|
/** @description Data will always be `null` here. */
|
|
1262
|
-
data: Record<string,
|
|
1320
|
+
data: Record<string, unknown> | null;
|
|
1263
1321
|
};
|
|
1264
1322
|
/**
|
|
1265
1323
|
* ID
|
|
@@ -1388,7 +1446,7 @@ export interface components {
|
|
|
1388
1446
|
* @description A capability that a user or API key that represents what an API key or a user can do.
|
|
1389
1447
|
* @enum {string}
|
|
1390
1448
|
*/
|
|
1391
|
-
Capability: "hubs-update" | "hubs-delete" | "hubs-invites-send" | "hubs-invites-manage" | "hubs-members-manage" | "hubs-members-view" | "hubs-notifications-listen" | "hubs-integrations-manage" | "billing-methods-manage" | "billing-invoices-view" | "billing-invoices-pay" | "billing-orders-manage" | "billing-services-view" | "billing-credits-view" | "sdn-networks-view" | "sdn-networks-manage" | "pipelines-manage" | "pipelines-view" | "pipelines-trigger" | "environments-create" | "environments-delete" | "environments-view" | "environments-update" | "environments-state" | "environments-services-manage" | "environments-vpn" | "environments-vpn-manage" | "environments-scopedvariables-manage" | "environments-scopedvariables-view" | "containers-deploy" | "containers-view" | "containers-console" | "containers-ssh" | "containers-update" | "containers-delete" | "containers-state" | "containers-volumes-manage" | "containers-volumes-view" | "containers-instances-migrate" | "containers-backups-manage" | "containers-backups-view" | "stacks-manage" | "stacks-view" | "stacks-builds-manage" | "stacks-builds-deploy" | "images-view" | "images-import" | "images-update" | "images-delete" | "images-build" | "images-sources-view" | "images-sources-manage" | "jobs-view" | "api-keys-manage" | "ips-manage" | "servers-provision" | "servers-view" | "servers-update" | "servers-login" | "servers-state" | "servers-decommission" | "infrastructure-providers-manage" | "infrastructure-providers-view" | "
|
|
1449
|
+
Capability: "hubs-update" | "hubs-delete" | "hubs-invites-send" | "hubs-invites-manage" | "hubs-members-manage" | "hubs-members-view" | "hubs-notifications-listen" | "hubs-integrations-manage" | "hubs-usage-view" | "billing-methods-manage" | "billing-invoices-view" | "billing-invoices-pay" | "billing-orders-manage" | "billing-services-view" | "billing-credits-view" | "sdn-networks-view" | "sdn-networks-manage" | "sdn-global-lbs-manage" | "sdn-global-lbs-view" | "pipelines-manage" | "pipelines-view" | "pipelines-trigger" | "environments-create" | "environments-delete" | "environments-view" | "environments-update" | "environments-state" | "environments-services-manage" | "environments-vpn" | "environments-vpn-manage" | "environments-scopedvariables-manage" | "environments-scopedvariables-view" | "containers-deploy" | "containers-view" | "containers-console" | "containers-ssh" | "containers-update" | "containers-delete" | "containers-state" | "containers-volumes-manage" | "containers-volumes-view" | "containers-instances-migrate" | "containers-backups-manage" | "containers-backups-view" | "stacks-manage" | "stacks-view" | "stacks-builds-manage" | "stacks-builds-deploy" | "images-view" | "images-import" | "images-update" | "images-delete" | "images-build" | "images-sources-view" | "images-sources-manage" | "jobs-view" | "api-keys-manage" | "ips-manage" | "servers-provision" | "servers-view" | "servers-update" | "servers-login" | "servers-state" | "servers-decommission" | "infrastructure-providers-manage" | "infrastructure-providers-view" | "security-view" | "security-manage" | "monitor-view" | "monitor-manage" | "dns-view" | "dns-manage" | "dns-certs-view";
|
|
1392
1450
|
/**
|
|
1393
1451
|
* HubMembershipMeta
|
|
1394
1452
|
* @description A list of meta fields that can be applied to a membership.
|
|
@@ -1476,7 +1534,7 @@ export interface components {
|
|
|
1476
1534
|
};
|
|
1477
1535
|
/**
|
|
1478
1536
|
* Events
|
|
1479
|
-
* @description
|
|
1537
|
+
* @description Describes the date and time at which certain events occurred in the lifetime of this resource.
|
|
1480
1538
|
*/
|
|
1481
1539
|
Events: {
|
|
1482
1540
|
[key: string]: components["schemas"]["DateTime"] | undefined;
|
|
@@ -2462,7 +2520,7 @@ export interface components {
|
|
|
2462
2520
|
legacy_networking: boolean;
|
|
2463
2521
|
};
|
|
2464
2522
|
/** HAProxyConfig */
|
|
2465
|
-
|
|
2523
|
+
HaProxyConfigSet: {
|
|
2466
2524
|
/** @description Settings that describe how incoming traffic to the load balancer is handled. */
|
|
2467
2525
|
frontend: {
|
|
2468
2526
|
/**
|
|
@@ -2513,25 +2571,80 @@ export interface components {
|
|
|
2513
2571
|
}) | null;
|
|
2514
2572
|
};
|
|
2515
2573
|
};
|
|
2574
|
+
/** @description Describes settings that are passed to HAProxy within the load balancer. */
|
|
2575
|
+
HaProxyConfig: {
|
|
2576
|
+
/** @description Settings that are applied to any port that is not overridden in the following ports section. */
|
|
2577
|
+
default: components["schemas"]["HaProxyConfigSet"];
|
|
2578
|
+
/** @description An object that defines how HAProxy will act on a specific port. The key is a custom port, and the value is the same settings object found under `default` above. */
|
|
2579
|
+
ports: {
|
|
2580
|
+
[key: string]: components["schemas"]["HaProxyConfigSet"] | undefined;
|
|
2581
|
+
};
|
|
2582
|
+
};
|
|
2583
|
+
/** HaProxyLbType */
|
|
2584
|
+
HaProxyLbType: {
|
|
2585
|
+
/** @enum {string} */
|
|
2586
|
+
type: "haproxy";
|
|
2587
|
+
details: components["schemas"]["HaProxyConfig"] | null;
|
|
2588
|
+
};
|
|
2589
|
+
/** V1LbConfigRouter */
|
|
2590
|
+
V1LbConfigRouter: {
|
|
2591
|
+
identifier: string;
|
|
2592
|
+
/** @enum {string} */
|
|
2593
|
+
mode: "random" | "round-robin";
|
|
2594
|
+
config: {
|
|
2595
|
+
performance: boolean;
|
|
2596
|
+
sticky_sessions: boolean;
|
|
2597
|
+
destination_retries: number;
|
|
2598
|
+
transport: Record<string, never>;
|
|
2599
|
+
timeouts: {
|
|
2600
|
+
idle: number;
|
|
2601
|
+
};
|
|
2602
|
+
};
|
|
2603
|
+
};
|
|
2604
|
+
/** V1LbConfig */
|
|
2605
|
+
V1LbConfig: {
|
|
2606
|
+
controllers: {
|
|
2607
|
+
[key: string]: ({
|
|
2608
|
+
identifier: components["schemas"]["Identifier"];
|
|
2609
|
+
/** V1LbControllerTransport */
|
|
2610
|
+
transport: {
|
|
2611
|
+
/** @enum {string} */
|
|
2612
|
+
mode: "tcp" | "http";
|
|
2613
|
+
performance: boolean;
|
|
2614
|
+
ingress: {
|
|
2615
|
+
port: number;
|
|
2616
|
+
tls: boolean;
|
|
2617
|
+
};
|
|
2618
|
+
timeouts: {
|
|
2619
|
+
idle: number;
|
|
2620
|
+
};
|
|
2621
|
+
routers: (components["schemas"]["V1LbConfigRouter"])[];
|
|
2622
|
+
};
|
|
2623
|
+
}) | undefined;
|
|
2624
|
+
};
|
|
2625
|
+
};
|
|
2626
|
+
/** V1LbType */
|
|
2627
|
+
V1LbType: {
|
|
2628
|
+
/** @enum {string} */
|
|
2629
|
+
type: "v1";
|
|
2630
|
+
details: components["schemas"]["V1LbConfig"] | null;
|
|
2631
|
+
};
|
|
2632
|
+
/** DefaultLbType */
|
|
2633
|
+
DefaultLbType: {
|
|
2634
|
+
/** @enum {string} */
|
|
2635
|
+
type: "default";
|
|
2636
|
+
details: Record<string, unknown> | null;
|
|
2637
|
+
};
|
|
2516
2638
|
/**
|
|
2517
2639
|
* LoadBalancerConfig
|
|
2518
2640
|
* @description The config object for the loadbalancer service.
|
|
2519
2641
|
*/
|
|
2520
|
-
LoadBalancerConfig: {
|
|
2521
|
-
/** @
|
|
2522
|
-
|
|
2523
|
-
/** @description
|
|
2524
|
-
|
|
2525
|
-
|
|
2526
|
-
ports: {
|
|
2527
|
-
[key: string]: components["schemas"]["HaProxyConfig"] | undefined;
|
|
2528
|
-
};
|
|
2529
|
-
/** @description Allow / disallow traffic to be routed via IPv4. */
|
|
2530
|
-
ipv4?: boolean;
|
|
2531
|
-
/** @description Allow / disallow traffic to be routed via IPv6. */
|
|
2532
|
-
ipv6?: boolean;
|
|
2533
|
-
}) | null;
|
|
2534
|
-
};
|
|
2642
|
+
LoadBalancerConfig: ({
|
|
2643
|
+
/** @description Allow / disallow traffic to be routed via IPv4. */
|
|
2644
|
+
ipv4: boolean;
|
|
2645
|
+
/** @description Allow / disallow traffic to be routed via IPv6. */
|
|
2646
|
+
ipv6: boolean;
|
|
2647
|
+
} & (components["schemas"]["V1LbType"] | components["schemas"]["HaProxyLbType"] | components["schemas"]["DefaultLbType"])) | null;
|
|
2535
2648
|
/**
|
|
2536
2649
|
* LoadBalancerEnvironmentService
|
|
2537
2650
|
* @description Information about the environments loadbalancer service(s).
|
|
@@ -2543,13 +2656,13 @@ export interface components {
|
|
|
2543
2656
|
container_id: string | null;
|
|
2544
2657
|
/** @description A boolean representing if this service container is set to high availability mode or not. */
|
|
2545
2658
|
high_availability: boolean;
|
|
2546
|
-
config: components["schemas"]["LoadBalancerConfig"]
|
|
2659
|
+
config: components["schemas"]["LoadBalancerConfig"];
|
|
2547
2660
|
}) | null;
|
|
2548
2661
|
/**
|
|
2549
2662
|
* DiscoveryEnvironmentService
|
|
2550
2663
|
* @description Information about the environments discovery service(s).
|
|
2551
2664
|
*/
|
|
2552
|
-
DiscoveryEnvironmentService: {
|
|
2665
|
+
DiscoveryEnvironmentService: ({
|
|
2553
2666
|
/** @description Whether or not the discovery service is enabled. */
|
|
2554
2667
|
enable: boolean;
|
|
2555
2668
|
/** @description The ID of the discovery service container */
|
|
@@ -2557,8 +2670,8 @@ export interface components {
|
|
|
2557
2670
|
/** @description A boolean representing if this service container is set to high availability mode or not. */
|
|
2558
2671
|
high_availability: boolean;
|
|
2559
2672
|
/** @description The config object for the discovery service. */
|
|
2560
|
-
config: Record<string,
|
|
2561
|
-
} | null;
|
|
2673
|
+
config: Record<string, unknown> | null;
|
|
2674
|
+
}) | null;
|
|
2562
2675
|
/**
|
|
2563
2676
|
* VpnEnvironmentService
|
|
2564
2677
|
* @description Information about the environments vpn service(s).
|
|
@@ -2691,7 +2804,7 @@ export interface components {
|
|
|
2691
2804
|
container_subnet: string;
|
|
2692
2805
|
ipv6: components["schemas"]["IPNet"];
|
|
2693
2806
|
legacy: components["schemas"]["LegacyNetwork"];
|
|
2694
|
-
};
|
|
2807
|
+
} | null;
|
|
2695
2808
|
/**
|
|
2696
2809
|
* ContainerSummary
|
|
2697
2810
|
* @description Contains useful and relevant data/statistics for a container that would otherwise be several separate API calls.
|
|
@@ -2862,6 +2975,113 @@ export interface components {
|
|
|
2862
2975
|
instances: components["schemas"]["StateCountSummary"];
|
|
2863
2976
|
};
|
|
2864
2977
|
};
|
|
2978
|
+
/**
|
|
2979
|
+
* Range
|
|
2980
|
+
* @description A start and end date-time pair indicating a range of time
|
|
2981
|
+
*/
|
|
2982
|
+
Range: {
|
|
2983
|
+
start: components["schemas"]["DateTime"];
|
|
2984
|
+
end: components["schemas"]["DateTime"];
|
|
2985
|
+
};
|
|
2986
|
+
/** LoadBalancerTelemetryControllerMetrics */
|
|
2987
|
+
LoadBalancerTelemetryControllerMetrics: {
|
|
2988
|
+
/** LoadBalancerTelemetryControllerDisconnectsMetrics */
|
|
2989
|
+
disconnects: {
|
|
2990
|
+
no_error: number;
|
|
2991
|
+
request_invalid: number;
|
|
2992
|
+
timeout_idle: number;
|
|
2993
|
+
router_none: number;
|
|
2994
|
+
router_nomatch: number;
|
|
2995
|
+
destination_unavailable: number;
|
|
2996
|
+
unknown_error: number;
|
|
2997
|
+
};
|
|
2998
|
+
connections: number;
|
|
2999
|
+
requests: number;
|
|
3000
|
+
bytes_transmitted: number;
|
|
3001
|
+
bytes_received: number;
|
|
3002
|
+
};
|
|
3003
|
+
/**
|
|
3004
|
+
* LoadBalancerTelemetryReport
|
|
3005
|
+
* @description Aggregated load balancer telemetry across all instances for a given range.
|
|
3006
|
+
*/
|
|
3007
|
+
LoadBalancerTelemetryReport: {
|
|
3008
|
+
created: components["schemas"]["DateTime"];
|
|
3009
|
+
range: components["schemas"]["Range"];
|
|
3010
|
+
snapshots: ({
|
|
3011
|
+
time: components["schemas"]["DateTime"];
|
|
3012
|
+
controller: components["schemas"]["Identifier"];
|
|
3013
|
+
metrics: components["schemas"]["LoadBalancerTelemetryControllerMetrics"];
|
|
3014
|
+
})[] | null;
|
|
3015
|
+
};
|
|
3016
|
+
/** LoadBalancerTelemetryRouterMetrics */
|
|
3017
|
+
LoadBalancerTelemetryRouterMetrics: {
|
|
3018
|
+
destinations: {
|
|
3019
|
+
[key: string]: ({
|
|
3020
|
+
connections: ({
|
|
3021
|
+
sucess?: number;
|
|
3022
|
+
unavailable: number;
|
|
3023
|
+
errors?: {
|
|
3024
|
+
[key: string]: number | undefined;
|
|
3025
|
+
};
|
|
3026
|
+
}) | null;
|
|
3027
|
+
requests: ({
|
|
3028
|
+
total: number;
|
|
3029
|
+
responses?: {
|
|
3030
|
+
[key: string]: number | undefined;
|
|
3031
|
+
};
|
|
3032
|
+
errors?: {
|
|
3033
|
+
[key: string]: number | undefined;
|
|
3034
|
+
};
|
|
3035
|
+
}) | null;
|
|
3036
|
+
latency?: (number)[];
|
|
3037
|
+
}) | undefined;
|
|
3038
|
+
};
|
|
3039
|
+
};
|
|
3040
|
+
/** LoadBalancerTelemetryUrlMetrics */
|
|
3041
|
+
LoadBalancerTelemetryUrlMetrics: {
|
|
3042
|
+
destinations: {
|
|
3043
|
+
[key: string]: ({
|
|
3044
|
+
requests: ({
|
|
3045
|
+
total: number;
|
|
3046
|
+
responses?: {
|
|
3047
|
+
[key: string]: number | undefined;
|
|
3048
|
+
};
|
|
3049
|
+
errors?: {
|
|
3050
|
+
[key: string]: number | undefined;
|
|
3051
|
+
};
|
|
3052
|
+
}) | null;
|
|
3053
|
+
}) | undefined;
|
|
3054
|
+
};
|
|
3055
|
+
};
|
|
3056
|
+
/** LoadBalancerTelemetrySnapshot */
|
|
3057
|
+
LoadBalancerTelemetrySnapshot: {
|
|
3058
|
+
time: components["schemas"]["DateTime"];
|
|
3059
|
+
dataset_id: number;
|
|
3060
|
+
router?: components["schemas"]["LoadBalancerTelemetryRouterMetrics"];
|
|
3061
|
+
urls?: components["schemas"]["LoadBalancerTelemetryUrlMetrics"];
|
|
3062
|
+
metrics: components["schemas"]["LoadBalancerTelemetryControllerMetrics"];
|
|
3063
|
+
};
|
|
3064
|
+
/**
|
|
3065
|
+
* LoadBalancerLatestTelemetry
|
|
3066
|
+
* @description Snapshots of the latest load balancer telemetry
|
|
3067
|
+
*/
|
|
3068
|
+
LoadBalancerLatestTelemetry: ({
|
|
3069
|
+
time: components["schemas"]["DateTime"];
|
|
3070
|
+
controller: components["schemas"]["Identifier"];
|
|
3071
|
+
instances: ({
|
|
3072
|
+
id: components["schemas"]["ID"];
|
|
3073
|
+
hub_id: components["schemas"]["HubID"];
|
|
3074
|
+
environment_id: components["schemas"]["ID"];
|
|
3075
|
+
container_id: components["schemas"]["ID"];
|
|
3076
|
+
instance_id: components["schemas"]["ID"];
|
|
3077
|
+
server_id: components["schemas"]["ID"];
|
|
3078
|
+
cluster: components["schemas"]["Identifier"];
|
|
3079
|
+
time: components["schemas"]["DateTime"];
|
|
3080
|
+
controller: components["schemas"]["Identifier"];
|
|
3081
|
+
latest?: components["schemas"]["LoadBalancerTelemetrySnapshot"] | null;
|
|
3082
|
+
snapshots?: (components["schemas"]["LoadBalancerTelemetrySnapshot"])[];
|
|
3083
|
+
})[];
|
|
3084
|
+
})[];
|
|
2865
3085
|
/**
|
|
2866
3086
|
* VPNInfo
|
|
2867
3087
|
* @description A summary of a VPN service for a given environment.
|
|
@@ -3032,12 +3252,16 @@ export interface components {
|
|
|
3032
3252
|
* @description A summary of the image this container was created from.
|
|
3033
3253
|
*/
|
|
3034
3254
|
ImageSummary: {
|
|
3035
|
-
id
|
|
3255
|
+
id: string | null;
|
|
3256
|
+
/** @description An image that is packaged with Cycle directly, such as the global load balancer. */
|
|
3257
|
+
extension: {
|
|
3258
|
+
identifier: components["schemas"]["Identifier"];
|
|
3259
|
+
} | null;
|
|
3036
3260
|
/**
|
|
3037
3261
|
* @description If a service container, the identifier specifying which service it is.
|
|
3038
3262
|
* @enum {string|null}
|
|
3039
3263
|
*/
|
|
3040
|
-
service
|
|
3264
|
+
service: "loadbalancer" | "discovery" | "vpn" | null;
|
|
3041
3265
|
};
|
|
3042
3266
|
/**
|
|
3043
3267
|
* ContainerStackSummary
|
|
@@ -3074,6 +3298,12 @@ export interface components {
|
|
|
3074
3298
|
* @enum {string}
|
|
3075
3299
|
*/
|
|
3076
3300
|
DeploymentStrategyName: "resource-density" | "high-availability" | "first-available" | "node" | "edge" | "manual";
|
|
3301
|
+
/**
|
|
3302
|
+
* Duration
|
|
3303
|
+
* @description A string signifying a duration of time. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
|
|
3304
|
+
* @example 72h45m2s
|
|
3305
|
+
*/
|
|
3306
|
+
Duration: string;
|
|
3077
3307
|
/**
|
|
3078
3308
|
* ContainerDeploy
|
|
3079
3309
|
* @description Deployment configuration for the given container.
|
|
@@ -3104,15 +3334,15 @@ export interface components {
|
|
|
3104
3334
|
};
|
|
3105
3335
|
/** @description Configuration for what to do during container shutdown. */
|
|
3106
3336
|
shutdown?: {
|
|
3107
|
-
/** @description
|
|
3108
|
-
graceful_timeout:
|
|
3337
|
+
/** @description How long the platform will wait for a container to stop gracefully. */
|
|
3338
|
+
graceful_timeout: components["schemas"]["Duration"];
|
|
3109
3339
|
/** @description Process signal sent to the container process. */
|
|
3110
3340
|
signals: ("SIGTERM" | "SIGINT" | "SIGUSR1" | "SIGUSR2" | "SIGHUP" | "SIGQUIT")[];
|
|
3111
3341
|
};
|
|
3112
3342
|
/** @description Configurations for container startup. */
|
|
3113
3343
|
startup?: {
|
|
3114
|
-
/** @description
|
|
3115
|
-
delay?:
|
|
3344
|
+
/** @description How long the platform will wait before sending the start signal to the given container. */
|
|
3345
|
+
delay?: components["schemas"]["Duration"];
|
|
3116
3346
|
};
|
|
3117
3347
|
/** @description Configurations for container restart events. */
|
|
3118
3348
|
restart?: {
|
|
@@ -3121,8 +3351,8 @@ export interface components {
|
|
|
3121
3351
|
* @enum {string}
|
|
3122
3352
|
*/
|
|
3123
3353
|
condition: "always" | "never" | "failure";
|
|
3124
|
-
/** @description
|
|
3125
|
-
delay:
|
|
3354
|
+
/** @description How long the platform will wait before trying to restart the container. */
|
|
3355
|
+
delay: components["schemas"]["Duration"];
|
|
3126
3356
|
/** @description The amount of times the platform will attempt the restart policies. */
|
|
3127
3357
|
max_attempts: number;
|
|
3128
3358
|
};
|
|
@@ -3132,19 +3362,19 @@ export interface components {
|
|
|
3132
3362
|
command: string;
|
|
3133
3363
|
/** @description The number of times the platform will retry the command before marking the container unhealthy. */
|
|
3134
3364
|
retries: number;
|
|
3135
|
-
/** @description
|
|
3136
|
-
interval:
|
|
3137
|
-
/** @description
|
|
3138
|
-
timeout:
|
|
3365
|
+
/** @description How long to wait between restarts. */
|
|
3366
|
+
interval: components["schemas"]["Duration"];
|
|
3367
|
+
/** @description How long before a health check attempt times out. */
|
|
3368
|
+
timeout: components["schemas"]["Duration"];
|
|
3139
3369
|
/** @description A boolean where `true` represents the desire for a container to restart if unhealthy. */
|
|
3140
3370
|
restart: boolean;
|
|
3141
3371
|
};
|
|
3142
3372
|
/** @description Configuration settings for container telemetery reporting. */
|
|
3143
3373
|
telemetry?: {
|
|
3144
|
-
/** @description
|
|
3145
|
-
retention:
|
|
3146
|
-
/** @description The
|
|
3147
|
-
interval:
|
|
3374
|
+
/** @description How long telemetry data should be retained. */
|
|
3375
|
+
retention: components["schemas"]["Duration"];
|
|
3376
|
+
/** @description The duration between samples. */
|
|
3377
|
+
interval: components["schemas"]["Duration"];
|
|
3148
3378
|
/** @description A boolean where true disables all telemetry reporting for this container. */
|
|
3149
3379
|
disable: boolean;
|
|
3150
3380
|
/** @description An endpoint to report the telemetry data to. */
|
|
@@ -3298,8 +3528,8 @@ export interface components {
|
|
|
3298
3528
|
backup: {
|
|
3299
3529
|
/** @description The command to run for the backup. */
|
|
3300
3530
|
command: string;
|
|
3301
|
-
/** @description
|
|
3302
|
-
timeout?:
|
|
3531
|
+
/** @description How long the backup will attempt to run before timing out. */
|
|
3532
|
+
timeout?: string | null;
|
|
3303
3533
|
/** @description A cron string that configures how often the backup will run. */
|
|
3304
3534
|
cron_string?: string;
|
|
3305
3535
|
};
|
|
@@ -3307,14 +3537,14 @@ export interface components {
|
|
|
3307
3537
|
restore: ({
|
|
3308
3538
|
/** @description The command to run for restoring from a backup. */
|
|
3309
3539
|
command: string;
|
|
3310
|
-
/** @description The time in seconds for the restore to
|
|
3311
|
-
timeout?:
|
|
3540
|
+
/** @description The time in seconds for the restore to attempt to complete before timing out. */
|
|
3541
|
+
timeout?: string | null;
|
|
3312
3542
|
}) | null;
|
|
3313
3543
|
/**
|
|
3314
|
-
* @description How long
|
|
3315
|
-
* @default
|
|
3544
|
+
* @description How long the platform will keep backups. Default is 1 year.
|
|
3545
|
+
* @default 365d
|
|
3316
3546
|
*/
|
|
3317
|
-
retention:
|
|
3547
|
+
retention: string | null;
|
|
3318
3548
|
};
|
|
3319
3549
|
};
|
|
3320
3550
|
/**
|
|
@@ -3438,8 +3668,6 @@ export interface components {
|
|
|
3438
3668
|
};
|
|
3439
3669
|
/** @description A Linked record is a record special to Cycle. It represents a url that points to a specific container, however the IP address mapping in handled automatically by the platform. */
|
|
3440
3670
|
linked?: {
|
|
3441
|
-
/** @description The ID of the container this record is related to. */
|
|
3442
|
-
container_id?: string;
|
|
3443
3671
|
/** @description Features associated with this record. */
|
|
3444
3672
|
features: {
|
|
3445
3673
|
/** @description TLS properties of the record. */
|
|
@@ -3448,7 +3676,16 @@ export interface components {
|
|
|
3448
3676
|
enable: boolean;
|
|
3449
3677
|
};
|
|
3450
3678
|
};
|
|
3451
|
-
}
|
|
3679
|
+
} & OneOf<[{
|
|
3680
|
+
/** @description The ID of the container this record is related to. */
|
|
3681
|
+
container_id: string;
|
|
3682
|
+
}, {
|
|
3683
|
+
/** @description If pointed at a global load balancer, the information about which container behind that global lb this record points to. Must point to a container identifier, and that identifier must be the same in every environment referenced by the global lb. */
|
|
3684
|
+
global_lb: {
|
|
3685
|
+
id: components["schemas"]["ID"];
|
|
3686
|
+
container: components["schemas"]["Identifier"];
|
|
3687
|
+
};
|
|
3688
|
+
}]>;
|
|
3452
3689
|
};
|
|
3453
3690
|
/**
|
|
3454
3691
|
* DNSRecordCertificate
|
|
@@ -3562,9 +3799,9 @@ export interface components {
|
|
|
3562
3799
|
instances: number;
|
|
3563
3800
|
volumes?: (components["schemas"]["VolumeSummary"])[];
|
|
3564
3801
|
/** @description Custom meta data for a given container */
|
|
3565
|
-
annotations:
|
|
3566
|
-
[key: string]:
|
|
3567
|
-
}
|
|
3802
|
+
annotations: {
|
|
3803
|
+
[key: string]: unknown;
|
|
3804
|
+
} | null;
|
|
3568
3805
|
/**
|
|
3569
3806
|
* @description The role of a given container if it has one.
|
|
3570
3807
|
* @enum {string|null}
|
|
@@ -3593,6 +3830,14 @@ export interface components {
|
|
|
3593
3830
|
};
|
|
3594
3831
|
meta?: components["schemas"]["ContainersMeta"];
|
|
3595
3832
|
};
|
|
3833
|
+
/**
|
|
3834
|
+
* ExistingSource
|
|
3835
|
+
* @description In a stack, specifies an image source ID from which Cycle will derive any values not specified in the stack file. This is useful for avoiding direct placement of credentials in a stack file, for example.
|
|
3836
|
+
*/
|
|
3837
|
+
ExistingSource: {
|
|
3838
|
+
/** @description The ID of the image source this image should be built from. */
|
|
3839
|
+
source_id?: components["schemas"]["ID"];
|
|
3840
|
+
};
|
|
3596
3841
|
/**
|
|
3597
3842
|
* DockerHubOrigin
|
|
3598
3843
|
* @description An image origin where the image is pulled from DockerHub.
|
|
@@ -3601,6 +3846,7 @@ export interface components {
|
|
|
3601
3846
|
/** @enum {string} */
|
|
3602
3847
|
type?: "docker-hub";
|
|
3603
3848
|
details?: {
|
|
3849
|
+
existing?: components["schemas"]["ExistingSource"];
|
|
3604
3850
|
/** @description The DockerHub target string. ex - `mysql:5.7` */
|
|
3605
3851
|
target: string;
|
|
3606
3852
|
/** @description For authentication, a username. */
|
|
@@ -3677,6 +3923,7 @@ export interface components {
|
|
|
3677
3923
|
/** @enum {string} */
|
|
3678
3924
|
type?: "docker-file";
|
|
3679
3925
|
details?: {
|
|
3926
|
+
existing?: components["schemas"]["ExistingSource"];
|
|
3680
3927
|
repo?: components["schemas"]["RepoType"];
|
|
3681
3928
|
/** @description An endpoint that serves the tar file. */
|
|
3682
3929
|
targz_url?: string;
|
|
@@ -3695,6 +3942,7 @@ export interface components {
|
|
|
3695
3942
|
/** @enum {string} */
|
|
3696
3943
|
type?: "docker-registry";
|
|
3697
3944
|
details?: {
|
|
3945
|
+
existing?: components["schemas"]["ExistingSource"];
|
|
3698
3946
|
/** @description The image name on the registry. */
|
|
3699
3947
|
target: string;
|
|
3700
3948
|
/** @description The url of the remote registry. */
|
|
@@ -3770,7 +4018,20 @@ export interface components {
|
|
|
3770
4018
|
/** DirectImageSource */
|
|
3771
4019
|
DirectImageSourceType: {
|
|
3772
4020
|
/** @enum {string} */
|
|
3773
|
-
type?: "direct"
|
|
4021
|
+
type?: "direct";
|
|
4022
|
+
details?: {
|
|
4023
|
+
id: string;
|
|
4024
|
+
origin: components["schemas"]["ImageOrigin"];
|
|
4025
|
+
};
|
|
4026
|
+
override?: {
|
|
4027
|
+
target?: string;
|
|
4028
|
+
targz_url?: string;
|
|
4029
|
+
};
|
|
4030
|
+
};
|
|
4031
|
+
/** BucketImageSource */
|
|
4032
|
+
BucketImageSourceType: {
|
|
4033
|
+
/** @enum {string} */
|
|
4034
|
+
type?: "bucket";
|
|
3774
4035
|
details?: {
|
|
3775
4036
|
id: string;
|
|
3776
4037
|
origin: components["schemas"]["ImageOrigin"];
|
|
@@ -3871,7 +4132,7 @@ export interface components {
|
|
|
3871
4132
|
/** @description A set command to be run if a signal is called. */
|
|
3872
4133
|
signal_stop: string;
|
|
3873
4134
|
};
|
|
3874
|
-
source?: components["schemas"]["DirectImageSourceType"] | components["schemas"]["StackImageSourceType"];
|
|
4135
|
+
source?: components["schemas"]["DirectImageSourceType"] | components["schemas"]["StackImageSourceType"] | components["schemas"]["BucketImageSourceType"];
|
|
3875
4136
|
creator?: components["schemas"]["CreatorScope"];
|
|
3876
4137
|
/** @description Identifies which factory the image was built on and when. */
|
|
3877
4138
|
factory: {
|
|
@@ -4014,16 +4275,19 @@ export interface components {
|
|
|
4014
4275
|
containers?: (string)[];
|
|
4015
4276
|
};
|
|
4016
4277
|
shutdown?: {
|
|
4017
|
-
|
|
4278
|
+
/** @description How long the platform will wait for a container to stop gracefully. */
|
|
4279
|
+
graceful_timeout?: string | null;
|
|
4018
4280
|
signals?: (string)[];
|
|
4019
4281
|
};
|
|
4020
4282
|
startup?: {
|
|
4021
|
-
|
|
4283
|
+
/** @description How long the platform will wait before sending the start signal to the given container. */
|
|
4284
|
+
delay?: string | null;
|
|
4022
4285
|
};
|
|
4023
4286
|
restart?: {
|
|
4024
4287
|
/** @enum {string} */
|
|
4025
4288
|
condition: "always" | "never" | "failure";
|
|
4026
|
-
|
|
4289
|
+
/** @description How long the platform will wait before trying to restart the container. */
|
|
4290
|
+
delay: components["schemas"]["Duration"];
|
|
4027
4291
|
max_attempts: number;
|
|
4028
4292
|
notify?: {
|
|
4029
4293
|
emails?: (string)[];
|
|
@@ -4033,13 +4297,17 @@ export interface components {
|
|
|
4033
4297
|
health_check?: {
|
|
4034
4298
|
command: string;
|
|
4035
4299
|
retries: number;
|
|
4036
|
-
|
|
4037
|
-
|
|
4300
|
+
/** @description How long to wait between restarts. */
|
|
4301
|
+
interval: components["schemas"]["Duration"];
|
|
4302
|
+
/** @description How long before a health check attempt times out. */
|
|
4303
|
+
timeout: components["schemas"]["Duration"];
|
|
4038
4304
|
restart: boolean;
|
|
4039
4305
|
};
|
|
4040
4306
|
telemetry?: {
|
|
4041
|
-
|
|
4042
|
-
|
|
4307
|
+
/** @description How long telemetry data should be retained. */
|
|
4308
|
+
retention: components["schemas"]["Duration"];
|
|
4309
|
+
/** @description The duration between samples. */
|
|
4310
|
+
interval: components["schemas"]["Duration"];
|
|
4043
4311
|
disable: boolean;
|
|
4044
4312
|
};
|
|
4045
4313
|
};
|
|
@@ -4083,14 +4351,20 @@ export interface components {
|
|
|
4083
4351
|
destination: string;
|
|
4084
4352
|
backup: {
|
|
4085
4353
|
command: string;
|
|
4086
|
-
|
|
4354
|
+
/** @description How long the backup will attempt to run before timing out. */
|
|
4355
|
+
timeout: string | null;
|
|
4087
4356
|
cron_string: string | null;
|
|
4088
4357
|
};
|
|
4089
4358
|
restore: ({
|
|
4090
4359
|
command: string;
|
|
4091
|
-
|
|
4360
|
+
/** @description The time in seconds for the restore to attempt to complete before timing out. */
|
|
4361
|
+
timeout: string | null;
|
|
4092
4362
|
}) | null;
|
|
4093
|
-
|
|
4363
|
+
/**
|
|
4364
|
+
* @description How long the platform will keep backups. Default is 1 year.
|
|
4365
|
+
* @default 365d
|
|
4366
|
+
*/
|
|
4367
|
+
retention: string | null;
|
|
4094
4368
|
};
|
|
4095
4369
|
};
|
|
4096
4370
|
/**
|
|
@@ -4102,7 +4376,9 @@ export interface components {
|
|
|
4102
4376
|
name: string;
|
|
4103
4377
|
image: components["schemas"]["StackSpecContainerImage"];
|
|
4104
4378
|
/** @description Additional meta info about the container. */
|
|
4105
|
-
annotations:
|
|
4379
|
+
annotations: {
|
|
4380
|
+
[key: string]: unknown;
|
|
4381
|
+
};
|
|
4106
4382
|
stateful: boolean;
|
|
4107
4383
|
/** StackSpecContainerConfig */
|
|
4108
4384
|
config?: {
|
|
@@ -4138,6 +4414,16 @@ export interface components {
|
|
|
4138
4414
|
lock?: boolean;
|
|
4139
4415
|
}) | undefined;
|
|
4140
4416
|
};
|
|
4417
|
+
/**
|
|
4418
|
+
* StackSpecLoadBalancerConfig
|
|
4419
|
+
* @description The config object for the loadbalancer service.
|
|
4420
|
+
*/
|
|
4421
|
+
StackSpecLoadBalancerConfig: ({
|
|
4422
|
+
/** @description Allow / disallow traffic to be routed via IPv4. */
|
|
4423
|
+
ipv4: boolean | null;
|
|
4424
|
+
/** @description Allow / disallow traffic to be routed via IPv6. */
|
|
4425
|
+
ipv6: boolean | null;
|
|
4426
|
+
}) & (components["schemas"]["HaProxyLbType"] | components["schemas"]["V1LbType"] | components["schemas"]["DefaultLbType"]);
|
|
4141
4427
|
/** StackSpec */
|
|
4142
4428
|
StackSpec: {
|
|
4143
4429
|
/** @description A string defining the version of the stack spec. */
|
|
@@ -4153,26 +4439,7 @@ export interface components {
|
|
|
4153
4439
|
containers: components["schemas"]["StackContainer"];
|
|
4154
4440
|
/** StackSpecServices */
|
|
4155
4441
|
services?: {
|
|
4156
|
-
loadbalancer?:
|
|
4157
|
-
haproxy?: {
|
|
4158
|
-
haproxy?: ({
|
|
4159
|
-
default: components["schemas"]["HaProxyConfig"];
|
|
4160
|
-
ports: {
|
|
4161
|
-
[key: string]: components["schemas"]["HaProxyConfig"] | undefined;
|
|
4162
|
-
};
|
|
4163
|
-
}) | null;
|
|
4164
|
-
};
|
|
4165
|
-
ipv4?: boolean;
|
|
4166
|
-
ipv6?: boolean;
|
|
4167
|
-
egress_gateways?: {
|
|
4168
|
-
name: string;
|
|
4169
|
-
destinations: (string)[];
|
|
4170
|
-
ports: {
|
|
4171
|
-
internal: number;
|
|
4172
|
-
external: number;
|
|
4173
|
-
};
|
|
4174
|
-
};
|
|
4175
|
-
};
|
|
4442
|
+
loadbalancer?: components["schemas"]["StackSpecLoadBalancerConfig"];
|
|
4176
4443
|
vpn?: {
|
|
4177
4444
|
auth: {
|
|
4178
4445
|
webhook?: string;
|
|
@@ -4184,7 +4451,7 @@ export interface components {
|
|
|
4184
4451
|
};
|
|
4185
4452
|
/** @description Additional meta info about the stack. */
|
|
4186
4453
|
annotations?: {
|
|
4187
|
-
[key: string]:
|
|
4454
|
+
[key: string]: unknown;
|
|
4188
4455
|
};
|
|
4189
4456
|
};
|
|
4190
4457
|
/**
|
|
@@ -4733,7 +5000,7 @@ export interface components {
|
|
|
4733
5000
|
abbreviation: string;
|
|
4734
5001
|
/** @description Additional information about the given provider locaiton. */
|
|
4735
5002
|
annotations: {
|
|
4736
|
-
[key: string]:
|
|
5003
|
+
[key: string]: unknown;
|
|
4737
5004
|
};
|
|
4738
5005
|
};
|
|
4739
5006
|
/**
|
|
@@ -4931,11 +5198,8 @@ export interface components {
|
|
|
4931
5198
|
* @description A summary of the provider a given resource is deployed to.
|
|
4932
5199
|
*/
|
|
4933
5200
|
ProviderSummary: {
|
|
4934
|
-
/**
|
|
4935
|
-
|
|
4936
|
-
* @enum {string}
|
|
4937
|
-
*/
|
|
4938
|
-
identifier: "equinix-metal" | "vultr" | "aws" | "abstraction-<MongoID>";
|
|
5201
|
+
/** @description An identifier for the provider. Custom IAL providers will be listed as `a-<ID>`. */
|
|
5202
|
+
identifier: string;
|
|
4939
5203
|
/** @description A location identifier associated with the provider. */
|
|
4940
5204
|
location: string;
|
|
4941
5205
|
};
|
|
@@ -5811,7 +6075,7 @@ export interface components {
|
|
|
5811
6075
|
changes: (components["schemas"]["Change"])[];
|
|
5812
6076
|
/** @description A record of additional annotations for the activity. */
|
|
5813
6077
|
annotations: {
|
|
5814
|
-
[key: string]:
|
|
6078
|
+
[key: string]: unknown;
|
|
5815
6079
|
};
|
|
5816
6080
|
/** @description An object describing a given activity error. */
|
|
5817
6081
|
error: {
|
|
@@ -5837,7 +6101,7 @@ export interface components {
|
|
|
5837
6101
|
* @description The activity event.
|
|
5838
6102
|
* @enum {string}
|
|
5839
6103
|
*/
|
|
5840
|
-
event: "hub.images.prune" | "hub.update" | "hub.create" | "hub.task.delete" | "hub.task.images.prune" | "environment.services.discovery.reconfigure" | "environment.services.lb.reconfigure" | "environment.services.vpn.reconfigure" | "environment.delete" | "environment.initialize" | "environment.start" | "environment.stop" | "environment.create" | "environment.update" | "environment.task.delete" | "environment.services.discovery.task.reconfigure" | "environment.services.lb.task.reconfigure" | "environment.services.vpn.task.reconfigure" | "environment.vpn.user.create" | "environment.task.initialize" | "environment.task.start" | "environment.task.stop" | "environment.scoped-variable.delete" | "environment.scoped-variable.update" | "environment.scoped-variable.task.delete" | "environment.scoped-variable.create" | "image.delete" | "image.import" | "image.create" | "image.update" | "image.task.delete" | "image.task.import" | "image.source.delete" | "image.source.create" | "image.source.update" | "image.source.task.delete" | "billing.invoice.task.void" | "billing.invoice.task.credit" | "billing.invoice.task.refund" | "billing.invoice.pay" | "billing.invoice.task.pay" | "billing.order.confirm" | "billing.order.task.confirm" | "billing.method.update" | "billing.method.delete" | "billing.method.task.delete" | "billing.method.create" | "infrastructure.provider.update" | "infrastructure.provider.task.delete" | "infrastructure.provider.create" | "infrastructure.provider.task.verify" | "hub.apikey.update" | "hub.apikey.delete" | "hub.apikey.create" | "hub.membership.delete" | "hub.membership.create" | "hub.membership.update" | "container.initialize" | "container.task.start" | "container.start" | "container.task.stop" | "container.stop" | "container.task.reconfigure" | "container.reconfigure" | "container.task.reconfigure.volumes" | "container.reconfigure.volumes" | "container.create" | "container.restart" | "container.task.reimage" | "container.reimage" | "container.update" | "container.task.delete" | "container.delete" | "container.task.scale" | "container.scale" | "container.instances.create" | "container.instances.delete" | "container.instance.healthcheck.restarted" | "container.instance.error" | "container.instance.ssh.login" | "container.instance.migration.start" | "container.instance.migration.revert" | "container.instance.delete" | "container.instance.task.migrate_revert" | "container.instance.task.migrate" | "container.backup.create" | "container.backup.restore" | "container.backup.delete" | "container.backup.task.delete" | "container.backup.task.restore" | "dns.zone.verify" | "dns.zone.delete" | "dns.zone.task.verify" | "dns.zone.update" | "dns.zone.task.delete" | "dns.zone.create" | "dns.zone.record.delete" | "dns.zone.record.cert.generate" | "dns.zone.record.cert.generate.auto" | "dns.zone.record.task.cert.generate" | "dns.zone.record.update" | "dns.zone.record.task.delete" | "dns.zone.record.create" | "stack.update" | "stack.task.delete" | "stack.create" | "stack.task.prune" | "stack.build.create" | "stack.build.generate" | "stack.build.deploy" | "stack.build.delete" | "stack.build.task.delete" | "stack.build.task.generate" | "stack.build.task.deploy" | "infrastructure.server.task.delete" | "infrastructure.server.task.restart" | "infrastructure.server.services.sftp.auth" | "infrastructure.server.live" | "infrastructure.server.delete" | "infrastructure.server.restart" | "infrastructure.server.compute.restart" | "infrastructure.server.compute.spawner.restart" | "infrastructure.server.reconfigure.features" | "infrastructure.server.provision" | "infrastructure.server.console" | "infrastructure.server.update" | "infrastructure.server.task.provision" | "infrastructure.server.ssh.token" | "infrastructure.server.task.reconfigure.features" | "infrastructure.server.services.sftp.lockdown" | "infrastructure.server.services.internal-api.throttle" | "sdn.network.update" | "sdn.network.task.delete" | "sdn.network.create" | "sdn.network.task.reconfigure" | "pipeline.delete" | "pipeline.trigger" | "pipeline.update" | "pipeline.task.delete" | "pipeline.create" | "pipeline.task.trigger" | "pipeline.key.update" | "pipeline.key.delete" | "pipeline.key.create" | "infrastructure.ips.pool.task.delete";
|
|
6104
|
+
event: "hub.images.prune" | "hub.update" | "hub.create" | "hub.task.delete" | "hub.task.images.prune" | "environment.services.discovery.reconfigure" | "environment.services.lb.reconfigure" | "environment.services.vpn.reconfigure" | "environment.delete" | "environment.initialize" | "environment.start" | "environment.stop" | "environment.create" | "environment.update" | "environment.task.delete" | "environment.services.discovery.task.reconfigure" | "environment.services.lb.task.reconfigure" | "environment.services.vpn.task.reconfigure" | "environment.vpn.user.create" | "environment.services.vpn.login" | "environment.task.initialize" | "environment.task.start" | "environment.task.stop" | "environment.scoped-variable.delete" | "environment.scoped-variable.update" | "environment.scoped-variable.task.delete" | "environment.scoped-variable.create" | "image.delete" | "image.import" | "image.create" | "image.update" | "image.task.delete" | "image.task.import" | "image.source.delete" | "image.source.create" | "image.source.update" | "image.source.task.delete" | "billing.invoice.task.void" | "billing.invoice.task.credit" | "billing.invoice.task.refund" | "billing.invoice.pay" | "billing.invoice.task.pay" | "billing.order.confirm" | "billing.order.task.confirm" | "billing.method.update" | "billing.method.delete" | "billing.method.task.delete" | "billing.method.create" | "infrastructure.provider.update" | "infrastructure.provider.task.delete" | "infrastructure.provider.create" | "infrastructure.provider.task.verify" | "hub.apikey.update" | "hub.apikey.delete" | "hub.apikey.create" | "hub.membership.delete" | "hub.membership.create" | "hub.membership.update" | "container.initialize" | "container.task.start" | "container.start" | "container.task.stop" | "container.stop" | "container.task.reconfigure" | "container.reconfigure" | "container.task.reconfigure.volumes" | "container.reconfigure.volumes" | "container.create" | "container.restart" | "container.task.reimage" | "container.reimage" | "container.update" | "container.task.delete" | "container.delete" | "container.task.scale" | "container.scale" | "container.instances.create" | "container.instances.delete" | "container.instance.healthcheck.restarted" | "container.instance.error" | "container.instance.ssh.login" | "container.instance.migration.start" | "container.instance.migration.revert" | "container.instance.delete" | "container.instance.task.migrate_revert" | "container.instance.task.migrate" | "container.backup.create" | "container.backup.restore" | "container.backup.delete" | "container.backup.task.delete" | "container.backup.task.restore" | "dns.zone.verify" | "dns.zone.delete" | "dns.zone.task.verify" | "dns.zone.update" | "dns.zone.task.delete" | "dns.zone.create" | "dns.zone.record.delete" | "dns.zone.record.cert.generate" | "dns.zone.record.cert.generate.auto" | "dns.zone.record.task.cert.generate" | "dns.zone.record.update" | "dns.zone.record.task.delete" | "dns.zone.record.create" | "stack.update" | "stack.task.delete" | "stack.create" | "stack.task.prune" | "stack.build.create" | "stack.build.generate" | "stack.build.deploy" | "stack.build.delete" | "stack.build.task.delete" | "stack.build.task.generate" | "stack.build.task.deploy" | "infrastructure.server.task.delete" | "infrastructure.server.task.restart" | "infrastructure.server.services.sftp.auth" | "infrastructure.server.live" | "infrastructure.server.delete" | "infrastructure.server.restart" | "infrastructure.server.compute.restart" | "infrastructure.server.compute.spawner.restart" | "infrastructure.server.reconfigure.features" | "infrastructure.server.provision" | "infrastructure.server.console" | "infrastructure.server.update" | "infrastructure.server.task.provision" | "infrastructure.server.ssh.token" | "infrastructure.server.task.reconfigure.features" | "infrastructure.server.services.sftp.lockdown" | "infrastructure.server.services.internal-api.throttle" | "sdn.network.update" | "sdn.network.task.delete" | "sdn.network.create" | "sdn.network.task.reconfigure" | "pipeline.delete" | "pipeline.trigger" | "pipeline.update" | "pipeline.task.delete" | "pipeline.create" | "pipeline.task.trigger" | "pipeline.key.update" | "pipeline.key.delete" | "pipeline.key.create" | "infrastructure.ips.pool.task.delete";
|
|
5841
6105
|
/** @description A timestamp for when the activity took place. */
|
|
5842
6106
|
time: components["schemas"]["DateTime"];
|
|
5843
6107
|
};
|
|
@@ -6048,10 +6312,10 @@ export interface components {
|
|
|
6048
6312
|
current: "live" | "deleting" | "deleted";
|
|
6049
6313
|
}) & components["schemas"]["State"];
|
|
6050
6314
|
/**
|
|
6051
|
-
*
|
|
6315
|
+
* NetworkPrivacySettings
|
|
6052
6316
|
* @description Private network information for a Cycle SDN.
|
|
6053
6317
|
*/
|
|
6054
|
-
|
|
6318
|
+
NetworkPrivacySettings: {
|
|
6055
6319
|
/** @description A tag used to ensure proper routing. */
|
|
6056
6320
|
vxlan_tag: number;
|
|
6057
6321
|
/** @description The subnet of the private network. */
|
|
@@ -6067,10 +6331,10 @@ export interface components {
|
|
|
6067
6331
|
};
|
|
6068
6332
|
};
|
|
6069
6333
|
/**
|
|
6070
|
-
*
|
|
6334
|
+
* Network
|
|
6071
6335
|
* @description SDN Network resource.
|
|
6072
6336
|
*/
|
|
6073
|
-
|
|
6337
|
+
Network: {
|
|
6074
6338
|
id: components["schemas"]["ID"];
|
|
6075
6339
|
/** @description The name of the network. */
|
|
6076
6340
|
name: string;
|
|
@@ -6081,7 +6345,7 @@ export interface components {
|
|
|
6081
6345
|
creator: components["schemas"]["CreatorScope"];
|
|
6082
6346
|
hub_id: components["schemas"]["HubID"];
|
|
6083
6347
|
state: components["schemas"]["NetworkState"];
|
|
6084
|
-
private_network: components["schemas"]["
|
|
6348
|
+
private_network: components["schemas"]["NetworkPrivacySettings"];
|
|
6085
6349
|
/** @description An array of environments and timestamps. */
|
|
6086
6350
|
environments: ({
|
|
6087
6351
|
id: components["schemas"]["ID"];
|
|
@@ -6090,7 +6354,7 @@ export interface components {
|
|
|
6090
6354
|
})[];
|
|
6091
6355
|
/**
|
|
6092
6356
|
* NetworkEvents
|
|
6093
|
-
* @description A collection of timestamps for each event in the
|
|
6357
|
+
* @description A collection of timestamps for each event in the network's lifetime.
|
|
6094
6358
|
*/
|
|
6095
6359
|
events: {
|
|
6096
6360
|
/** @description The timestamp of when the image was created. */
|
|
@@ -6215,7 +6479,10 @@ export interface components {
|
|
|
6215
6479
|
environment: components["schemas"]["ResourceLocation"];
|
|
6216
6480
|
image: components["schemas"]["ResourceLocation"];
|
|
6217
6481
|
stateful: boolean;
|
|
6218
|
-
|
|
6482
|
+
/** @description Additional information about a container */
|
|
6483
|
+
annotations: {
|
|
6484
|
+
[key: string]: unknown;
|
|
6485
|
+
};
|
|
6219
6486
|
config: components["schemas"]["Config"];
|
|
6220
6487
|
volumes: (components["schemas"]["ContainerVolume"])[];
|
|
6221
6488
|
};
|
|
@@ -6507,8 +6774,8 @@ export interface components {
|
|
|
6507
6774
|
*/
|
|
6508
6775
|
action: "sleep";
|
|
6509
6776
|
details: {
|
|
6510
|
-
/** @description Total duration
|
|
6511
|
-
|
|
6777
|
+
/** @description Total duration to run this step for, before moving on to the next step. */
|
|
6778
|
+
duration?: components["schemas"]["Duration"];
|
|
6512
6779
|
};
|
|
6513
6780
|
};
|
|
6514
6781
|
/**
|
|
@@ -6557,7 +6824,7 @@ export interface components {
|
|
|
6557
6824
|
* @description The current state of the pipeline.
|
|
6558
6825
|
* @enum {string}
|
|
6559
6826
|
*/
|
|
6560
|
-
current: "live" | "deleting" | "deleted";
|
|
6827
|
+
current: "live" | "acquiring" | "deleting" | "deleted";
|
|
6561
6828
|
}) & components["schemas"]["State"];
|
|
6562
6829
|
/**
|
|
6563
6830
|
* Pipeline
|
|
@@ -6633,7 +6900,7 @@ export interface components {
|
|
|
6633
6900
|
* @description A resource thats assocaited with activity.
|
|
6634
6901
|
*/
|
|
6635
6902
|
ComponentsIncludes: {
|
|
6636
|
-
[key: string]: (components["schemas"]["Container"] | components["schemas"]["Instance"] | components["schemas"]["Environment"] | components["schemas"]["Image"] | components["schemas"]["ImageSource"] | components["schemas"]["Server"] | components["schemas"]["Pool"] | components["schemas"]["Provider"] | components["schemas"]["Stack"] | components["schemas"]["StackBuild"] | components["schemas"]["Zone"] | components["schemas"]["Record"] | components["schemas"]["ApiKey"] | components["schemas"]["
|
|
6903
|
+
[key: string]: (components["schemas"]["Container"] | components["schemas"]["Instance"] | components["schemas"]["Environment"] | components["schemas"]["Image"] | components["schemas"]["ImageSource"] | components["schemas"]["Server"] | components["schemas"]["Pool"] | components["schemas"]["Provider"] | components["schemas"]["Stack"] | components["schemas"]["StackBuild"] | components["schemas"]["Zone"] | components["schemas"]["Record"] | components["schemas"]["ApiKey"] | components["schemas"]["Network"] | components["schemas"]["HubMembership"] | components["schemas"]["Pipeline"] | components["schemas"]["TriggerKey"] | components["schemas"]["ScopedVariable"] | components["schemas"]["Hub"] | components["schemas"]["Invoice"] | components["schemas"]["Method"]) | undefined;
|
|
6637
6904
|
};
|
|
6638
6905
|
/**
|
|
6639
6906
|
* ActivityIncludes
|
|
@@ -6663,6 +6930,7 @@ export interface components {
|
|
|
6663
6930
|
id: string;
|
|
6664
6931
|
/** @description Name of the component */
|
|
6665
6932
|
name: string;
|
|
6933
|
+
identifier?: components["schemas"]["Identifier"];
|
|
6666
6934
|
/** @description State of the component */
|
|
6667
6935
|
state: string;
|
|
6668
6936
|
events: components["schemas"]["Events"];
|
|
@@ -6956,6 +7224,17 @@ export interface components {
|
|
|
6956
7224
|
*/
|
|
6957
7225
|
action: "compute.restart";
|
|
6958
7226
|
};
|
|
7227
|
+
/**
|
|
7228
|
+
* RestartComputeSpawner
|
|
7229
|
+
* @description A job that restarts compute service on a given server.
|
|
7230
|
+
*/
|
|
7231
|
+
RestartComputeSpawner: {
|
|
7232
|
+
/**
|
|
7233
|
+
* @description The action to take.
|
|
7234
|
+
* @enum {string}
|
|
7235
|
+
*/
|
|
7236
|
+
action: "compute.spawner.restart";
|
|
7237
|
+
};
|
|
6959
7238
|
/**
|
|
6960
7239
|
* ServerTags
|
|
6961
7240
|
* @description Tags for a given server.
|
|
@@ -7191,6 +7470,69 @@ export interface components {
|
|
|
7191
7470
|
creators?: components["schemas"]["CreatorInclude"];
|
|
7192
7471
|
environments?: components["schemas"]["EnvironmentIncludes"];
|
|
7193
7472
|
};
|
|
7473
|
+
/**
|
|
7474
|
+
* Creator
|
|
7475
|
+
* @description A creator object. Describes who created the resource.
|
|
7476
|
+
*/
|
|
7477
|
+
Creator: {
|
|
7478
|
+
id?: components["schemas"]["ID"];
|
|
7479
|
+
/**
|
|
7480
|
+
* @description The type of creator.
|
|
7481
|
+
* @enum {string}
|
|
7482
|
+
*/
|
|
7483
|
+
type?: "account" | "employee" | "api-key" | "visitor" | "environments" | "";
|
|
7484
|
+
};
|
|
7485
|
+
/** GlobalLoadBalancerState */
|
|
7486
|
+
GlobalLoadBalancerState: ({
|
|
7487
|
+
/**
|
|
7488
|
+
* @description The current state of the global load balancer.
|
|
7489
|
+
* @enum {string}
|
|
7490
|
+
*/
|
|
7491
|
+
current: "new" | "live" | "deleting" | "deleted";
|
|
7492
|
+
}) & components["schemas"]["State"];
|
|
7493
|
+
/**
|
|
7494
|
+
* GlobalLoadBalancer
|
|
7495
|
+
* @description A load balancer that sits outside of any environment and routes traffic between multiple environments. Global load balancers are used to manage rainbow/canary deployments and prevent downtime during an update.
|
|
7496
|
+
*/
|
|
7497
|
+
GlobalLoadBalancer: {
|
|
7498
|
+
id: components["schemas"]["ID"];
|
|
7499
|
+
/** @description A custom name given to this global load balancer */
|
|
7500
|
+
name: string;
|
|
7501
|
+
identifier: components["schemas"]["Identifier"];
|
|
7502
|
+
cluster: components["schemas"]["Identifier"];
|
|
7503
|
+
creator: components["schemas"]["Creator"];
|
|
7504
|
+
hub_id: components["schemas"]["ID"];
|
|
7505
|
+
state: components["schemas"]["GlobalLoadBalancerState"];
|
|
7506
|
+
/** @description An array where each item lists an environment ID and settings for the global load balancer to route traffic to them. */
|
|
7507
|
+
environments: ({
|
|
7508
|
+
id: components["schemas"]["ID"];
|
|
7509
|
+
/** GlobalLoadBalancerEnvironmentTraffic */
|
|
7510
|
+
traffic: {
|
|
7511
|
+
/** @description The percentage of all traffic the global load balancer should route to this environment. Must add up to 100% across all environments. */
|
|
7512
|
+
percentage: number;
|
|
7513
|
+
};
|
|
7514
|
+
})[] | null;
|
|
7515
|
+
/**
|
|
7516
|
+
* GlobalLoadBalancerEvents
|
|
7517
|
+
* @description Describes the date and time at which certain events occurred in the lifetime of this resource.
|
|
7518
|
+
*/
|
|
7519
|
+
events: {
|
|
7520
|
+
/** @description The timestamp of when the global lb was created. */
|
|
7521
|
+
created: components["schemas"]["DateTime"];
|
|
7522
|
+
/** @description The timestamp of when the global lb was updated. */
|
|
7523
|
+
updated: components["schemas"]["DateTime"];
|
|
7524
|
+
/** @description The timestamp of when the global lb was deleted. */
|
|
7525
|
+
deleted: components["schemas"]["DateTime"];
|
|
7526
|
+
};
|
|
7527
|
+
};
|
|
7528
|
+
/**
|
|
7529
|
+
* GlobalLoadBalancerIncludes
|
|
7530
|
+
* @description All includable resource linkable to the given global load balancer.
|
|
7531
|
+
*/
|
|
7532
|
+
GlobalLoadBalancerIncludes: {
|
|
7533
|
+
creators?: components["schemas"]["CreatorInclude"];
|
|
7534
|
+
environments?: components["schemas"]["EnvironmentIncludes"];
|
|
7535
|
+
};
|
|
7194
7536
|
/**
|
|
7195
7537
|
* PipelineIncludes
|
|
7196
7538
|
* @description All includable resources linkable to the given pipeline.
|
|
@@ -7268,14 +7610,6 @@ export interface components {
|
|
|
7268
7610
|
/** @description The protocol and url for connecting to the console. */
|
|
7269
7611
|
address: string;
|
|
7270
7612
|
};
|
|
7271
|
-
/**
|
|
7272
|
-
* Range
|
|
7273
|
-
* @description A start and end date-time pair indicating a range of time
|
|
7274
|
-
*/
|
|
7275
|
-
Range: {
|
|
7276
|
-
start: components["schemas"]["DateTime"];
|
|
7277
|
-
end: components["schemas"]["DateTime"];
|
|
7278
|
-
};
|
|
7279
7613
|
/**
|
|
7280
7614
|
* SecurityIncident
|
|
7281
7615
|
* @description Details about a security incident/event that occurred.
|
|
@@ -7440,8 +7774,8 @@ export interface operations {
|
|
|
7440
7774
|
name?: {
|
|
7441
7775
|
first?: string;
|
|
7442
7776
|
last?: string;
|
|
7443
|
-
allow_support_login?: boolean;
|
|
7444
7777
|
};
|
|
7778
|
+
allow_support_login?: boolean;
|
|
7445
7779
|
};
|
|
7446
7780
|
};
|
|
7447
7781
|
};
|
|
@@ -7463,7 +7797,7 @@ export interface operations {
|
|
|
7463
7797
|
*/
|
|
7464
7798
|
getAccountInvites: {
|
|
7465
7799
|
parameters: {
|
|
7466
|
-
query
|
|
7800
|
+
query?: {
|
|
7467
7801
|
/** @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. */
|
|
7468
7802
|
meta?: ("capabilities")[];
|
|
7469
7803
|
/** @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. */
|
|
@@ -7543,7 +7877,7 @@ export interface operations {
|
|
|
7543
7877
|
*/
|
|
7544
7878
|
getAccountLogins: {
|
|
7545
7879
|
parameters: {
|
|
7546
|
-
query
|
|
7880
|
+
query?: {
|
|
7547
7881
|
sort?: components["parameters"]["SortParam"];
|
|
7548
7882
|
filter?: components["parameters"]["FilterParam"];
|
|
7549
7883
|
page?: components["parameters"]["PageParam"];
|
|
@@ -7658,13 +7992,42 @@ export interface operations {
|
|
|
7658
7992
|
default: components["responses"]["DefaultError"];
|
|
7659
7993
|
};
|
|
7660
7994
|
};
|
|
7995
|
+
/**
|
|
7996
|
+
* Disable TwoFa
|
|
7997
|
+
* @description Disable TwoFa for an account
|
|
7998
|
+
*/
|
|
7999
|
+
recoverTwoFa: {
|
|
8000
|
+
/** @description Parameters setting up TwoFa */
|
|
8001
|
+
requestBody?: {
|
|
8002
|
+
content: {
|
|
8003
|
+
"application/json": {
|
|
8004
|
+
/** @description The user’s email */
|
|
8005
|
+
email: string;
|
|
8006
|
+
password: string;
|
|
8007
|
+
recovery_codes: (string)[];
|
|
8008
|
+
token?: string;
|
|
8009
|
+
};
|
|
8010
|
+
};
|
|
8011
|
+
};
|
|
8012
|
+
responses: {
|
|
8013
|
+
/** @description Returns a TwoFaDisableResponse resource. */
|
|
8014
|
+
200: {
|
|
8015
|
+
content: {
|
|
8016
|
+
"application/json": {
|
|
8017
|
+
data?: components["schemas"]["TwoFaDisableResponse"];
|
|
8018
|
+
};
|
|
8019
|
+
};
|
|
8020
|
+
};
|
|
8021
|
+
default: components["responses"]["DefaultError"];
|
|
8022
|
+
};
|
|
8023
|
+
};
|
|
7661
8024
|
/**
|
|
7662
8025
|
* List Announcements
|
|
7663
8026
|
* @description Lists any important updates posted by the Cycle team
|
|
7664
8027
|
*/
|
|
7665
8028
|
getAnnouncementsList: {
|
|
7666
8029
|
parameters: {
|
|
7667
|
-
query
|
|
8030
|
+
query?: {
|
|
7668
8031
|
sort?: components["parameters"]["SortParam"];
|
|
7669
8032
|
filter?: components["parameters"]["FilterParam"];
|
|
7670
8033
|
page?: components["parameters"]["PageParam"];
|
|
@@ -7688,7 +8051,7 @@ export interface operations {
|
|
|
7688
8051
|
*/
|
|
7689
8052
|
getOrders: {
|
|
7690
8053
|
parameters: {
|
|
7691
|
-
query
|
|
8054
|
+
query?: {
|
|
7692
8055
|
sort?: components["parameters"]["SortParam"];
|
|
7693
8056
|
filter?: components["parameters"]["FilterParam"];
|
|
7694
8057
|
page?: components["parameters"]["PageParam"];
|
|
@@ -7851,7 +8214,7 @@ export interface operations {
|
|
|
7851
8214
|
*/
|
|
7852
8215
|
getBillingSupportPlans: {
|
|
7853
8216
|
parameters: {
|
|
7854
|
-
query
|
|
8217
|
+
query?: {
|
|
7855
8218
|
sort?: components["parameters"]["SortParam"];
|
|
7856
8219
|
filter?: components["parameters"]["FilterParam"];
|
|
7857
8220
|
page?: components["parameters"]["PageParam"];
|
|
@@ -7892,7 +8255,7 @@ export interface operations {
|
|
|
7892
8255
|
*/
|
|
7893
8256
|
getBillingMethods: {
|
|
7894
8257
|
parameters: {
|
|
7895
|
-
query
|
|
8258
|
+
query?: {
|
|
7896
8259
|
sort?: components["parameters"]["SortParam"];
|
|
7897
8260
|
filter?: components["parameters"]["FilterParam"];
|
|
7898
8261
|
page?: components["parameters"]["PageParam"];
|
|
@@ -8036,7 +8399,7 @@ export interface operations {
|
|
|
8036
8399
|
*/
|
|
8037
8400
|
getInvoices: {
|
|
8038
8401
|
parameters: {
|
|
8039
|
-
query
|
|
8402
|
+
query?: {
|
|
8040
8403
|
sort?: components["parameters"]["SortParam"];
|
|
8041
8404
|
filter?: components["parameters"]["FilterParam"];
|
|
8042
8405
|
page?: components["parameters"]["PageParam"];
|
|
@@ -8120,7 +8483,7 @@ export interface operations {
|
|
|
8120
8483
|
*/
|
|
8121
8484
|
getBillingServices: {
|
|
8122
8485
|
parameters: {
|
|
8123
|
-
query
|
|
8486
|
+
query?: {
|
|
8124
8487
|
sort?: components["parameters"]["SortParam"];
|
|
8125
8488
|
filter?: components["parameters"]["FilterParam"];
|
|
8126
8489
|
page?: components["parameters"]["PageParam"];
|
|
@@ -8167,7 +8530,7 @@ export interface operations {
|
|
|
8167
8530
|
*/
|
|
8168
8531
|
getBillingOverages: {
|
|
8169
8532
|
parameters: {
|
|
8170
|
-
query
|
|
8533
|
+
query?: {
|
|
8171
8534
|
sort?: components["parameters"]["SortParam"];
|
|
8172
8535
|
filter?: components["parameters"]["FilterParam"];
|
|
8173
8536
|
page?: components["parameters"]["PageParam"];
|
|
@@ -8191,7 +8554,7 @@ export interface operations {
|
|
|
8191
8554
|
*/
|
|
8192
8555
|
getCredits: {
|
|
8193
8556
|
parameters: {
|
|
8194
|
-
query
|
|
8557
|
+
query?: {
|
|
8195
8558
|
sort?: components["parameters"]["SortParam"];
|
|
8196
8559
|
filter?: components["parameters"]["FilterParam"];
|
|
8197
8560
|
page?: components["parameters"]["PageParam"];
|
|
@@ -8238,7 +8601,7 @@ export interface operations {
|
|
|
8238
8601
|
*/
|
|
8239
8602
|
getEnvironments: {
|
|
8240
8603
|
parameters: {
|
|
8241
|
-
query
|
|
8604
|
+
query?: {
|
|
8242
8605
|
/** @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. */
|
|
8243
8606
|
meta?: ("containers" | "containers_count" | "instances_count")[];
|
|
8244
8607
|
/** @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. */
|
|
@@ -8321,7 +8684,7 @@ export interface operations {
|
|
|
8321
8684
|
*/
|
|
8322
8685
|
getEnvironmentById: {
|
|
8323
8686
|
parameters: {
|
|
8324
|
-
query
|
|
8687
|
+
query?: {
|
|
8325
8688
|
/** @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. */
|
|
8326
8689
|
meta?: ("containers" | "containers_count" | "instances_count")[];
|
|
8327
8690
|
/** @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. */
|
|
@@ -8479,6 +8842,12 @@ export interface operations {
|
|
|
8479
8842
|
/** @description Information about an environments load balancer configuration, state, and availability settings. */
|
|
8480
8843
|
data?: {
|
|
8481
8844
|
default_config: components["schemas"]["LoadBalancerConfig"];
|
|
8845
|
+
/** @enum {string} */
|
|
8846
|
+
default_type: "haproxy" | "v1";
|
|
8847
|
+
base_configs?: {
|
|
8848
|
+
haproxy: components["schemas"]["HaProxyConfig"];
|
|
8849
|
+
v1: components["schemas"]["V1LbConfig"];
|
|
8850
|
+
};
|
|
8482
8851
|
service: components["schemas"]["LoadBalancerEnvironmentService"];
|
|
8483
8852
|
};
|
|
8484
8853
|
};
|
|
@@ -8508,26 +8877,9 @@ export interface operations {
|
|
|
8508
8877
|
*/
|
|
8509
8878
|
action: "reconfigure";
|
|
8510
8879
|
contents: {
|
|
8511
|
-
/** @description Boolean that sets custom vs default VPN configuration */
|
|
8512
|
-
customize?: boolean;
|
|
8513
8880
|
/** @description A boolean where `true` represents the desire to run the environment load balancer service in high availability mode. */
|
|
8514
|
-
high_availability?: boolean;
|
|
8515
|
-
|
|
8516
|
-
config?: ({
|
|
8517
|
-
/** @enum {string} */
|
|
8518
|
-
version?: "v1" | "haproxy";
|
|
8519
|
-
/** @description Allow / disallow traffic to be routed via IPv4. */
|
|
8520
|
-
ipv4?: boolean | null;
|
|
8521
|
-
/** @description Allow / disallow traffic to be routed via IPv6. */
|
|
8522
|
-
ipv6?: boolean | null;
|
|
8523
|
-
/** @description Describes settings that are passed to HAProxy within the load balancer. */
|
|
8524
|
-
haproxy?: ({
|
|
8525
|
-
default: components["schemas"]["HaProxyConfig"];
|
|
8526
|
-
ports: {
|
|
8527
|
-
[key: string]: components["schemas"]["HaProxyConfig"] | undefined;
|
|
8528
|
-
};
|
|
8529
|
-
}) | null;
|
|
8530
|
-
}) | null;
|
|
8881
|
+
high_availability?: boolean | null;
|
|
8882
|
+
config?: components["schemas"]["LoadBalancerConfig"];
|
|
8531
8883
|
};
|
|
8532
8884
|
};
|
|
8533
8885
|
};
|
|
@@ -8544,6 +8896,72 @@ export interface operations {
|
|
|
8544
8896
|
default: components["responses"]["DefaultError"];
|
|
8545
8897
|
};
|
|
8546
8898
|
};
|
|
8899
|
+
/**
|
|
8900
|
+
* Fetch load balancer v1 telemetry report
|
|
8901
|
+
* @description ## Permissions
|
|
8902
|
+
* Requires the `environments-view` capability. Also requires the user to have access specifically to the requested environment.
|
|
8903
|
+
*
|
|
8904
|
+
* ## Details
|
|
8905
|
+
* Fetches a telemetry report for Cycle's native load balancer for the specified range.
|
|
8906
|
+
*/
|
|
8907
|
+
getLoadBalancerTelemetryReport: {
|
|
8908
|
+
parameters: {
|
|
8909
|
+
query?: {
|
|
8910
|
+
/**
|
|
8911
|
+
* @description ## Filter Field
|
|
8912
|
+
* 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.
|
|
8913
|
+
*/
|
|
8914
|
+
filter?: {
|
|
8915
|
+
/** @description The start date from when to pull load balancer telemetry data */
|
|
8916
|
+
"range-start"?: components["schemas"]["DateTime"];
|
|
8917
|
+
/** @description The end date from when to pull load balancer telemetry data */
|
|
8918
|
+
"range-end"?: components["schemas"]["DateTime"];
|
|
8919
|
+
};
|
|
8920
|
+
};
|
|
8921
|
+
path: {
|
|
8922
|
+
/** @description The environmentId where the load balancer resides. */
|
|
8923
|
+
environmentId: string;
|
|
8924
|
+
};
|
|
8925
|
+
};
|
|
8926
|
+
responses: {
|
|
8927
|
+
/** @description Returns the load balancer telemetry report */
|
|
8928
|
+
200: {
|
|
8929
|
+
content: {
|
|
8930
|
+
"application/json": {
|
|
8931
|
+
data?: components["schemas"]["LoadBalancerTelemetryReport"];
|
|
8932
|
+
};
|
|
8933
|
+
};
|
|
8934
|
+
};
|
|
8935
|
+
default: components["responses"]["DefaultError"];
|
|
8936
|
+
};
|
|
8937
|
+
};
|
|
8938
|
+
/**
|
|
8939
|
+
* Fetch the latest load balancer v1 telemetry.
|
|
8940
|
+
* @description ## Permissions
|
|
8941
|
+
* Requires the `environments-view` capability. Also requires the user to have access specifically to the requested environment.
|
|
8942
|
+
*
|
|
8943
|
+
* ## Details
|
|
8944
|
+
* Fetches the latest telemetry report for Cycle's native load balancer. Provides detailed information on a per-instance basis.
|
|
8945
|
+
*/
|
|
8946
|
+
getLoadBalancerLatestTelemetryReport: {
|
|
8947
|
+
parameters: {
|
|
8948
|
+
path: {
|
|
8949
|
+
/** @description The environmentId where the load balancer resides. */
|
|
8950
|
+
environmentId: string;
|
|
8951
|
+
};
|
|
8952
|
+
};
|
|
8953
|
+
responses: {
|
|
8954
|
+
/** @description Returns the latest load balancer telemetry */
|
|
8955
|
+
200: {
|
|
8956
|
+
content: {
|
|
8957
|
+
"application/json": {
|
|
8958
|
+
data?: components["schemas"]["LoadBalancerLatestTelemetry"];
|
|
8959
|
+
};
|
|
8960
|
+
};
|
|
8961
|
+
};
|
|
8962
|
+
default: components["responses"]["DefaultError"];
|
|
8963
|
+
};
|
|
8964
|
+
};
|
|
8547
8965
|
/**
|
|
8548
8966
|
* Reconfigure Discovery
|
|
8549
8967
|
* @description Creates a task that will update the discovery service's configuration.
|
|
@@ -8612,7 +9030,7 @@ export interface operations {
|
|
|
8612
9030
|
*/
|
|
8613
9031
|
getVpnLogins: {
|
|
8614
9032
|
parameters: {
|
|
8615
|
-
query
|
|
9033
|
+
query?: {
|
|
8616
9034
|
sort?: components["parameters"]["SortParam"];
|
|
8617
9035
|
page?: components["parameters"]["PageParam"];
|
|
8618
9036
|
};
|
|
@@ -8773,7 +9191,7 @@ export interface operations {
|
|
|
8773
9191
|
*/
|
|
8774
9192
|
getEnvironmentInstancesTelemetry: {
|
|
8775
9193
|
parameters: {
|
|
8776
|
-
query
|
|
9194
|
+
query?: {
|
|
8777
9195
|
/**
|
|
8778
9196
|
* @description ## Filter Field
|
|
8779
9197
|
* 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.
|
|
@@ -8808,7 +9226,7 @@ export interface operations {
|
|
|
8808
9226
|
*/
|
|
8809
9227
|
listScopedVariables: {
|
|
8810
9228
|
parameters: {
|
|
8811
|
-
query
|
|
9229
|
+
query?: {
|
|
8812
9230
|
/**
|
|
8813
9231
|
* @description ## Filter Field
|
|
8814
9232
|
* 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.
|
|
@@ -8983,7 +9401,7 @@ export interface operations {
|
|
|
8983
9401
|
*/
|
|
8984
9402
|
getContainers: {
|
|
8985
9403
|
parameters: {
|
|
8986
|
-
query
|
|
9404
|
+
query?: {
|
|
8987
9405
|
/** @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. */
|
|
8988
9406
|
meta?: ("instances_count" | "domain" | "domains" | "ips")[];
|
|
8989
9407
|
/** @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. */
|
|
@@ -9053,7 +9471,7 @@ export interface operations {
|
|
|
9053
9471
|
volumes?: (components["schemas"]["ContainerVolume"])[];
|
|
9054
9472
|
/** @description User defined meta data for the container. */
|
|
9055
9473
|
annotations?: {
|
|
9056
|
-
[key: string]:
|
|
9474
|
+
[key: string]: unknown;
|
|
9057
9475
|
};
|
|
9058
9476
|
};
|
|
9059
9477
|
};
|
|
@@ -9076,7 +9494,7 @@ export interface operations {
|
|
|
9076
9494
|
*/
|
|
9077
9495
|
getContainerById: {
|
|
9078
9496
|
parameters: {
|
|
9079
|
-
query
|
|
9497
|
+
query?: {
|
|
9080
9498
|
/** @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. */
|
|
9081
9499
|
meta?: ("instances_count" | "domain" | "domains" | "ips")[];
|
|
9082
9500
|
/** @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. */
|
|
@@ -9223,7 +9641,7 @@ export interface operations {
|
|
|
9223
9641
|
*/
|
|
9224
9642
|
getInstances: {
|
|
9225
9643
|
parameters: {
|
|
9226
|
-
query
|
|
9644
|
+
query?: {
|
|
9227
9645
|
/** @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. */
|
|
9228
9646
|
include?: ("creators" | "servers" | "locations" | "providers" | "containers" | "environments")[];
|
|
9229
9647
|
/**
|
|
@@ -9322,7 +9740,7 @@ export interface operations {
|
|
|
9322
9740
|
*/
|
|
9323
9741
|
getContainerInstance: {
|
|
9324
9742
|
parameters: {
|
|
9325
|
-
query
|
|
9743
|
+
query?: {
|
|
9326
9744
|
/** @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. */
|
|
9327
9745
|
include?: ("creators" | "servers" | "locations" | "providers" | "containers" | "environments")[];
|
|
9328
9746
|
};
|
|
@@ -9462,7 +9880,7 @@ export interface operations {
|
|
|
9462
9880
|
*/
|
|
9463
9881
|
getContainerInstanceVolumes: {
|
|
9464
9882
|
parameters: {
|
|
9465
|
-
query
|
|
9883
|
+
query?: {
|
|
9466
9884
|
sort?: components["parameters"]["SortParam"];
|
|
9467
9885
|
page?: components["parameters"]["PageParam"];
|
|
9468
9886
|
};
|
|
@@ -9491,7 +9909,7 @@ export interface operations {
|
|
|
9491
9909
|
*/
|
|
9492
9910
|
getInstanceResourcesTelemetryReport: {
|
|
9493
9911
|
parameters: {
|
|
9494
|
-
query
|
|
9912
|
+
query?: {
|
|
9495
9913
|
/**
|
|
9496
9914
|
* @description ## Filter Field
|
|
9497
9915
|
* 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.
|
|
@@ -9562,7 +9980,7 @@ export interface operations {
|
|
|
9562
9980
|
*/
|
|
9563
9981
|
ContainersListServers: {
|
|
9564
9982
|
parameters: {
|
|
9565
|
-
query
|
|
9983
|
+
query?: {
|
|
9566
9984
|
/** @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. */
|
|
9567
9985
|
meta?: ("primary_ip")[];
|
|
9568
9986
|
sort?: components["parameters"]["SortParam"];
|
|
@@ -9591,7 +10009,7 @@ export interface operations {
|
|
|
9591
10009
|
*/
|
|
9592
10010
|
getUsableServers: {
|
|
9593
10011
|
parameters: {
|
|
9594
|
-
query
|
|
10012
|
+
query?: {
|
|
9595
10013
|
/** @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. */
|
|
9596
10014
|
meta?: ("node" | "instances_count")[];
|
|
9597
10015
|
/** @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. */
|
|
@@ -9623,7 +10041,7 @@ export interface operations {
|
|
|
9623
10041
|
*/
|
|
9624
10042
|
getCompatibleImages: {
|
|
9625
10043
|
parameters: {
|
|
9626
|
-
query
|
|
10044
|
+
query?: {
|
|
9627
10045
|
sort?: components["parameters"]["SortParam"];
|
|
9628
10046
|
page?: components["parameters"]["PageParam"];
|
|
9629
10047
|
};
|
|
@@ -9650,7 +10068,7 @@ export interface operations {
|
|
|
9650
10068
|
*/
|
|
9651
10069
|
getBackupsCollection: {
|
|
9652
10070
|
parameters: {
|
|
9653
|
-
query
|
|
10071
|
+
query?: {
|
|
9654
10072
|
sort?: components["parameters"]["SortParam"];
|
|
9655
10073
|
page?: components["parameters"]["PageParam"];
|
|
9656
10074
|
};
|
|
@@ -9794,7 +10212,7 @@ export interface operations {
|
|
|
9794
10212
|
*/
|
|
9795
10213
|
getContainerInstancesTelemetry: {
|
|
9796
10214
|
parameters: {
|
|
9797
|
-
query
|
|
10215
|
+
query?: {
|
|
9798
10216
|
/**
|
|
9799
10217
|
* @description ## Filter Field
|
|
9800
10218
|
* 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.
|
|
@@ -9829,7 +10247,7 @@ export interface operations {
|
|
|
9829
10247
|
*/
|
|
9830
10248
|
getZonesCollection: {
|
|
9831
10249
|
parameters: {
|
|
9832
|
-
query
|
|
10250
|
+
query?: {
|
|
9833
10251
|
/** @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. */
|
|
9834
10252
|
include?: ("creators")[];
|
|
9835
10253
|
/**
|
|
@@ -9937,7 +10355,7 @@ export interface operations {
|
|
|
9937
10355
|
*/
|
|
9938
10356
|
updateDNSZone: {
|
|
9939
10357
|
parameters: {
|
|
9940
|
-
query
|
|
10358
|
+
query?: {
|
|
9941
10359
|
/** @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. */
|
|
9942
10360
|
include?: ("creators")[];
|
|
9943
10361
|
};
|
|
@@ -10009,7 +10427,7 @@ export interface operations {
|
|
|
10009
10427
|
*/
|
|
10010
10428
|
getRecordsCollection: {
|
|
10011
10429
|
parameters: {
|
|
10012
|
-
query
|
|
10430
|
+
query?: {
|
|
10013
10431
|
/** @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. */
|
|
10014
10432
|
include?: ("creators" | "containers")[];
|
|
10015
10433
|
/**
|
|
@@ -10175,7 +10593,7 @@ export interface operations {
|
|
|
10175
10593
|
*/
|
|
10176
10594
|
DNSTLSAttempts: {
|
|
10177
10595
|
parameters: {
|
|
10178
|
-
query
|
|
10596
|
+
query?: {
|
|
10179
10597
|
/**
|
|
10180
10598
|
* @description ## Filter Field
|
|
10181
10599
|
* 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.
|
|
@@ -10231,7 +10649,7 @@ export interface operations {
|
|
|
10231
10649
|
*/
|
|
10232
10650
|
getHubs: {
|
|
10233
10651
|
parameters: {
|
|
10234
|
-
query
|
|
10652
|
+
query?: {
|
|
10235
10653
|
page?: components["parameters"]["PageParam"];
|
|
10236
10654
|
/**
|
|
10237
10655
|
* @description ## Filter Field
|
|
@@ -10298,7 +10716,7 @@ export interface operations {
|
|
|
10298
10716
|
*/
|
|
10299
10717
|
getHub: {
|
|
10300
10718
|
parameters: {
|
|
10301
|
-
query
|
|
10719
|
+
query?: {
|
|
10302
10720
|
/** @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. */
|
|
10303
10721
|
meta?: ("memberships")[];
|
|
10304
10722
|
};
|
|
@@ -10370,7 +10788,7 @@ export interface operations {
|
|
|
10370
10788
|
*/
|
|
10371
10789
|
getHubActivity: {
|
|
10372
10790
|
parameters: {
|
|
10373
|
-
query
|
|
10791
|
+
query?: {
|
|
10374
10792
|
/** @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. */
|
|
10375
10793
|
include?: ("users" | "components" | "creators" | "images" | "stack_builds" | "stacks" | "environments")[];
|
|
10376
10794
|
/**
|
|
@@ -10442,7 +10860,7 @@ export interface operations {
|
|
|
10442
10860
|
*/
|
|
10443
10861
|
getHubUsage: {
|
|
10444
10862
|
parameters: {
|
|
10445
|
-
query
|
|
10863
|
+
query?: {
|
|
10446
10864
|
filter?: components["parameters"]["FilterParam"];
|
|
10447
10865
|
};
|
|
10448
10866
|
};
|
|
@@ -10487,7 +10905,7 @@ export interface operations {
|
|
|
10487
10905
|
*/
|
|
10488
10906
|
getHubInvites: {
|
|
10489
10907
|
parameters: {
|
|
10490
|
-
query
|
|
10908
|
+
query?: {
|
|
10491
10909
|
/** @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. */
|
|
10492
10910
|
meta?: ("capabilities")[];
|
|
10493
10911
|
/** @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. */
|
|
@@ -10559,7 +10977,7 @@ export interface operations {
|
|
|
10559
10977
|
*/
|
|
10560
10978
|
getHubMembers: {
|
|
10561
10979
|
parameters: {
|
|
10562
|
-
query
|
|
10980
|
+
query?: {
|
|
10563
10981
|
/** @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. */
|
|
10564
10982
|
meta?: ("capabilities")[];
|
|
10565
10983
|
/** @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. */
|
|
@@ -10588,7 +11006,7 @@ export interface operations {
|
|
|
10588
11006
|
*/
|
|
10589
11007
|
getHubMembership: {
|
|
10590
11008
|
parameters: {
|
|
10591
|
-
query
|
|
11009
|
+
query?: {
|
|
10592
11010
|
/** @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. */
|
|
10593
11011
|
meta?: ("capabilities")[];
|
|
10594
11012
|
/** @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. */
|
|
@@ -10617,7 +11035,7 @@ export interface operations {
|
|
|
10617
11035
|
*/
|
|
10618
11036
|
getHubMember: {
|
|
10619
11037
|
parameters: {
|
|
10620
|
-
query
|
|
11038
|
+
query?: {
|
|
10621
11039
|
/** @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. */
|
|
10622
11040
|
include?: ("senders" | "hubs" | "accounts")[];
|
|
10623
11041
|
};
|
|
@@ -10701,7 +11119,7 @@ export interface operations {
|
|
|
10701
11119
|
*/
|
|
10702
11120
|
getHubMembersAccount: {
|
|
10703
11121
|
parameters: {
|
|
10704
|
-
query
|
|
11122
|
+
query?: {
|
|
10705
11123
|
/** @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. */
|
|
10706
11124
|
meta?: ("capabilities")[];
|
|
10707
11125
|
/** @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. */
|
|
@@ -10731,7 +11149,7 @@ export interface operations {
|
|
|
10731
11149
|
*/
|
|
10732
11150
|
getApiKeys: {
|
|
10733
11151
|
parameters: {
|
|
10734
|
-
query
|
|
11152
|
+
query?: {
|
|
10735
11153
|
sort?: components["parameters"]["SortParam"];
|
|
10736
11154
|
filter?: components["parameters"]["FilterParam"];
|
|
10737
11155
|
page?: components["parameters"]["PageParam"];
|
|
@@ -10893,7 +11311,7 @@ export interface operations {
|
|
|
10893
11311
|
*/
|
|
10894
11312
|
getImages: {
|
|
10895
11313
|
parameters: {
|
|
10896
|
-
query
|
|
11314
|
+
query?: {
|
|
10897
11315
|
/** @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. */
|
|
10898
11316
|
meta?: ("containers_count")[];
|
|
10899
11317
|
/** @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. */
|
|
@@ -10979,7 +11397,7 @@ export interface operations {
|
|
|
10979
11397
|
*/
|
|
10980
11398
|
getImage: {
|
|
10981
11399
|
parameters: {
|
|
10982
|
-
query
|
|
11400
|
+
query?: {
|
|
10983
11401
|
/** @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. */
|
|
10984
11402
|
meta?: ("containers_count")[];
|
|
10985
11403
|
/** @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. */
|
|
@@ -11155,7 +11573,7 @@ export interface operations {
|
|
|
11155
11573
|
*/
|
|
11156
11574
|
getSourcesCollection: {
|
|
11157
11575
|
parameters: {
|
|
11158
|
-
query
|
|
11576
|
+
query?: {
|
|
11159
11577
|
/** @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. */
|
|
11160
11578
|
meta?: ("images_count")[];
|
|
11161
11579
|
/** @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. */
|
|
@@ -11229,7 +11647,7 @@ export interface operations {
|
|
|
11229
11647
|
*/
|
|
11230
11648
|
getSource: {
|
|
11231
11649
|
parameters: {
|
|
11232
|
-
query
|
|
11650
|
+
query?: {
|
|
11233
11651
|
/** @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. */
|
|
11234
11652
|
meta?: ("images_count")[];
|
|
11235
11653
|
/** @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. */
|
|
@@ -11320,7 +11738,7 @@ export interface operations {
|
|
|
11320
11738
|
*/
|
|
11321
11739
|
getInfrastructureSummary: {
|
|
11322
11740
|
parameters: {
|
|
11323
|
-
query
|
|
11741
|
+
query?: {
|
|
11324
11742
|
/**
|
|
11325
11743
|
* @description ## Filter Field
|
|
11326
11744
|
* 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.
|
|
@@ -11349,7 +11767,7 @@ export interface operations {
|
|
|
11349
11767
|
*/
|
|
11350
11768
|
getNativeProviders: {
|
|
11351
11769
|
parameters: {
|
|
11352
|
-
query
|
|
11770
|
+
query?: {
|
|
11353
11771
|
/** @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. */
|
|
11354
11772
|
meta?: ("locations")[];
|
|
11355
11773
|
/**
|
|
@@ -11382,7 +11800,7 @@ export interface operations {
|
|
|
11382
11800
|
*/
|
|
11383
11801
|
getProviderServers: {
|
|
11384
11802
|
parameters: {
|
|
11385
|
-
query
|
|
11803
|
+
query?: {
|
|
11386
11804
|
sort?: components["parameters"]["SortParam"];
|
|
11387
11805
|
page?: components["parameters"]["PageParam"];
|
|
11388
11806
|
};
|
|
@@ -11409,7 +11827,7 @@ export interface operations {
|
|
|
11409
11827
|
*/
|
|
11410
11828
|
getProviderLocations: {
|
|
11411
11829
|
parameters: {
|
|
11412
|
-
query
|
|
11830
|
+
query?: {
|
|
11413
11831
|
sort?: components["parameters"]["SortParam"];
|
|
11414
11832
|
page?: components["parameters"]["PageParam"];
|
|
11415
11833
|
};
|
|
@@ -11436,7 +11854,7 @@ export interface operations {
|
|
|
11436
11854
|
*/
|
|
11437
11855
|
getProviders: {
|
|
11438
11856
|
parameters: {
|
|
11439
|
-
query
|
|
11857
|
+
query?: {
|
|
11440
11858
|
/** @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. */
|
|
11441
11859
|
meta?: ("node" | "instances_count" | "locations")[];
|
|
11442
11860
|
/**
|
|
@@ -11640,7 +12058,7 @@ export interface operations {
|
|
|
11640
12058
|
*/
|
|
11641
12059
|
getServersCollection: {
|
|
11642
12060
|
parameters: {
|
|
11643
|
-
query
|
|
12061
|
+
query?: {
|
|
11644
12062
|
/** @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. */
|
|
11645
12063
|
meta?: ("node" | "instances_count")[];
|
|
11646
12064
|
/** @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. */
|
|
@@ -11728,7 +12146,7 @@ export interface operations {
|
|
|
11728
12146
|
*/
|
|
11729
12147
|
getSingleServer: {
|
|
11730
12148
|
parameters: {
|
|
11731
|
-
query
|
|
12149
|
+
query?: {
|
|
11732
12150
|
/** @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. */
|
|
11733
12151
|
include?: ("locations" | "models" | "providers")[];
|
|
11734
12152
|
/** @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. */
|
|
@@ -11758,7 +12176,7 @@ export interface operations {
|
|
|
11758
12176
|
*/
|
|
11759
12177
|
removeServer: {
|
|
11760
12178
|
parameters: {
|
|
11761
|
-
query
|
|
12179
|
+
query?: {
|
|
11762
12180
|
options?: components["parameters"]["OptionParam"];
|
|
11763
12181
|
};
|
|
11764
12182
|
path: {
|
|
@@ -11828,7 +12246,7 @@ export interface operations {
|
|
|
11828
12246
|
*/
|
|
11829
12247
|
getServerTelemetery: {
|
|
11830
12248
|
parameters: {
|
|
11831
|
-
query
|
|
12249
|
+
query?: {
|
|
11832
12250
|
/**
|
|
11833
12251
|
* @description ## Filter Field
|
|
11834
12252
|
* 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.
|
|
@@ -11865,7 +12283,7 @@ export interface operations {
|
|
|
11865
12283
|
*/
|
|
11866
12284
|
getServerInstances: {
|
|
11867
12285
|
parameters: {
|
|
11868
|
-
query
|
|
12286
|
+
query?: {
|
|
11869
12287
|
page?: components["parameters"]["PageParam"];
|
|
11870
12288
|
/** @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. */
|
|
11871
12289
|
include?: ("creator" | "servers" | "locations" | "providers" | "containers" | "environments")[];
|
|
@@ -11902,7 +12320,7 @@ export interface operations {
|
|
|
11902
12320
|
/** @description Parameters for creating the new server job. */
|
|
11903
12321
|
requestBody?: {
|
|
11904
12322
|
content: {
|
|
11905
|
-
"application/json": components["schemas"]["ReconfigureServer"] | components["schemas"]["RestartServer"] | components["schemas"]["RestartCompute"];
|
|
12323
|
+
"application/json": components["schemas"]["ReconfigureServer"] | components["schemas"]["RestartServer"] | components["schemas"]["RestartCompute"] | components["schemas"]["RestartComputeSpawner"];
|
|
11906
12324
|
};
|
|
11907
12325
|
};
|
|
11908
12326
|
responses: {
|
|
@@ -11923,7 +12341,7 @@ export interface operations {
|
|
|
11923
12341
|
*/
|
|
11924
12342
|
getServerTags: {
|
|
11925
12343
|
parameters: {
|
|
11926
|
-
query
|
|
12344
|
+
query?: {
|
|
11927
12345
|
/**
|
|
11928
12346
|
* @description ## Filter Field
|
|
11929
12347
|
* 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.
|
|
@@ -11990,7 +12408,7 @@ export interface operations {
|
|
|
11990
12408
|
*/
|
|
11991
12409
|
getInfrastructureIPPools: {
|
|
11992
12410
|
parameters: {
|
|
11993
|
-
query
|
|
12411
|
+
query?: {
|
|
11994
12412
|
/** @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. */
|
|
11995
12413
|
include?: ("creators" | "servers" | "providers" | "locations")[];
|
|
11996
12414
|
page?: components["parameters"]["PageParam"];
|
|
@@ -12014,7 +12432,7 @@ export interface operations {
|
|
|
12014
12432
|
*/
|
|
12015
12433
|
getInfrastructureIPPool: {
|
|
12016
12434
|
parameters: {
|
|
12017
|
-
query
|
|
12435
|
+
query?: {
|
|
12018
12436
|
/** @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. */
|
|
12019
12437
|
include?: ("creators" | "servers" | "providers" | "locations")[];
|
|
12020
12438
|
};
|
|
@@ -12112,7 +12530,7 @@ export interface operations {
|
|
|
12112
12530
|
*/
|
|
12113
12531
|
getJobs: {
|
|
12114
12532
|
parameters: {
|
|
12115
|
-
query
|
|
12533
|
+
query?: {
|
|
12116
12534
|
/** @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. */
|
|
12117
12535
|
include?: ("creators")[];
|
|
12118
12536
|
/**
|
|
@@ -12192,7 +12610,7 @@ export interface operations {
|
|
|
12192
12610
|
*/
|
|
12193
12611
|
getStacks: {
|
|
12194
12612
|
parameters: {
|
|
12195
|
-
query
|
|
12613
|
+
query?: {
|
|
12196
12614
|
/** @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. */
|
|
12197
12615
|
meta?: ("containers_count" | "builds_count")[];
|
|
12198
12616
|
/** @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. */
|
|
@@ -12397,7 +12815,7 @@ export interface operations {
|
|
|
12397
12815
|
*/
|
|
12398
12816
|
getStackBuilds: {
|
|
12399
12817
|
parameters: {
|
|
12400
|
-
query
|
|
12818
|
+
query?: {
|
|
12401
12819
|
/** @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. */
|
|
12402
12820
|
meta?: ("containers_count")[];
|
|
12403
12821
|
/** @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. */
|
|
@@ -12547,12 +12965,12 @@ export interface operations {
|
|
|
12547
12965
|
};
|
|
12548
12966
|
};
|
|
12549
12967
|
/**
|
|
12550
|
-
* List
|
|
12968
|
+
* List SDN Network
|
|
12551
12969
|
* @description Requires the `sdn-networks-view` capability.
|
|
12552
12970
|
*/
|
|
12553
12971
|
getNetworks: {
|
|
12554
12972
|
parameters: {
|
|
12555
|
-
query
|
|
12973
|
+
query?: {
|
|
12556
12974
|
/** @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. */
|
|
12557
12975
|
include?: ("creators" | "environments")[];
|
|
12558
12976
|
/**
|
|
@@ -12574,7 +12992,7 @@ export interface operations {
|
|
|
12574
12992
|
200: {
|
|
12575
12993
|
content: {
|
|
12576
12994
|
"application/json": {
|
|
12577
|
-
data?: (components["schemas"]["
|
|
12995
|
+
data?: (components["schemas"]["Network"])[];
|
|
12578
12996
|
includes?: components["schemas"]["NetworkIncludes"];
|
|
12579
12997
|
};
|
|
12580
12998
|
};
|
|
@@ -12583,10 +13001,16 @@ export interface operations {
|
|
|
12583
13001
|
};
|
|
12584
13002
|
};
|
|
12585
13003
|
/**
|
|
12586
|
-
* Create SDN
|
|
13004
|
+
* Create SDN Network
|
|
12587
13005
|
* @description Requires the `sdn-networks-manage` capability.
|
|
12588
13006
|
*/
|
|
12589
13007
|
createSDNNetwork: {
|
|
13008
|
+
parameters: {
|
|
13009
|
+
query?: {
|
|
13010
|
+
/** @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. */
|
|
13011
|
+
include?: ("creators" | "environments")[];
|
|
13012
|
+
};
|
|
13013
|
+
};
|
|
12590
13014
|
/** @description Parameters for creating a new network. */
|
|
12591
13015
|
requestBody?: {
|
|
12592
13016
|
content: {
|
|
@@ -12607,7 +13031,8 @@ export interface operations {
|
|
|
12607
13031
|
201: {
|
|
12608
13032
|
content: {
|
|
12609
13033
|
"application/json": {
|
|
12610
|
-
data?: components["schemas"]["
|
|
13034
|
+
data?: components["schemas"]["Network"];
|
|
13035
|
+
includes?: components["schemas"]["NetworkIncludes"];
|
|
12611
13036
|
};
|
|
12612
13037
|
};
|
|
12613
13038
|
};
|
|
@@ -12615,11 +13040,15 @@ export interface operations {
|
|
|
12615
13040
|
};
|
|
12616
13041
|
};
|
|
12617
13042
|
/**
|
|
12618
|
-
* Fetch SDN
|
|
13043
|
+
* Fetch SDN Network
|
|
12619
13044
|
* @description Requires the `sdn-networks-view` capability.
|
|
12620
13045
|
*/
|
|
12621
13046
|
getNetwork: {
|
|
12622
13047
|
parameters: {
|
|
13048
|
+
query?: {
|
|
13049
|
+
/** @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. */
|
|
13050
|
+
include?: ("creators" | "environments")[];
|
|
13051
|
+
};
|
|
12623
13052
|
path: {
|
|
12624
13053
|
/** @description The ID of the network. */
|
|
12625
13054
|
networkId: string;
|
|
@@ -12630,7 +13059,8 @@ export interface operations {
|
|
|
12630
13059
|
200: {
|
|
12631
13060
|
content: {
|
|
12632
13061
|
"application/json": {
|
|
12633
|
-
data?: components["schemas"]["
|
|
13062
|
+
data?: components["schemas"]["Network"];
|
|
13063
|
+
includes?: components["schemas"]["NetworkIncludes"];
|
|
12634
13064
|
};
|
|
12635
13065
|
};
|
|
12636
13066
|
};
|
|
@@ -12638,7 +13068,7 @@ export interface operations {
|
|
|
12638
13068
|
};
|
|
12639
13069
|
};
|
|
12640
13070
|
/**
|
|
12641
|
-
* Remove SDN
|
|
13071
|
+
* Remove SDN Network
|
|
12642
13072
|
* @description Requires the `sdn-networks-manage` capability.
|
|
12643
13073
|
*/
|
|
12644
13074
|
removeSDNNetwork: {
|
|
@@ -12661,11 +13091,15 @@ export interface operations {
|
|
|
12661
13091
|
};
|
|
12662
13092
|
};
|
|
12663
13093
|
/**
|
|
12664
|
-
* Update SDN
|
|
13094
|
+
* Update SDN Network
|
|
12665
13095
|
* @description Requires the `sdn-networks-manage` capability.
|
|
12666
13096
|
*/
|
|
12667
13097
|
updateSDNNetwork: {
|
|
12668
13098
|
parameters: {
|
|
13099
|
+
query?: {
|
|
13100
|
+
/** @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. */
|
|
13101
|
+
include?: ("creators" | "environments")[];
|
|
13102
|
+
};
|
|
12669
13103
|
path: {
|
|
12670
13104
|
/** @description The ID of the network. */
|
|
12671
13105
|
networkId: string;
|
|
@@ -12685,7 +13119,8 @@ export interface operations {
|
|
|
12685
13119
|
200: {
|
|
12686
13120
|
content: {
|
|
12687
13121
|
"application/json": {
|
|
12688
|
-
data?: components["schemas"]["
|
|
13122
|
+
data?: components["schemas"]["Network"];
|
|
13123
|
+
includes?: components["schemas"]["NetworkIncludes"];
|
|
12689
13124
|
};
|
|
12690
13125
|
};
|
|
12691
13126
|
};
|
|
@@ -12732,13 +13167,180 @@ export interface operations {
|
|
|
12732
13167
|
default: components["responses"]["DefaultError"];
|
|
12733
13168
|
};
|
|
12734
13169
|
};
|
|
13170
|
+
/**
|
|
13171
|
+
* List Global Load Balancers
|
|
13172
|
+
* @description Requires the `sdn-global-lbs-view` capability.
|
|
13173
|
+
*/
|
|
13174
|
+
getGlobalLoadBalancers: {
|
|
13175
|
+
parameters: {
|
|
13176
|
+
query?: {
|
|
13177
|
+
/** @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. */
|
|
13178
|
+
include?: ("creators" | "environments")[];
|
|
13179
|
+
/**
|
|
13180
|
+
* @description ## Filter Field
|
|
13181
|
+
* 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.
|
|
13182
|
+
*/
|
|
13183
|
+
filter?: {
|
|
13184
|
+
/** @description `filter[identifier]=value` only return global load balancers that match the identifier */
|
|
13185
|
+
identifier?: string;
|
|
13186
|
+
/** @description `filter[search]=value` search for a value associated with a field on the given global load balancer(s). */
|
|
13187
|
+
search?: string;
|
|
13188
|
+
/** @description `filter[state]=value1,value2` state filtering will allow you to filter by the global load balancer's current state. */
|
|
13189
|
+
state?: string;
|
|
13190
|
+
};
|
|
13191
|
+
sort?: components["parameters"]["SortParam"];
|
|
13192
|
+
page?: components["parameters"]["PageParam"];
|
|
13193
|
+
};
|
|
13194
|
+
};
|
|
13195
|
+
responses: {
|
|
13196
|
+
/** @description Returns a list of global load balancers associated with this hub. */
|
|
13197
|
+
200: {
|
|
13198
|
+
content: {
|
|
13199
|
+
"application/json": {
|
|
13200
|
+
data?: (components["schemas"]["GlobalLoadBalancer"])[];
|
|
13201
|
+
includes?: components["schemas"]["GlobalLoadBalancerIncludes"];
|
|
13202
|
+
};
|
|
13203
|
+
};
|
|
13204
|
+
};
|
|
13205
|
+
default: components["responses"]["DefaultError"];
|
|
13206
|
+
};
|
|
13207
|
+
};
|
|
13208
|
+
/**
|
|
13209
|
+
* Create Global Load Balancer
|
|
13210
|
+
* @description Requires the `sdn-global-lbs-manage` capability.
|
|
13211
|
+
*/
|
|
13212
|
+
createGlobalLoadBalancer: {
|
|
13213
|
+
parameters: {
|
|
13214
|
+
query?: {
|
|
13215
|
+
/** @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. */
|
|
13216
|
+
include?: ("creators" | "environments")[];
|
|
13217
|
+
};
|
|
13218
|
+
};
|
|
13219
|
+
/** @description Parameters for creating a new global load balancer. */
|
|
13220
|
+
requestBody?: {
|
|
13221
|
+
content: {
|
|
13222
|
+
"application/json": {
|
|
13223
|
+
/** @description The name of the global load balancer. */
|
|
13224
|
+
name: string;
|
|
13225
|
+
/** @description A human-readable identifier for referencing this global load balancer. Identifiers do not need to be unique. */
|
|
13226
|
+
identifier: string;
|
|
13227
|
+
/** @description The infrastructure cluster this global load balancer will be associated with. */
|
|
13228
|
+
cluster: string;
|
|
13229
|
+
/** @description An array of environment ids that this global load balancer will balance traffic across */
|
|
13230
|
+
environments: (string)[];
|
|
13231
|
+
};
|
|
13232
|
+
};
|
|
13233
|
+
};
|
|
13234
|
+
responses: {
|
|
13235
|
+
/** @description Returns a global load balancer resource. */
|
|
13236
|
+
201: {
|
|
13237
|
+
content: {
|
|
13238
|
+
"application/json": {
|
|
13239
|
+
data?: components["schemas"]["GlobalLoadBalancer"];
|
|
13240
|
+
includes?: components["schemas"]["GlobalLoadBalancerIncludes"];
|
|
13241
|
+
};
|
|
13242
|
+
};
|
|
13243
|
+
};
|
|
13244
|
+
default: components["responses"]["DefaultError"];
|
|
13245
|
+
};
|
|
13246
|
+
};
|
|
13247
|
+
/**
|
|
13248
|
+
* Fetch a Global Load Balancer
|
|
13249
|
+
* @description Requires the `sdn-global-lbs-view` capability.
|
|
13250
|
+
*/
|
|
13251
|
+
getGlobalLoadBalancer: {
|
|
13252
|
+
parameters: {
|
|
13253
|
+
query?: {
|
|
13254
|
+
/** @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. */
|
|
13255
|
+
include?: ("creators" | "environments")[];
|
|
13256
|
+
};
|
|
13257
|
+
path: {
|
|
13258
|
+
/** @description The ID of the global load balancer. */
|
|
13259
|
+
lbId: string;
|
|
13260
|
+
};
|
|
13261
|
+
};
|
|
13262
|
+
responses: {
|
|
13263
|
+
/** @description Returns a single global load balancer resource. */
|
|
13264
|
+
200: {
|
|
13265
|
+
content: {
|
|
13266
|
+
"application/json": {
|
|
13267
|
+
data?: components["schemas"]["GlobalLoadBalancer"];
|
|
13268
|
+
includes?: components["schemas"]["GlobalLoadBalancerIncludes"];
|
|
13269
|
+
};
|
|
13270
|
+
};
|
|
13271
|
+
};
|
|
13272
|
+
default: components["responses"]["DefaultError"];
|
|
13273
|
+
};
|
|
13274
|
+
};
|
|
13275
|
+
/**
|
|
13276
|
+
* Remove Global Load Balancer
|
|
13277
|
+
* @description Requires the `sdn-global-lbs-manage` capability.
|
|
13278
|
+
*/
|
|
13279
|
+
removeGlobalLoadBalancer: {
|
|
13280
|
+
parameters: {
|
|
13281
|
+
path: {
|
|
13282
|
+
/** @description The ID of the global load balancer. */
|
|
13283
|
+
lbId: string;
|
|
13284
|
+
};
|
|
13285
|
+
};
|
|
13286
|
+
responses: {
|
|
13287
|
+
/** @description Returns a task descriptor. */
|
|
13288
|
+
200: {
|
|
13289
|
+
content: {
|
|
13290
|
+
"application/json": {
|
|
13291
|
+
data?: components["schemas"]["TaskDescriptor"];
|
|
13292
|
+
};
|
|
13293
|
+
};
|
|
13294
|
+
};
|
|
13295
|
+
default: components["responses"]["DefaultError"];
|
|
13296
|
+
};
|
|
13297
|
+
};
|
|
13298
|
+
/**
|
|
13299
|
+
* Update Global Load Balancer
|
|
13300
|
+
* @description Requires the `sdn-global-lbs-manage` capability.
|
|
13301
|
+
*/
|
|
13302
|
+
updateGlobalLoadBalancer: {
|
|
13303
|
+
parameters: {
|
|
13304
|
+
query?: {
|
|
13305
|
+
/** @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. */
|
|
13306
|
+
include?: ("creators" | "environments")[];
|
|
13307
|
+
};
|
|
13308
|
+
path: {
|
|
13309
|
+
/** @description The ID of the global load balancer. */
|
|
13310
|
+
lbId: string;
|
|
13311
|
+
};
|
|
13312
|
+
};
|
|
13313
|
+
/** @description Parameters for updating a global load balancer. */
|
|
13314
|
+
requestBody?: {
|
|
13315
|
+
content: {
|
|
13316
|
+
"application/json": {
|
|
13317
|
+
/** @description A new name for this global load balancer. */
|
|
13318
|
+
name?: string;
|
|
13319
|
+
/** @description A new identifier for this global load balancer. */
|
|
13320
|
+
identifier?: string;
|
|
13321
|
+
};
|
|
13322
|
+
};
|
|
13323
|
+
};
|
|
13324
|
+
responses: {
|
|
13325
|
+
/** @description Returns a global load balancer resource. */
|
|
13326
|
+
200: {
|
|
13327
|
+
content: {
|
|
13328
|
+
"application/json": {
|
|
13329
|
+
data?: components["schemas"]["GlobalLoadBalancer"];
|
|
13330
|
+
includes?: components["schemas"]["GlobalLoadBalancerIncludes"];
|
|
13331
|
+
};
|
|
13332
|
+
};
|
|
13333
|
+
};
|
|
13334
|
+
default: components["responses"]["DefaultError"];
|
|
13335
|
+
};
|
|
13336
|
+
};
|
|
12735
13337
|
/**
|
|
12736
13338
|
* List Pipelines
|
|
12737
13339
|
* @description Requires the `pipelines-view` capability.
|
|
12738
13340
|
*/
|
|
12739
13341
|
getPipelines: {
|
|
12740
13342
|
parameters: {
|
|
12741
|
-
query
|
|
13343
|
+
query?: {
|
|
12742
13344
|
/** @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. */
|
|
12743
13345
|
include?: ("creators" | "name" | "components")[];
|
|
12744
13346
|
/**
|
|
@@ -12807,7 +13409,7 @@ export interface operations {
|
|
|
12807
13409
|
*/
|
|
12808
13410
|
getPipeline: {
|
|
12809
13411
|
parameters: {
|
|
12810
|
-
query
|
|
13412
|
+
query?: {
|
|
12811
13413
|
/** @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. */
|
|
12812
13414
|
include?: ("creators" | "name" | "components")[];
|
|
12813
13415
|
};
|
|
@@ -12894,7 +13496,7 @@ export interface operations {
|
|
|
12894
13496
|
*/
|
|
12895
13497
|
getPipelineRuns: {
|
|
12896
13498
|
parameters: {
|
|
12897
|
-
query
|
|
13499
|
+
query?: {
|
|
12898
13500
|
sort?: components["parameters"]["SortParam"];
|
|
12899
13501
|
/** @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. */
|
|
12900
13502
|
include?: ("creators")[];
|
|
@@ -12960,7 +13562,7 @@ export interface operations {
|
|
|
12960
13562
|
*/
|
|
12961
13563
|
getPipelineTriggerKeys: {
|
|
12962
13564
|
parameters: {
|
|
12963
|
-
query
|
|
13565
|
+
query?: {
|
|
12964
13566
|
/**
|
|
12965
13567
|
* @description ## Filter Field
|
|
12966
13568
|
* 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.
|
|
@@ -13159,7 +13761,7 @@ export interface operations {
|
|
|
13159
13761
|
*/
|
|
13160
13762
|
getSecurityReport: {
|
|
13161
13763
|
parameters: {
|
|
13162
|
-
query
|
|
13764
|
+
query?: {
|
|
13163
13765
|
/**
|
|
13164
13766
|
* @description ## Filter Field
|
|
13165
13767
|
* 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.
|