@cycleplatform/api-client-typescript 0.1.3 → 0.1.5

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.
@@ -463,6 +463,13 @@ export interface paths {
463
463
  */
464
464
  get: operations["getInstanceResourcesTelemetryReport"];
465
465
  };
466
+ "/v1/containers/{containerId}/instances/{instanceId}/telemetry/resources/stream": {
467
+ /**
468
+ * Instance Telemetry Stream Credentials
469
+ * @description Requires the `containers-view` capability. Retrieves an access token and URL to open a websocket to for streaming instance telemetry live. This connects directly to the compute layer on the server the instance is hosted on, and streams telemetry in real time.
470
+ */
471
+ get: operations["getInstanceResourcesTelemetryStream"];
472
+ };
466
473
  "/v1/containers/{containerId}/servers": {
467
474
  /**
468
475
  * List Container Servers
@@ -681,6 +688,13 @@ export interface paths {
681
688
  */
682
689
  get: operations["getHubMembers"];
683
690
  };
691
+ "/v1/hubs/current/membership": {
692
+ /**
693
+ * List Hub Memberships
694
+ * @description Gets the membership information for the current hub for the requesting account.
695
+ */
696
+ get: operations["getHubMembership"];
697
+ };
684
698
  "/v1/hubs/current/members/{memberId}": {
685
699
  /**
686
700
  * Fetch Hub Member
@@ -1202,13 +1216,6 @@ export interface paths {
1202
1216
  */
1203
1217
  get: operations["instanceConsoleAuth"];
1204
1218
  };
1205
- "/v1/containers/{containerId}/instances/{instanceId}/telemetry/resources/stream": {
1206
- /**
1207
- * Instance Telemetry Stream Credentials
1208
- * @description Requires the `containers-view` capability. Retrieves an access token and URL to open a websocket to for streaming instance telemetry live. This connects directly to the compute layer on the server the instance is hosted on, and streams telemetry in real time.
1209
- */
1210
- get: operations["getInstanceResourcesTelemetryStream"];
1211
- };
1212
1219
  "/v1/security/report": {
1213
1220
  /**
1214
1221
  * Get Security Report
@@ -1396,27 +1403,37 @@ export interface components {
1396
1403
  HubMembership: {
1397
1404
  id: components["schemas"]["ID"];
1398
1405
  /** @description An ID for the account associated with the given membership. */
1399
- account_id: string;
1406
+ account_id?: string;
1400
1407
  hub_id: components["schemas"]["HubID"];
1401
- /** @description A number that maps to the currently set role of the member. */
1402
- role: number;
1403
1408
  /**
1404
1409
  * MembershipEvents
1405
1410
  * @description A collection of timestamps for each event in the membership's lifetime.
1406
1411
  */
1407
1412
  events: {
1408
1413
  /** @description The timestamp of when the membership was created. */
1409
- created: components["schemas"]["DateTime"];
1414
+ created?: components["schemas"]["DateTime"];
1410
1415
  /** @description The timestamp of when the membership was updated. */
1411
- updated: components["schemas"]["DateTime"];
1416
+ updated?: components["schemas"]["DateTime"];
1412
1417
  /** @description The timestamp of when the membership was deleted. */
1413
- deleted: components["schemas"]["DateTime"];
1418
+ deleted?: components["schemas"]["DateTime"];
1414
1419
  /** @description The timestamp of when the membership was accepted. */
1415
1420
  joined: components["schemas"]["DateTime"];
1416
1421
  };
1417
- state: components["schemas"]["MembershipState"];
1418
- invitation: components["schemas"]["Invitation"];
1419
- /** @description Information about this members permissions for a given hub. */
1422
+ /**
1423
+ * @description A number that maps to the currently set role of the member.
1424
+ *
1425
+ * ## Roles
1426
+ * 0 = DEFAULT
1427
+ * 1 = OWNER
1428
+ * 2 = ADMIN
1429
+ * 4 = DEVELOPER
1430
+ * 8 = ANALYST
1431
+ */
1432
+ role: number;
1433
+ /**
1434
+ * HubMembershipPermissions
1435
+ * @description Information about this member's permissions for a given hub.
1436
+ */
1420
1437
  permissions: {
1421
1438
  /** @description A boolean where true represents the member has access to view and manage all environments for the hub. */
1422
1439
  all_environments: boolean;
@@ -1427,8 +1444,11 @@ export interface components {
1427
1444
  manage: boolean;
1428
1445
  })[];
1429
1446
  };
1430
- /** @description Preference information set by the user for the membership. */
1431
- prefereneces: {
1447
+ /**
1448
+ * HubMembershipPreferences
1449
+ * @description Preference information set by the user for the membership.
1450
+ */
1451
+ preferences?: {
1432
1452
  portal: {
1433
1453
  notifications: {
1434
1454
  jobs: {
@@ -1439,13 +1459,15 @@ export interface components {
1439
1459
  email: {
1440
1460
  notificaitons?: {
1441
1461
  server: {
1442
- new?: boolean;
1443
- offline?: boolean;
1462
+ new: boolean | null;
1463
+ offline: boolean | null;
1444
1464
  };
1445
1465
  };
1446
1466
  };
1447
1467
  };
1448
- /** @description Information about the membership as it pertains to the account holders affiliation with being a Cycle employee. Cycle employee accounts do not consume a "membership" for a given hub. */
1468
+ state: components["schemas"]["MembershipState"];
1469
+ invitation: components["schemas"]["Invitation"];
1470
+ /** @description If this member is a Cycle employee, their employee ID will be listed here. Cycle employee accounts do not consume a "membership" for a given hub. */
1449
1471
  cycle?: {
1450
1472
  /** @description The ID of the employee this membership is associated with. */
1451
1473
  employee_id: string;
@@ -1570,9 +1592,9 @@ export interface components {
1570
1592
  /** @description Information about the plan associated with this hub. */
1571
1593
  plans: {
1572
1594
  /** @description An ID referencing the pricing tier applied to this hub. */
1573
- tier_id: string;
1595
+ tier_id: string | null;
1574
1596
  /** @description An ID referencing the support plan applied to this hub. */
1575
- support_id: string;
1597
+ support_id: string | null;
1576
1598
  };
1577
1599
  /** @description An array of email addresses to whom the billing invoices will be sent to. If left empty, they will be sent to the owner of this hub. */
1578
1600
  emails: (string)[] | null;
@@ -2439,9 +2461,10 @@ export interface components {
2439
2461
  /** @description Whether or not legacy networking mode is enabled on this environment. */
2440
2462
  legacy_networking: boolean;
2441
2463
  };
2442
- HAProxyConfig: {
2464
+ /** HAProxyConfig */
2465
+ HaProxyConfig: {
2443
2466
  /** @description Settings that describe how incoming traffic to the load balancer is handled. */
2444
- frontend: ({
2467
+ frontend: {
2445
2468
  /**
2446
2469
  * @description The type of traffic expected by the load balancer for this port. Can be either:
2447
2470
  * - tcp: Traffic is forwarded without any parsing or additional manipulation.
@@ -2462,9 +2485,9 @@ export interface components {
2462
2485
  /** @description The number of milliseconds the load balancer will wait for a complete HTTP request. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4.2-timeout%20http-request) for more information. (`http` mode only) */
2463
2486
  http_request_ms: number | null;
2464
2487
  }) | null;
2465
- }) | null;
2488
+ };
2466
2489
  /** @description Settings related to how the load balancer routes connections to container instances. */
2467
- backend: ({
2490
+ backend: {
2468
2491
  /**
2469
2492
  * @description How connections are balanced across your container instances. Can be one of the following:
2470
2493
  * - `roundrobin`: Each container instance is used in turns.
@@ -2488,6 +2511,25 @@ export interface components {
2488
2511
  /** @description The number of milliseconds the load balancer will allow for inactivity on a bidirectional tunnel. See the [HAProxy Docs](https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4-timeout%20tunnel) for more information. */
2489
2512
  tunnel_secs: number | null;
2490
2513
  }) | null;
2514
+ };
2515
+ };
2516
+ /**
2517
+ * LoadBalancerConfig
2518
+ * @description The config object for the loadbalancer service.
2519
+ */
2520
+ LoadBalancerConfig: {
2521
+ /** @enum {string} */
2522
+ version: "haproxy" | "v1";
2523
+ /** @description Describes settings that are passed to HAProxy within the load balancer. */
2524
+ haproxy: ({
2525
+ default: components["schemas"]["HaProxyConfig"];
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;
2491
2533
  }) | null;
2492
2534
  };
2493
2535
  /**
@@ -2498,23 +2540,10 @@ export interface components {
2498
2540
  /** @description Whether or not the loadbalancer service is enabled. */
2499
2541
  enable: boolean;
2500
2542
  /** @description The ID of the loadbalancer service container */
2501
- container_id: string;
2543
+ container_id: string | null;
2502
2544
  /** @description A boolean representing if this service container is set to high availability mode or not. */
2503
2545
  high_availability: boolean;
2504
- /** @description The config object for the loadbalancer service. */
2505
- config: ({
2506
- /** @description Describes settings that are passed to HAProxy within the load balancer. */
2507
- haproxy: ({
2508
- default: components["schemas"]["HAProxyConfig"];
2509
- ports: {
2510
- [key: string]: components["schemas"]["HAProxyConfig"] | undefined;
2511
- };
2512
- }) | null;
2513
- /** @description Allow / disallow traffic to be routed via IPv4. */
2514
- ipv4: boolean | null;
2515
- /** @description Allow / disallow traffic to be routed via IPv6. */
2516
- ipv6: boolean | null;
2517
- }) | null;
2546
+ config: components["schemas"]["LoadBalancerConfig"] | null;
2518
2547
  }) | null;
2519
2548
  /**
2520
2549
  * DiscoveryEnvironmentService
@@ -2833,45 +2862,6 @@ export interface components {
2833
2862
  instances: components["schemas"]["StateCountSummary"];
2834
2863
  };
2835
2864
  };
2836
- /**
2837
- * LoadBalancerInfoReturn
2838
- * @description Information about an environments load balancer configuration, state, and availability settings.
2839
- */
2840
- LoadBalancerInfoReturn: {
2841
- /** @description The default configuration of the load balancer. */
2842
- default_config: {
2843
- /** @description Describes settings that are passed to HAProxy within the load balancer. */
2844
- haproxy?: {
2845
- default: components["schemas"]["HAProxyConfig"];
2846
- ports: components["schemas"]["HAProxyConfig"];
2847
- } | null;
2848
- /** @description Allow / disallow traffic to be routed via IPv4. */
2849
- ipv4?: boolean | null;
2850
- /** @description Allow / disallow traffic to be routed via IPv6. */
2851
- ipv6?: boolean | null;
2852
- };
2853
- /** @description Contains information about the status of the load balancer, as well as configuration overrides. */
2854
- service: {
2855
- /** @description Whether or not the loadbalancer service is enabled. */
2856
- enable: boolean;
2857
- /** @description The ID of the loadbalancer service container */
2858
- container_id: string;
2859
- /** @description A boolean representing if this service container is set to high availability mode or not. */
2860
- high_availability: boolean;
2861
- /** @description Contains custom configuration overrides for the load balancer. If null, the default config will be used. */
2862
- config?: {
2863
- /** @description Describes settings that are passed to HAProxy within the load balancer. */
2864
- haproxy?: {
2865
- default: components["schemas"]["HAProxyConfig"];
2866
- ports: components["schemas"]["HAProxyConfig"];
2867
- } | null;
2868
- /** @description Allow / disallow traffic to be routed via IPv4. */
2869
- ipv4?: boolean | null;
2870
- /** @description Allow / disallow traffic to be routed via IPv6. */
2871
- ipv6?: boolean | null;
2872
- };
2873
- };
2874
- };
2875
2865
  /**
2876
2866
  * VPNInfo
2877
2867
  * @description A summary of a VPN service for a given environment.
@@ -3110,8 +3100,7 @@ export interface components {
3110
3100
  all?: (string)[];
3111
3101
  };
3112
3102
  };
3113
- /** @description An array of container identifiers the platform will send the start signal to before sending the start signal to this container. */
3114
- containers?: (string)[];
3103
+ secrets?: (string)[];
3115
3104
  };
3116
3105
  /** @description Configuration for what to do during container shutdown. */
3117
3106
  shutdown?: {
@@ -3125,11 +3114,6 @@ export interface components {
3125
3114
  /** @description A value in seconds representing how long the platform will wait before sending the start signal to the given container. */
3126
3115
  delay?: number;
3127
3116
  };
3128
- /** @description Configurations for how the container behaves when updating. */
3129
- update?: {
3130
- parallelism: number;
3131
- delay: number;
3132
- };
3133
3117
  /** @description Configurations for container restart events. */
3134
3118
  restart?: {
3135
3119
  /**
@@ -3320,12 +3304,17 @@ export interface components {
3320
3304
  cron_string?: string;
3321
3305
  };
3322
3306
  /** @description Configuration settings for restoring from a backup. */
3323
- restore: {
3307
+ restore: ({
3324
3308
  /** @description The command to run for restoring from a backup. */
3325
3309
  command: string;
3326
3310
  /** @description The time in seconds for the restore to appempt to complete before timing out. */
3327
3311
  timeout?: number | null;
3328
- };
3312
+ }) | null;
3313
+ /**
3314
+ * @description How long (in seconds) to keep backups. Default is 1 year.
3315
+ * @default 31536000
3316
+ */
3317
+ retention: number | null;
3329
3318
  };
3330
3319
  };
3331
3320
  /**
@@ -3585,6 +3574,8 @@ export interface components {
3585
3574
  stateful: boolean;
3586
3575
  /** @description A boolean where true signifies the container is marked as deprecated. */
3587
3576
  deprecate?: boolean;
3577
+ /** @description When set to true, prevents this container from being deleted. */
3578
+ lock?: boolean;
3588
3579
  state: components["schemas"]["ContainerState"];
3589
3580
  /**
3590
3581
  * ContainerEvents
@@ -3602,11 +3593,13 @@ export interface components {
3602
3593
  };
3603
3594
  meta?: components["schemas"]["ContainersMeta"];
3604
3595
  };
3605
- /** DockerHubSource */
3606
- DockerHubSource: {
3596
+ /**
3597
+ * DockerHubOrigin
3598
+ * @description An image origin where the image is pulled from DockerHub.
3599
+ */
3600
+ DockerHubOrigin: {
3607
3601
  /** @enum {string} */
3608
3602
  type?: "docker-hub";
3609
- /** @description An image source origin that pulls from DockerHub. */
3610
3603
  details?: {
3611
3604
  /** @description The DockerHub target string. ex - `mysql:5.7` */
3612
3605
  target: string;
@@ -3676,11 +3669,13 @@ export interface components {
3676
3669
  /** @description A token for authentication. */
3677
3670
  token?: string;
3678
3671
  })[];
3679
- /** DockerfileFileSource */
3680
- DockerfileFileSource: {
3672
+ /**
3673
+ * DockerFileOrigin
3674
+ * @description An image origin where the image is built from a Dockerfile located in a git repository.
3675
+ */
3676
+ DockerFileOrigin: {
3681
3677
  /** @enum {string} */
3682
3678
  type?: "docker-file";
3683
- /** @description An image source origin that creates an image from a Dockerfile that's listed in a repository. */
3684
3679
  details?: {
3685
3680
  repo?: components["schemas"]["RepoType"];
3686
3681
  /** @description An endpoint that serves the tar file. */
@@ -3692,11 +3687,13 @@ export interface components {
3692
3687
  credentials?: components["schemas"]["DockerfileCredentials"];
3693
3688
  };
3694
3689
  };
3695
- /** DockerRegistrySource */
3696
- DockerRegistrySource: {
3690
+ /**
3691
+ * DockerRegistryOrigin
3692
+ * @description An image origin where the image is pulled from a private Docker registry.
3693
+ */
3694
+ DockerRegistryOrigin: {
3697
3695
  /** @enum {string} */
3698
3696
  type?: "docker-registry";
3699
- /** @description An image source origin that pulls from a private Docker registry. */
3700
3697
  details?: {
3701
3698
  /** @description The image name on the registry. */
3702
3699
  target: string;
@@ -3711,17 +3708,85 @@ export interface components {
3711
3708
  };
3712
3709
  };
3713
3710
  /**
3714
- * ImageSourceOrigin
3711
+ * CycleUploadOrigin
3712
+ * @description An image origin where the image is pushed directly to the factory, bypassing the need for a registry or external source.
3713
+ *
3714
+ * In order to utilize this image origin type, a tar file of an OCI compliant image will need to be generated and pushed directly to the factory. The authentication token is generated when this image is created, and expires at the provided time.
3715
+ * Once you have a token, it can be uploaded as multipart form data under the key `file.tar`, directly to the factory at `https://factory.cycle.io:9414/v1/images/<IMAGE ID>/upload?hub-id=<HUB ID>&token=<TOKEN>`.
3716
+ */
3717
+ CycleUploadOrigin: {
3718
+ /** @enum {string} */
3719
+ type?: "cycle-upload";
3720
+ details?: {
3721
+ /** @description The date-time at which the authorization token for uploading this image expires. */
3722
+ expires: components["schemas"]["DateTime"];
3723
+ /** @description The token that is required by the factory to accept an upload for this image. */
3724
+ token: string;
3725
+ };
3726
+ };
3727
+ /**
3728
+ * CycleSourceOrigin
3729
+ * @description An image origin that references an image source on Cycle.
3730
+ *
3731
+ * This origin will never be embedded in an image source. It is for use in stacks, describing an image which is already a part of an image source on Cycle.
3732
+ */
3733
+ CycleSourceOrigin: {
3734
+ /** @enum {string} */
3735
+ type?: "cycle-source";
3736
+ details?: {
3737
+ /** @description The ID referencing the image source where this image originated. */
3738
+ source_id: components["schemas"]["ID"];
3739
+ };
3740
+ };
3741
+ /**
3742
+ * NoneOrigin
3743
+ * @description An empty origin. No details are provided for this image.
3744
+ */
3745
+ NoneOrigin: {
3746
+ /** @enum {string} */
3747
+ type?: "none";
3748
+ details?: Record<string, never>;
3749
+ };
3750
+ /**
3751
+ * ImageOrigin
3715
3752
  * @description The origin of the given image source.
3716
3753
  */
3717
- ImageSourceOrigin: components["schemas"]["DockerHubSource"] | components["schemas"]["DockerfileFileSource"] | components["schemas"]["DockerRegistrySource"];
3754
+ ImageOrigin: components["schemas"]["DockerHubOrigin"] | components["schemas"]["DockerFileOrigin"] | components["schemas"]["DockerRegistryOrigin"] | components["schemas"]["CycleUploadOrigin"] | components["schemas"]["CycleSourceOrigin"] | components["schemas"]["NoneOrigin"];
3755
+ /** StackImageSource */
3756
+ StackImageSourceType: {
3757
+ /** @enum {string} */
3758
+ type?: "stack-build";
3759
+ details?: {
3760
+ id: string;
3761
+ stack_id: string;
3762
+ containers: (components["schemas"]["Identifier"])[];
3763
+ origin: components["schemas"]["ImageOrigin"];
3764
+ };
3765
+ override?: {
3766
+ target?: string;
3767
+ targz_url?: string;
3768
+ };
3769
+ };
3770
+ /** DirectImageSource */
3771
+ DirectImageSourceType: {
3772
+ /** @enum {string} */
3773
+ type?: "direct" | "bucket";
3774
+ details?: {
3775
+ id: string;
3776
+ origin: components["schemas"]["ImageOrigin"];
3777
+ };
3778
+ override?: {
3779
+ target?: string;
3780
+ targz_url?: string;
3781
+ };
3782
+ };
3718
3783
  /** ImageState */
3719
3784
  ImageState: ({
3720
3785
  /**
3721
3786
  * @description The current state of the image.
3722
3787
  * @enum {string}
3723
3788
  */
3724
- current: "new" | "downloading" | "building" | "verifying" | "saving" | "live" | "deleting" | "deleted";
3789
+ current: "new" | "uploading" | "downloading" | "building" | "verifying" | "saving" | "live" | "deleting" | "deleted";
3725
3790
  }) & components["schemas"]["State"];
3726
3791
  /**
3727
3792
  * ImageMeta
@@ -3732,21 +3797,13 @@ export interface components {
3732
3797
  };
3733
3798
  /**
3734
3799
  * Image
3735
- * @description An Image Resource, which is a point in time build on a given image source.
3800
+ * @description An image is a point in time build on a given image source, and what is distributed by Cycle to run containers.
3736
3801
  */
3737
3802
  Image: {
3738
3803
  id: components["schemas"]["ID"];
3739
3804
  hub_id: components["schemas"]["HubID"];
3740
3805
  /** @description A user defined name for the image. */
3741
3806
  name: string;
3742
- /** @description If the image is part of a stack, that information will be available here. */
3743
- stack: {
3744
- id: components["schemas"]["ID"];
3745
- /** @description A unique identifier for the build the image is assocaited with. */
3746
- build_id: string;
3747
- /** @description If this image is being used for any containers their identifiers are listed here. */
3748
- containers: (string)[];
3749
- };
3750
3807
  /** @description The image size in bytes. */
3751
3808
  size: number;
3752
3809
  /** @description An object that holds information about the image. */
@@ -3759,14 +3816,23 @@ export interface components {
3759
3816
  /** @description The provider where this image is hosted. */
3760
3817
  provider: string;
3761
3818
  /** @description The size of the image in bytes. */
3762
- size: string;
3819
+ size: number;
3763
3820
  /** @description A file name for the image, used by the platform. */
3764
3821
  file_name: string;
3765
3822
  /** @description A file id for the image, used by the platform. */
3766
3823
  file_id: string;
3767
3824
  };
3768
- /** @description Tags that describe the version, package, or data about the image. */
3769
- tags: (string)[];
3825
+ /** @description Any restrictions or requirements needed to run this image as a container. */
3826
+ requires: {
3827
+ nvidia_gpu?: boolean;
3828
+ };
3829
+ /** @description Any additional build details for this image */
3830
+ build: ({
3831
+ /** @description Arguments to pass to the factory during a build of this image. */
3832
+ args?: {
3833
+ [key: string]: string | undefined;
3834
+ };
3835
+ }) | null;
3770
3836
  /** @description Configuration settings for the image. */
3771
3837
  config: {
3772
3838
  /** @description The linux user this image runs its processes as. */
@@ -3783,11 +3849,11 @@ export interface components {
3783
3849
  [key: string]: string | undefined;
3784
3850
  };
3785
3851
  /** @description Image labels. */
3786
- labels: string;
3852
+ labels: {
3853
+ [key: string]: string | undefined;
3854
+ };
3787
3855
  /** @description The CMD array used to start the container. */
3788
3856
  command: (string)[];
3789
- /** @description Additional commands to run at build time. */
3790
- onbuild: (string)[];
3791
3857
  /** @description An entrypoint command. */
3792
3858
  entrypoint: (string)[];
3793
3859
  /** @description Volumes information for the given image. */
@@ -3805,22 +3871,17 @@ export interface components {
3805
3871
  /** @description A set command to be run if a signal is called. */
3806
3872
  signal_stop: string;
3807
3873
  };
3808
- source?: {
3809
- type: string;
3810
- details: {
3811
- id: string;
3812
- stack_id: string;
3813
- origin: components["schemas"]["ImageSourceOrigin"];
3814
- };
3815
- };
3874
+ source?: components["schemas"]["DirectImageSourceType"] | components["schemas"]["StackImageSourceType"];
3816
3875
  creator?: components["schemas"]["CreatorScope"];
3817
3876
  /** @description Identifies which factory the image was built on and when. */
3818
- factory?: {
3877
+ factory: {
3819
3878
  /** @description The node holding the factory service that was responsible for building the image. */
3820
3879
  node_id: string;
3880
+ /** @description A date timestamp for when the node cached the image. */
3881
+ cached: components["schemas"]["DateTime"];
3821
3882
  /** @description A date timestamp for when the node acknowledged the image import job. */
3822
3883
  acknowledged: components["schemas"]["DateTime"];
3823
- };
3884
+ } | null;
3824
3885
  state: components["schemas"]["ImageState"];
3825
3886
  /**
3826
3887
  * ImageEvents
@@ -3843,6 +3904,88 @@ export interface components {
3843
3904
  ImagesIncludes: {
3844
3905
  [key: string]: components["schemas"]["Image"] | undefined;
3845
3906
  };
3907
+ /** StackSpecContainerImage */
3908
+ StackSpecContainerImage: {
3909
+ name: string | null;
3910
+ origin: components["schemas"]["ImageOrigin"];
3911
+ build?: {
3912
+ args: {
3913
+ [key: string]: string | undefined;
3914
+ };
3915
+ };
3916
+ };
3917
+ /** StackContainerConfigRuntime */
3918
+ StackContainerConfigRuntime: {
3919
+ workdir?: string;
3920
+ command?: {
3921
+ path?: string;
3922
+ args?: string;
3923
+ };
3924
+ environment_vars?: {
3925
+ [key: string]: string | undefined;
3926
+ };
3927
+ namespaces?: ("ipc" | "pid" | "uts" | "network" | "mount" | "user" | "cgroup")[];
3928
+ sysctl?: {
3929
+ [key: string]: string | undefined;
3930
+ };
3931
+ rlimits?: {
3932
+ [key: string]: {
3933
+ hard: number;
3934
+ soft: number;
3935
+ } | undefined;
3936
+ };
3937
+ seccomp?: {
3938
+ disable: boolean;
3939
+ rules: ({
3940
+ capabilities: {
3941
+ includes: string;
3942
+ excludes: string;
3943
+ };
3944
+ syscall: {
3945
+ names: (string)[];
3946
+ /** @enum {string} */
3947
+ action: "SCMP_ACT_KILL" | "SCMP_ACT_KILL_PROCESS" | "SCMP_ACT_KILL_THREAD" | "SCMP_ACT_TRAP" | "SCMP_ACT_ERRNO" | "SCMP_ACT_TRACE" | "SCMP_ACT_ALLOW" | "SCMP_ACT_LOG" | "SCMP_ACT_NOTIFY";
3948
+ errnoRet?: number;
3949
+ args?: ({
3950
+ index: number;
3951
+ value: number;
3952
+ valuetwo?: number;
3953
+ /** @enum {string} */
3954
+ op: "SCMP_CMP_NE" | "SCMP_CMP_LT" | "SCMP_CMP_LE" | "SCMP_CMP_EQ" | "SCMP_CMP_GE" | "SCMP_CMP_GT" | "SCMP_CMP_MASKED_EQ";
3955
+ })[];
3956
+ };
3957
+ })[];
3958
+ };
3959
+ privileged: boolean;
3960
+ capabilities?: ("CAP_CHOWN" | "CAP_FSETID" | "CAP_DAC_OVERRIDE" | "CAP_FOWNER" | "CAP_SETFCAP" | "CAP_SETGID" | "CAP_SETUID" | "CAP_KILL" | "CAP_MKNOD" | "CAP_NET_BIND_SERVICE" | "CAP_NET_RAW" | "CAP_AUDIT_WRITE" | "CAP_SYS_CHROOT" | "CAP_SETPCAP" | "CAP_DAC_READ_SEARCH" | "CAP_NET_ADMIN" | "CAP_NET_BROADCAST" | "CAP_SYS_ADMIN" | "CAP_SYS_MODULE" | "CAP_SYS_NICE" | "CAP_SYS_PACCT" | "CAP_SYS_PTRACE" | "CAP_SYS_RAWIO" | "CAP_SYS_RESOURCE" | "CAP_SYS_BOOT" | "CAP_SYS_TIME" | "CAP_SYS_TTY_CONFIG" | "CAP_SYSLOG" | "CAP_AUDIT_CONTROL" | "CAP_AUDIT_READ" | "CAP_IPC_LOCK" | "CAP_IPC_OWNER" | "CAP_LINUX_IMMUTABLE" | "CAP_MAC_ADMIN" | "CAP_MAC_OVERRIDE" | "CAP_BLOCK_SUSPEND" | "CAP_LEASE" | "CAP_WAKE_ALARM")[];
3961
+ rootfs?: {
3962
+ readonly: boolean;
3963
+ };
3964
+ };
3965
+ /** StackContainerConfigResources */
3966
+ StackContainerConfigResources: {
3967
+ cpu: {
3968
+ shares?: {
3969
+ limit: number;
3970
+ reserve: number;
3971
+ };
3972
+ cpus?: string;
3973
+ };
3974
+ ram: {
3975
+ limit?: string;
3976
+ reserve?: string;
3977
+ swappiness?: number;
3978
+ };
3979
+ };
3980
+ /** StackSpecTestContainer */
3981
+ StackSpecTestContainer: {
3982
+ name: string;
3983
+ image: components["schemas"]["StackSpecContainerImage"] | null;
3984
+ config: ({
3985
+ runtime?: components["schemas"]["StackContainerConfigRuntime"] | null;
3986
+ resources?: components["schemas"]["StackContainerConfigResources"] | null;
3987
+ }) | null;
3988
+ };
3846
3989
  /** StackContainerConfigNetwork.yml */
3847
3990
  StackContainerConfigNetwork: {
3848
3991
  /** @enum {string} */
@@ -3854,31 +3997,11 @@ export interface components {
3854
3997
  StackContainerConfigDeploy: {
3855
3998
  instances: number;
3856
3999
  /** @enum {string} */
3857
- strategy?: "resource-density" | "manual" | "high-availability" | "first-available" | "ephemeral";
4000
+ strategy?: "resource-density" | "manual" | "high-availability" | "first-available" | "node" | "edge";
3858
4001
  stateful?: {
3859
- instances: ({
3860
- match: {
3861
- hostname?: string;
3862
- };
3863
- first_start?: {
3864
- command?: {
3865
- path?: string;
3866
- args?: string;
3867
- };
3868
- environment_vars?: {
3869
- [key: string]: string | undefined;
3870
- };
3871
- };
3872
- start?: {
3873
- command?: {
3874
- path?: string;
3875
- args?: string;
3876
- };
3877
- environment_vars?: {
3878
- [key: string]: string | undefined;
3879
- };
3880
- };
3881
- })[];
4002
+ options: ({
4003
+ use_base_hostname?: boolean | null;
4004
+ }) | null;
3882
4005
  };
3883
4006
  constraints?: {
3884
4007
  node?: {
@@ -3891,11 +4014,11 @@ export interface components {
3891
4014
  containers?: (string)[];
3892
4015
  };
3893
4016
  shutdown?: {
3894
- graceful_timeout: number;
3895
- signals?: ("SIGTERM" | "SIGINT" | "SIGUSR1" | "SIGUSR2" | "SIGHUP")[];
4017
+ graceful_timeout?: number | null;
4018
+ signals?: (string)[];
3896
4019
  };
3897
4020
  startup?: {
3898
- delay?: number;
4021
+ delay?: number | null;
3899
4022
  };
3900
4023
  restart?: {
3901
4024
  /** @enum {string} */
@@ -3919,10 +4042,6 @@ export interface components {
3919
4042
  interval: number;
3920
4043
  disable: boolean;
3921
4044
  };
3922
- update?: {
3923
- parallelism: number;
3924
- delay: number;
3925
- };
3926
4045
  };
3927
4046
  /** StackContainerConfigScaling.yml */
3928
4047
  StackContainerConfigScaling: {
@@ -3938,69 +4057,6 @@ export interface components {
3938
4057
  };
3939
4058
  };
3940
4059
  };
3941
- /** StackContainerConfigRuntime */
3942
- StackContainerConfigRuntime: {
3943
- workdir?: string;
3944
- command?: {
3945
- path: string;
3946
- args: string;
3947
- };
3948
- environment_vars?: {
3949
- [key: string]: string | undefined;
3950
- };
3951
- namespaces?: ("ipc" | "pid" | "uts" | "network" | "mount" | "user")[];
3952
- sysctl?: {
3953
- [key: string]: string | undefined;
3954
- };
3955
- rlimits?: {
3956
- [key: string]: {
3957
- hard: number;
3958
- soft: number;
3959
- } | undefined;
3960
- };
3961
- seccomp?: {
3962
- disable: boolean;
3963
- rules?: ({
3964
- capabilities: {
3965
- includes: string;
3966
- excludes: string;
3967
- };
3968
- specs: {
3969
- names: (string)[];
3970
- action: string;
3971
- arrnoRet?: number;
3972
- args: ({
3973
- index: number;
3974
- value: number;
3975
- valuetwo?: number;
3976
- op: string;
3977
- })[];
3978
- };
3979
- })[];
3980
- };
3981
- privileged?: boolean;
3982
- capabilities?: ("CAP_CHOWN" | "CAP_FSETID" | "CAP_DAC_OVERRIDE" | "CAP_FOWNER" | "CAP_SETFCAP" | "CAP_SETGID" | "CAP_SETUID" | "CAP_KILL" | "CAP_MKNOD" | "CAP_NET_BIND_SERVICE" | "CAP_NET_RAW" | "CAP_AUDIT_WRITE" | "CAP_SYS_CHROOT" | "CAP_SETPCAP" | "CAP_DAC_READ_SEARCH" | "CAP_NET_ADMIN" | "CAP_NET_BROADCAST" | "CAP_SYS_ADMIN" | "CAP_SYS_MODULE" | "CAP_SYS_NICE" | "CAP_SYS_PACCT" | "CAP_SYS_PTRACE" | "CAP_SYS_RAWIO" | "CAP_SYS_RESOURCE" | "CAP_SYS_TTY_CONFIG" | "CAP_SYSLOG" | "CAP_AUDIT_CONTROL" | "CAP_AUDIT_READ" | "CAP_IPC_LOCK" | "CAP_IPC_OWNER" | "CAP_LINUX_IMMUTABLE" | "CAP_MAC_ADMIN" | "CAP_MAC_OVERRIDE" | "CAP_BLOCK_SUSPEND")[];
3983
- rootfs?: {
3984
- readonly: boolean;
3985
- };
3986
- };
3987
- /** StackContainerConfigResources */
3988
- StackContainerConfigResources: {
3989
- cpu: {
3990
- shares?: {
3991
- limit: number;
3992
- reserve: number;
3993
- };
3994
- cpus?: string;
3995
- };
3996
- ram: {
3997
- limit?: string;
3998
- reserve?: string;
3999
- swappiness?: number;
4000
- kernel?: string;
4001
- kernel_tcp?: string;
4002
- };
4003
- };
4004
4060
  /** StackContainerConfigIntegrations */
4005
4061
  StackContainerConfigIntegrations: {
4006
4062
  webhooks?: {
@@ -4024,10 +4080,9 @@ export interface components {
4024
4080
  destination: string;
4025
4081
  })[];
4026
4082
  backups?: {
4027
- /** @enum {string} */
4028
- destination: "backblaze-b2";
4083
+ destination: string;
4029
4084
  backup: {
4030
- command: number | null;
4085
+ command: string;
4031
4086
  timeout: number | null;
4032
4087
  cron_string: string | null;
4033
4088
  };
@@ -4035,82 +4090,101 @@ export interface components {
4035
4090
  command: string;
4036
4091
  timeout: number | null;
4037
4092
  }) | null;
4038
- };
4039
- };
4040
- /** StackContainerVolume.yml */
4041
- StackContainerVolume: {
4042
- read_only: boolean;
4043
- local?: {
4044
- max_size: string;
4045
- storage_pool: boolean;
4046
- };
4047
- destination: string;
4048
- remote_access?: {
4049
- enable: boolean;
4050
- ips?: ({
4051
- ip: string;
4052
- read_only: boolean;
4053
- password: ({
4054
- /** @enum {string} */
4055
- algorithm: "raw" | "sha512" | "md5";
4056
- data: string;
4057
- }) | null;
4058
- })[];
4059
- web_hook?: string;
4060
- password: {
4061
- /** @enum {string} */
4062
- algorithm: "raw" | "sha512" | "md5";
4063
- data: string;
4064
- };
4093
+ retention: number | null;
4065
4094
  };
4066
4095
  };
4067
4096
  /**
4068
4097
  * StackContainer
4069
- * @description A list of records defining the stacks containers.
4098
+ * @description Records defining the containers within the stack.
4070
4099
  */
4071
4100
  StackContainer: {
4072
- [key: string]: {
4101
+ [key: string]: ({
4073
4102
  name: string;
4074
- image: {
4075
- name: string;
4076
- origin: components["schemas"]["ImageSourceOrigin"];
4077
- stateful?: boolean;
4078
- config?: {
4079
- network: components["schemas"]["StackContainerConfigNetwork"];
4080
- deploy: components["schemas"]["StackContainerConfigDeploy"];
4081
- scaling?: components["schemas"]["StackContainerConfigScaling"];
4082
- runtime?: components["schemas"]["StackContainerConfigRuntime"];
4083
- resources?: components["schemas"]["StackContainerConfigResources"];
4084
- integrations?: components["schemas"]["StackContainerConfigIntegrations"];
4085
- };
4086
- /** @enum {string} */
4087
- role?: "orchestrator";
4088
- volumes?: (components["schemas"]["StackContainerVolume"])[];
4103
+ image: components["schemas"]["StackSpecContainerImage"];
4104
+ /** @description Additional meta info about the container. */
4105
+ annotations: Record<string, never>;
4106
+ stateful: boolean;
4107
+ /** StackSpecContainerConfig */
4108
+ config?: {
4109
+ network: components["schemas"]["StackContainerConfigNetwork"];
4110
+ deploy: components["schemas"]["StackContainerConfigDeploy"];
4111
+ scaling?: components["schemas"]["StackContainerConfigScaling"];
4112
+ runtime?: components["schemas"]["StackContainerConfigRuntime"];
4113
+ resources?: components["schemas"]["StackContainerConfigResources"];
4114
+ integrations?: components["schemas"]["StackContainerConfigIntegrations"];
4089
4115
  };
4090
- } | undefined;
4116
+ /** @enum {string} */
4117
+ role?: "conductor";
4118
+ pod?: string;
4119
+ volumes?: ({
4120
+ local?: {
4121
+ max_size: string;
4122
+ storage_pool?: boolean;
4123
+ };
4124
+ destination: string;
4125
+ read_only: boolean;
4126
+ remote_access?: {
4127
+ enable: boolean;
4128
+ ips?: (string)[];
4129
+ web_hook?: string;
4130
+ password: {
4131
+ /** @enum {string} */
4132
+ algorithm?: "raw" | "sha512" | "md5";
4133
+ data: string;
4134
+ };
4135
+ };
4136
+ })[];
4137
+ deprecate?: boolean;
4138
+ lock?: boolean;
4139
+ }) | undefined;
4091
4140
  };
4092
- /**
4093
- * StackSpec
4094
- * @description A stack spec resource.
4095
- */
4141
+ /** StackSpec */
4096
4142
  StackSpec: {
4097
- /** @enum {string} */
4098
- type: "raw";
4099
- details: {
4100
- /** @description A string defining the version of the stack spec. */
4143
+ /** @description A string defining the version of the stack spec. */
4144
+ version: string;
4145
+ /** @description Information about the stack. */
4146
+ about?: {
4147
+ /** @description Internal version information set by the user. */
4101
4148
  version: string;
4102
- /** @description Information about the stack. */
4103
- about?: {
4104
- /** @description Internal version information set by the user. */
4105
- version: string;
4106
- /** @description Information describing the stack. */
4107
- description: string;
4108
- };
4109
- containers: (components["schemas"]["StackContainer"])[] | null;
4110
- /** @description Additional meta info about the stack. */
4111
- annotations?: {
4112
- [key: string]: string | undefined;
4149
+ /** @description Information describing the stack. */
4150
+ description: string;
4151
+ };
4152
+ tests?: (components["schemas"]["StackSpecTestContainer"])[];
4153
+ containers: components["schemas"]["StackContainer"];
4154
+ /** StackSpecServices */
4155
+ 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
+ };
4113
4175
  };
4176
+ vpn?: {
4177
+ auth: {
4178
+ webhook?: string;
4179
+ cycle_accounts: boolean;
4180
+ vpn_accounts: boolean;
4181
+ };
4182
+ allow_internet: boolean;
4183
+ };
4184
+ };
4185
+ /** @description Additional meta info about the stack. */
4186
+ annotations?: {
4187
+ [key: string]: string | undefined;
4114
4188
  };
4115
4189
  };
4116
4190
  /**
@@ -4201,10 +4275,10 @@ export interface components {
4201
4275
  [key: string]: components["schemas"]["StackBuild"] | undefined;
4202
4276
  };
4203
4277
  /**
4204
- * StackRepoSourceType
4278
+ * StackRepoSource
4205
4279
  * @description A repo source type for a stack.
4206
4280
  */
4207
- RepoSpec: {
4281
+ StackRepoSource: {
4208
4282
  /** @enum {string} */
4209
4283
  type: "git-repo";
4210
4284
  details: {
@@ -4226,11 +4300,20 @@ export interface components {
4226
4300
  };
4227
4301
  };
4228
4302
  };
4303
+ /**
4304
+ * StackRawSource
4305
+ * @description A stack spec resource.
4306
+ */
4307
+ StackRawSource: {
4308
+ /** @enum {string} */
4309
+ type: "raw";
4310
+ details: components["schemas"]["StackSpec"];
4311
+ };
4229
4312
  /**
4230
4313
  * StackSource
4231
4314
  * @description A source for a stack to be created from.
4232
4315
  */
4233
- StackSource: components["schemas"]["RepoSpec"] | components["schemas"]["StackSpec"];
4316
+ StackSource: components["schemas"]["StackRepoSource"] | components["schemas"]["StackRawSource"];
4234
4317
  /** StackState */
4235
4318
  StackState: ({
4236
4319
  /**
@@ -5153,6 +5236,18 @@ export interface components {
5153
5236
  /** @description The maximum number of running processes for the instance. */
5154
5237
  limit?: number;
5155
5238
  };
5239
+ /**
5240
+ * InstanceTelemetryNetworkSnapshot
5241
+ * @description A snapshot of network usage statistics.
5242
+ */
5243
+ NetworkSnapshot: {
5244
+ /** @description An array of network interfaces attached to this instance. */
5245
+ interfaces: ({
5246
+ name: string;
5247
+ rx_bytes: number;
5248
+ tx_bytes: number;
5249
+ })[];
5250
+ };
5156
5251
  /**
5157
5252
  * HugeTLB
5158
5253
  * @description HugeTLB data.
@@ -5182,6 +5277,7 @@ export interface components {
5182
5277
  cpu: components["schemas"]["CPUSnapshot"];
5183
5278
  memory: components["schemas"]["MemorySnapshot"];
5184
5279
  processes: components["schemas"]["ProcessesSnapshot"];
5280
+ network: components["schemas"]["NetworkSnapshot"];
5185
5281
  hugetlb?: components["schemas"]["HugeTLB"];
5186
5282
  };
5187
5283
  /**
@@ -5601,14 +5697,18 @@ export interface components {
5601
5697
  * ActivitySession
5602
5698
  * @description Session info about the activity entry.
5603
5699
  */
5604
- Session: ({
5700
+ Session: {
5605
5701
  /** @description URL endpoint assocaited with the activity context - does not include domain. */
5606
5702
  url: string;
5607
5703
  /** @description The IP of the account associated with the session. */
5608
5704
  ip: string;
5705
+ token: {
5706
+ application_id: components["schemas"]["ID"];
5707
+ application_capabilities_version: number;
5708
+ } | null;
5609
5709
  /** @description The API key ID. */
5610
5710
  api_key: string | null;
5611
- }) | null;
5711
+ };
5612
5712
  /**
5613
5713
  * ActivityDetail
5614
5714
  * @description Details about a given event that is part of an activity.
@@ -5630,6 +5730,55 @@ export interface components {
5630
5730
  before?: components["schemas"]["Detail"];
5631
5731
  after?: components["schemas"]["Detail"];
5632
5732
  };
5733
+ /**
5734
+ * ActivitySecurity
5735
+ * @description Security information pertaining to this activity.
5736
+ */
5737
+ ActivitySecurity: {
5738
+ /**
5739
+ * @description A risk level assessed by the platform. Depending on the nature of the incident, this may change even if the event type is the same.
5740
+ *
5741
+ * @enum {string}
5742
+ */
5743
+ risk: "info" | "low" | "medium" | "high" | "critical";
5744
+ /**
5745
+ * @description From where the platform has determined this security event originated from.
5746
+ * @enum {string}
5747
+ */
5748
+ surface: "network" | "service" | "fs" | "api";
5749
+ /**
5750
+ * @description How the platform has handled this security event.
5751
+ * @enum {string}
5752
+ */
5753
+ event: "suggestion" | "notice" | "prevention" | "detection" | "reaction";
5754
+ /**
5755
+ * @description The type of attack the platform has determined has occurred.
5756
+ * @enum {string}
5757
+ */
5758
+ attack: "none" | "auth-failure" | "brute-force" | "exploit-vulnerability" | "social-engineer" | "service-interruption" | "access-elevation";
5759
+ };
5760
+ /**
5761
+ * ActivityMonitor
5762
+ * @description Details related to the monitor that raised this activity event.
5763
+ */
5764
+ ActivityMonitor: {
5765
+ /**
5766
+ * @description The severity of the event.
5767
+ *
5768
+ * @enum {string}
5769
+ */
5770
+ level: "info" | "low" | "medium" | "high" | "critical";
5771
+ /**
5772
+ * @description How the platform has handled this monitor event.
5773
+ * @enum {string}
5774
+ */
5775
+ event: "suggestion" | "notice" | "prevention" | "detection" | "reaction";
5776
+ /**
5777
+ * @description The current state of the monitored resource
5778
+ * @enum {string}
5779
+ */
5780
+ state: "none" | "unknown" | "unreachable" | "flux" | "recovered";
5781
+ };
5633
5782
  /**
5634
5783
  * Activity
5635
5784
  * @description A resource representing information about activity taking place on a given hub.
@@ -5644,13 +5793,20 @@ export interface components {
5644
5793
  * @enum {string}
5645
5794
  */
5646
5795
  type: "account" | "environment" | "platform" | "platform-pipeline" | "employee" | "api-key" | "visitor";
5647
- /** @description The given users ID. */
5796
+ /** @description The given user's ID. */
5648
5797
  id: string;
5649
5798
  };
5650
- /** @description A number representing how verbose the acitivty reporting is for a given hub. */
5799
+ /**
5800
+ * @description A number representing the detail level (verbosity) of this activity.
5801
+ *
5802
+ * ## Levels
5803
+ * - 0: activity that other users would find useful
5804
+ * - 1: activity that can be useful in tracking down how a user did something
5805
+ * - 2: full activity, can be useful in debugging problems
5806
+ */
5651
5807
  verbosity: number;
5652
5808
  context: components["schemas"]["Context"];
5653
- session?: components["schemas"]["Session"];
5809
+ session: components["schemas"]["Session"] | null;
5654
5810
  /** @description An array of changes. */
5655
5811
  changes: (components["schemas"]["Change"])[];
5656
5812
  /** @description A record of additional annotations for the activity. */
@@ -5674,15 +5830,95 @@ export interface components {
5674
5830
  * @description A status for the given activity.
5675
5831
  * @enum {string}
5676
5832
  */
5677
- status: "info" | "warning" | "request" | "success" | "error" | "alert" | "recovery";
5833
+ status: "info" | "warn" | "request" | "success" | "error" | "alert";
5834
+ security?: components["schemas"]["ActivitySecurity"];
5835
+ monitor?: components["schemas"]["ActivityMonitor"];
5678
5836
  /**
5679
5837
  * @description The activity event.
5680
5838
  * @enum {string}
5681
5839
  */
5682
- event: "hub.task.delete" | "hub.update" | "hub.create" | "hub.images.prune" | "hub.task.images.prune" | "environment.initialize" | "environment.start" | "environment.stop" | "environment.task.start" | "environment.task.stop" | "environment.task.initialize" | "environment.delete" | "environment.task.delete" | "environment.update" | "environment.create" | "environment.services.discovery.task.reconfigure" | "environment.services.lb.task.reconfigure" | "environment.services.vpn.task.reconfigure" | "image.import" | "image.task.import" | "image.update" | "image.create" | "image.delete" | "image.task.delete" | "image.source.create" | "image.source.update" | "image.source.task.delete" | "container.create" | "container.update" | "container.initialize" | "container.start" | "container.task.start" | "container.stop" | "container.task.stop" | "container.reconfigure" | "container.task.reconfigure" | "container.reconfigure.volumes" | "container.task.reconfigure.volumes" | "container.reimage" | "container.task.reimage" | "container.scale" | "container.task.scale" | "container.delete" | "container.task.delete" | "container.instance.error" | "container.instance.sftp.login" | "container.instance.migration.start" | "container.instance.migration.revert" | "container.instance.delete" | "container.instances.delete" | "container.instances.create" | "container.instance.healthcheck.restarted" | "container.backup.create" | "container.backup.restore" | "container.backup.task.restore" | "container.backup.delete" | "container.backup.task.delete" | "dns.zone.task.verify" | "dns.zone.task.delete" | "dns.zone.update" | "dns.zone.create" | "dns.zone.verify" | "dns.zone.delete" | "dns.zone.record.cert.generate.auto" | "dns.zone.record.cert.generate" | "dns.zone.record.delete" | "dns.zone.record.update" | "dns.zone.record.create" | "dns.zone.record.task.delete" | "dns.zone.record.task.cert.generate" | "stack.task.delete" | "stack.update" | "stack.create" | "stack.task.prune" | "stack.build.create" | "stack.build.generate" | "stack.build.deploy" | "stack.build.delete" | "stack.build.task.generate" | "stack.build.task.delete" | "infrastructure.server.task.delete" | "infrastructure.server.task.restart" | "infrastructure.server.task.provision" | "infrastructure.server.update" | "infrastructure.server.delete" | "infrastructure.server.restart" | "infrastructure.server.compute.restart" | "infrastructure.server.provision" | "infrastructure.server.live" | "infrastructure.server.services.sftp.lockdown.auto" | "infrastructure.server.reconfigure.features" | "infrastructure.server.task.reconfigure.features" | "infrastructure.provider.create" | "infrastructure.provider.update" | "infrastructure.provider.delete" | "sdn.network.task.delete" | "sdn.network.update" | "sdn.network.create" | "sdn.network.task.reconfigure" | "infrastructure.ips.pool.task.delete" | "billing.order.task.confirm" | "billing.order.confirm" | "billing.invoice.task.void" | "billing.invoice.task.credit" | "billing.invoice.task.refund" | "billing.invoice.task.pay" | "billing.invoice.pay" | "billing.method.update" | "billing.method.create" | "billing.method.delete" | "billing.method.task.delete" | "hub.apikey.create" | "hub.apikey.update" | "hub.apikey.delete" | "hub.membership.create" | "hub.membership.delete" | "pipeline.update" | "pipeline.task.delete" | "pipeline.delete" | "pipeline.create" | "pipeline.task.trigger" | "pipeline.trigger" | "pipeline.key.update" | "pipeline.key.delete" | "pipeline.key.create";
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";
5683
5841
  /** @description A timestamp for when the activity took place. */
5684
5842
  time: components["schemas"]["DateTime"];
5685
5843
  };
5844
+ /**
5845
+ * ImageSourceType
5846
+ * @description The type of images in this source.
5847
+ * @enum {string}
5848
+ */
5849
+ ImageSourceType: "stack-build" | "direct" | "bucket";
5850
+ /**
5851
+ * ImageSourceAbout
5852
+ * @description Information about the image source resource.
5853
+ */
5854
+ ImageSourceAbout: {
5855
+ /** @description Some information about the image source resource. */
5856
+ description: string;
5857
+ };
5858
+ /** ImageSourceState */
5859
+ ImageSourceState: ({
5860
+ /**
5861
+ * @description The current state of the image source.
5862
+ * @enum {string}
5863
+ */
5864
+ current: "live" | "deleting" | "deleted";
5865
+ }) & components["schemas"]["State"];
5866
+ /**
5867
+ * ImageSourceMeta
5868
+ * @description A list of meta fields that can be applied to this environment.
5869
+ */
5870
+ ImageSourceMeta: {
5871
+ images_count?: {
5872
+ /** @description Number of image sources */
5873
+ total: number;
5874
+ state: {
5875
+ /** @description Number of images in this source with state new */
5876
+ new: number;
5877
+ /** @description Number of images in this source with state downloading */
5878
+ downloading: number;
5879
+ /** @description Number of images in this source with state building */
5880
+ building: number;
5881
+ /** @description Number of images in this source with state verifying */
5882
+ verifying: number;
5883
+ /** @description Number of images in this source with state saving */
5884
+ saving: number;
5885
+ /** @description Number of images in this source with state live */
5886
+ live: number;
5887
+ /** @description Number of images in this source with state deleting */
5888
+ deleting: number;
5889
+ };
5890
+ };
5891
+ };
5892
+ /**
5893
+ * ImageSource
5894
+ * @description An image source is a set of resources that direct the platform on where it can find the resources needed to build an image resource.
5895
+ */
5896
+ ImageSource: {
5897
+ id: components["schemas"]["ID"];
5898
+ /** @description A human readable slugged identifier for this image source. */
5899
+ identifier: components["schemas"]["Identifier"];
5900
+ type: components["schemas"]["ImageSourceType"];
5901
+ hub_id: components["schemas"]["HubID"];
5902
+ /** @description A name for the image source resource. */
5903
+ name: string;
5904
+ about?: components["schemas"]["ImageSourceAbout"];
5905
+ origin: components["schemas"]["ImageOrigin"];
5906
+ creator: components["schemas"]["CreatorScope"];
5907
+ state: components["schemas"]["ImageSourceState"];
5908
+ /**
5909
+ * ImageSourceEvents
5910
+ * @description A collection of timestamps for each event in the iamge source's lifetime.
5911
+ */
5912
+ events: {
5913
+ /** @description The timestamp of when the iamge source was created. */
5914
+ created: components["schemas"]["DateTime"];
5915
+ /** @description The timestamp of when the iamge source was updated. */
5916
+ updated: components["schemas"]["DateTime"];
5917
+ /** @description The timestamp of when the iamge source was deleted. */
5918
+ deleted: components["schemas"]["DateTime"];
5919
+ };
5920
+ meta?: components["schemas"]["ImageSourceMeta"];
5921
+ };
5686
5922
  /**
5687
5923
  * IPPoolProvider
5688
5924
  * @description A IP Pool provider.
@@ -5865,14 +6101,6 @@ export interface components {
5865
6101
  deleted: components["schemas"]["DateTime"];
5866
6102
  };
5867
6103
  };
5868
- /**
5869
- * ImageSourceAbout
5870
- * @description Information about the image source resource.
5871
- */
5872
- ImageSourceAbout: {
5873
- /** @description Some information about the image source resource. */
5874
- description: string;
5875
- };
5876
6104
  /**
5877
6105
  * ImageSourceCreateStep
5878
6106
  * @description Settings for the image source create step for a pipeline.
@@ -5892,7 +6120,7 @@ export interface components {
5892
6120
  name: string;
5893
6121
  type: string;
5894
6122
  about?: components["schemas"]["ImageSourceAbout"];
5895
- origin: components["schemas"]["ImageSourceOrigin"];
6123
+ origin: components["schemas"]["ImageOrigin"];
5896
6124
  };
5897
6125
  };
5898
6126
  /**
@@ -6405,7 +6633,7 @@ export interface components {
6405
6633
  * @description A resource thats assocaited with activity.
6406
6634
  */
6407
6635
  ComponentsIncludes: {
6408
- [key: string]: (components["schemas"]["Container"] | components["schemas"]["Instance"] | components["schemas"]["Environment"] | components["schemas"]["Image"] | components["schemas"]["Server"] | components["schemas"]["Pool"] | components["schemas"]["Stack"] | components["schemas"]["StackBuild"] | components["schemas"]["Zone"] | components["schemas"]["Record"] | components["schemas"]["ApiKey"] | components["schemas"]["Provider"] | components["schemas"]["SDNNetwork"] | components["schemas"]["HubMembership"] | components["schemas"]["Pipeline"] | components["schemas"]["TriggerKey"]) | undefined;
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"]["SDNNetwork"] | components["schemas"]["HubMembership"] | components["schemas"]["Pipeline"] | components["schemas"]["TriggerKey"] | components["schemas"]["ScopedVariable"] | components["schemas"]["Hub"] | components["schemas"]["Invoice"] | components["schemas"]["Method"]) | undefined;
6409
6637
  };
6410
6638
  /**
6411
6639
  * ActivityIncludes
@@ -6486,74 +6714,6 @@ export interface components {
6486
6714
  [key: string]: components["schemas"]["Component"] | undefined;
6487
6715
  };
6488
6716
  };
6489
- /** ImageSourceState */
6490
- ImageSourceState: ({
6491
- /**
6492
- * @description The current state of the image source.
6493
- * @enum {string}
6494
- */
6495
- current: "live" | "deleting" | "deleted";
6496
- }) & components["schemas"]["State"];
6497
- /**
6498
- * ImageSourceMeta
6499
- * @description A list of meta fields that can be applied to this environment.
6500
- */
6501
- ImageSourceMeta: {
6502
- images_count?: {
6503
- /** @description Number of image sources */
6504
- total: number;
6505
- state: {
6506
- /** @description Number of images in this source with state new */
6507
- new: number;
6508
- /** @description Number of images in this source with state downloading */
6509
- downloading: number;
6510
- /** @description Number of images in this source with state building */
6511
- building: number;
6512
- /** @description Number of images in this source with state verifying */
6513
- verifying: number;
6514
- /** @description Number of images in this source with state saving */
6515
- saving: number;
6516
- /** @description Number of images in this source with state live */
6517
- live: number;
6518
- /** @description Number of images in this source with state deleting */
6519
- deleting: number;
6520
- };
6521
- };
6522
- };
6523
- /**
6524
- * ImageSource
6525
- * @description An image source is a set of resources that direct the platform on where it can find the resources needed to build an image resource.
6526
- */
6527
- ImageSource: {
6528
- id: components["schemas"]["ID"];
6529
- /** @description A human readable slugged identifier for this image source. */
6530
- identifier: components["schemas"]["Identifier"];
6531
- hub_id: components["schemas"]["HubID"];
6532
- /** @description A name for the image source resource. */
6533
- name: string;
6534
- about?: components["schemas"]["ImageSourceAbout"];
6535
- origin: components["schemas"]["ImageSourceOrigin"];
6536
- creator: components["schemas"]["CreatorScope"];
6537
- state: components["schemas"]["ImageSourceState"];
6538
- /**
6539
- * ImageSourceEvents
6540
- * @description A collection of timestamps for each event in the iamge source's lifetime.
6541
- */
6542
- events: {
6543
- /** @description The timestamp of when the iamge source was created. */
6544
- created: components["schemas"]["DateTime"];
6545
- /** @description The timestamp of when the iamge source was updated. */
6546
- updated: components["schemas"]["DateTime"];
6547
- /** @description The timestamp of when the iamge source was deleted. */
6548
- deleted: components["schemas"]["DateTime"];
6549
- };
6550
- /** @description Information about a server resource this image requires to function properly. */
6551
- requires: {
6552
- /** @description A boolean where true represents this image requies an Nvidia GPU to run properly. */
6553
- nvidia_gpu: boolean | null;
6554
- };
6555
- meta?: components["schemas"]["ImageSourceMeta"];
6556
- };
6557
6717
  /**
6558
6718
  * ImageSourceIncludes
6559
6719
  * @description A resource associated with an image source.
@@ -8316,7 +8476,11 @@ export interface operations {
8316
8476
  200: {
8317
8477
  content: {
8318
8478
  "application/json": {
8319
- data?: components["schemas"]["LoadBalancerInfoReturn"];
8479
+ /** @description Information about an environments load balancer configuration, state, and availability settings. */
8480
+ data?: {
8481
+ default_config: components["schemas"]["LoadBalancerConfig"];
8482
+ service: components["schemas"]["LoadBalancerEnvironmentService"];
8483
+ };
8320
8484
  };
8321
8485
  };
8322
8486
  };
@@ -8350,16 +8514,17 @@ export interface operations {
8350
8514
  high_availability?: boolean;
8351
8515
  /** @description The config object for the loadbalancer service. */
8352
8516
  config?: ({
8353
- version?: string;
8517
+ /** @enum {string} */
8518
+ version?: "v1" | "haproxy";
8354
8519
  /** @description Allow / disallow traffic to be routed via IPv4. */
8355
8520
  ipv4?: boolean | null;
8356
8521
  /** @description Allow / disallow traffic to be routed via IPv6. */
8357
8522
  ipv6?: boolean | null;
8358
8523
  /** @description Describes settings that are passed to HAProxy within the load balancer. */
8359
- haproxy: ({
8360
- default: components["schemas"]["HAProxyConfig"];
8524
+ haproxy?: ({
8525
+ default: components["schemas"]["HaProxyConfig"];
8361
8526
  ports: {
8362
- [key: string]: components["schemas"]["HAProxyConfig"] | undefined;
8527
+ [key: string]: components["schemas"]["HaProxyConfig"] | undefined;
8363
8528
  };
8364
8529
  }) | null;
8365
8530
  }) | null;
@@ -8883,6 +9048,8 @@ export interface operations {
8883
9048
  /** @description A boolean where true represents this container is stateful. */
8884
9049
  stateful: boolean;
8885
9050
  config: components["schemas"]["Config"];
9051
+ /** @description When set to true, prevents this container from being deleted. */
9052
+ lock?: boolean;
8886
9053
  volumes?: (components["schemas"]["ContainerVolume"])[];
8887
9054
  /** @description User defined meta data for the container. */
8888
9055
  annotations?: {
@@ -8977,6 +9144,8 @@ export interface operations {
8977
9144
  identifier?: string;
8978
9145
  /** @description Sets whether container should be deprecated. */
8979
9146
  deprecate?: boolean;
9147
+ /** @description When set to true, prevents this container from being deleted. */
9148
+ lock?: boolean;
8980
9149
  /** @description User meta data for the container. */
8981
9150
  annotation?: {
8982
9151
  [key: string]: string | undefined;
@@ -9353,6 +9522,40 @@ export interface operations {
9353
9522
  default: components["responses"]["DefaultError"];
9354
9523
  };
9355
9524
  };
9525
+ /**
9526
+ * Instance Telemetry Stream Credentials
9527
+ * @description Requires the `containers-view` capability. Retrieves an access token and URL to open a websocket to for streaming instance telemetry live. This connects directly to the compute layer on the server the instance is hosted on, and streams telemetry in real time.
9528
+ */
9529
+ getInstanceResourcesTelemetryStream: {
9530
+ parameters: {
9531
+ path: {
9532
+ /** @description The ID of the requested container. */
9533
+ containerId: string;
9534
+ /** @description The ID for the container instance. */
9535
+ instanceId: string;
9536
+ };
9537
+ };
9538
+ responses: {
9539
+ /** @description Returns credentials for connecting to an instance telemetry stream. */
9540
+ 200: {
9541
+ content: {
9542
+ "application/json": {
9543
+ /**
9544
+ * InstanceTelemetryStreamCredentials
9545
+ * @description Credentials for connecting to the instance telemetry stream on compute.
9546
+ */
9547
+ data?: {
9548
+ /** @description The authentication token passed into the address as a URL parameter (?token). */
9549
+ token: string;
9550
+ /** @description The URL address to open a websocket to for streaming instance telemetry data. */
9551
+ address: string;
9552
+ };
9553
+ };
9554
+ };
9555
+ };
9556
+ default: components["responses"]["DefaultError"];
9557
+ };
9558
+ };
9356
9559
  /**
9357
9560
  * List Container Servers
9358
9561
  * @description Requires the `containers-view` capability.
@@ -9909,7 +10112,7 @@ export interface operations {
9909
10112
  recordId: string;
9910
10113
  };
9911
10114
  };
9912
- /** @description Parameters for updateing a DNS record. The name value cannot be updated and is ommitted from the properties. */
10115
+ /** @description Parameters for updating a DNS record. The name value cannot be updated and is omitted from the properties. */
9913
10116
  requestBody?: {
9914
10117
  content: {
9915
10118
  "application/json": {
@@ -10029,6 +10232,7 @@ export interface operations {
10029
10232
  getHubs: {
10030
10233
  parameters: {
10031
10234
  query: {
10235
+ page?: components["parameters"]["PageParam"];
10032
10236
  /**
10033
10237
  * @description ## Filter Field
10034
10238
  * 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.
@@ -10378,6 +10582,35 @@ export interface operations {
10378
10582
  default: components["responses"]["DefaultError"];
10379
10583
  };
10380
10584
  };
10585
+ /**
10586
+ * List Hub Memberships
10587
+ * @description Gets the membership information for the current hub for the requesting account.
10588
+ */
10589
+ getHubMembership: {
10590
+ parameters: {
10591
+ query: {
10592
+ /** @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
+ meta?: ("capabilities")[];
10594
+ /** @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. */
10595
+ include?: ("accounts")[];
10596
+ sort?: components["parameters"]["SortParam"];
10597
+ filter?: components["parameters"]["FilterParam"];
10598
+ page?: components["parameters"]["PageParam"];
10599
+ };
10600
+ };
10601
+ responses: {
10602
+ /** @description Returns a hub membership. */
10603
+ 200: {
10604
+ content: {
10605
+ "application/json": {
10606
+ data?: components["schemas"]["HubMembership"];
10607
+ includes?: components["schemas"]["HubMembershipIncludes"];
10608
+ };
10609
+ };
10610
+ };
10611
+ default: components["responses"]["DefaultError"];
10612
+ };
10613
+ };
10381
10614
  /**
10382
10615
  * Fetch Hub Member
10383
10616
  * @description Requires the `hubs-members-view` capability.
@@ -10720,8 +10953,10 @@ export interface operations {
10720
10953
  };
10721
10954
  /** @description An override object to be used for a single image create request. */
10722
10955
  override?: {
10723
- /** @description A target to be used for overridding the default target. */
10724
- target: string;
10956
+ /** @description For image sources with `docker-hub` or `docker-registry` origin types. A target to be used for overridding the default target - should include an image and a tag. */
10957
+ target?: string;
10958
+ /** @description For image sources with `docker-file` origin types. A URL pointing to a .tar.gz file of a repo with a Dockerfile in it - can be used instead of linking Cycle directly to a repository. */
10959
+ targz_url?: string;
10725
10960
  };
10726
10961
  };
10727
10962
  };
@@ -10966,12 +11201,8 @@ export interface operations {
10966
11201
  /** @description A name for the image source. */
10967
11202
  name?: string;
10968
11203
  identifier?: components["schemas"]["Identifier"];
10969
- /**
10970
- * @description A value identifiying the type of image.
10971
- * @enum {string}
10972
- */
10973
- type: "stack_build" | "direct";
10974
- origin: components["schemas"]["ImageSourceOrigin"];
11204
+ type: components["schemas"]["ImageSourceType"];
11205
+ origin: components["schemas"]["ImageOrigin"];
10975
11206
  /** @description User defined information about the image source. */
10976
11207
  about?: {
10977
11208
  /** @description A description of the image source. */
@@ -11062,7 +11293,7 @@ export interface operations {
11062
11293
  "application/json": {
11063
11294
  /** @description A name for the image source. */
11064
11295
  name?: string;
11065
- origin?: components["schemas"]["ImageSourceOrigin"];
11296
+ origin?: components["schemas"]["ImageOrigin"];
11066
11297
  /** @description User defined information about the image source. */
11067
11298
  about?: {
11068
11299
  /** @description A description of the image source. */
@@ -12446,8 +12677,6 @@ export interface operations {
12446
12677
  "application/json": {
12447
12678
  /** @description The name of the network. */
12448
12679
  name?: string;
12449
- /** @description A network identifier used to construct http calls that specifically use this network over another. */
12450
- identifier?: string;
12451
12680
  };
12452
12681
  };
12453
12682
  };
@@ -12924,40 +13153,6 @@ export interface operations {
12924
13153
  default: components["responses"]["DefaultError"];
12925
13154
  };
12926
13155
  };
12927
- /**
12928
- * Instance Telemetry Stream Credentials
12929
- * @description Requires the `containers-view` capability. Retrieves an access token and URL to open a websocket to for streaming instance telemetry live. This connects directly to the compute layer on the server the instance is hosted on, and streams telemetry in real time.
12930
- */
12931
- getInstanceResourcesTelemetryStream: {
12932
- parameters: {
12933
- path: {
12934
- /** @description The ID of the requested container. */
12935
- containerId: string;
12936
- /** @description The ID for the container instance. */
12937
- instanceId: string;
12938
- };
12939
- };
12940
- responses: {
12941
- /** @description Returns credentials for connecting to an instance telemetry stream. */
12942
- 200: {
12943
- content: {
12944
- "application/json": {
12945
- /**
12946
- * InstanceTelemetryStreamCredentials
12947
- * @description Credentials for connecting to the instance telemetry stream on compute.
12948
- */
12949
- data?: {
12950
- /** @description The authentication token passed into the address as a URL parameter (?token). */
12951
- token: string;
12952
- /** @description The URL address to open a websocket to for streaming instance telemetry data. */
12953
- address: string;
12954
- };
12955
- };
12956
- };
12957
- };
12958
- default: components["responses"]["DefaultError"];
12959
- };
12960
- };
12961
13156
  /**
12962
13157
  * Get Security Report
12963
13158
  * @description Returns a report detailing incidents logged by the platform around security related events.
@@ -12970,6 +13165,10 @@ export interface operations {
12970
13165
  * 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.
12971
13166
  */
12972
13167
  filter?: {
13168
+ /** @description The start date from when to pull the security report */
13169
+ "range-start"?: components["schemas"]["DateTime"];
13170
+ /** @description The end date from when to pull the security report */
13171
+ "range-end"?: components["schemas"]["DateTime"];
12973
13172
  /** @description `filter[environment]=<Environment ID>` fetch the security report for the specified environment */
12974
13173
  environment?: string;
12975
13174
  /** @description `filter[event]=value` filter by event occurrence. Example: `filter[event]=environment.services.vpn.login` */