v2025.12.16.01

Our latest release expands API support for external volumes, updates our stack spec to include the new use_disk option, and resolves some minor type issues withing the spec.

What's Changed

• update stackspec by @blewisCycle in #757
• source device option on volume delete by @blewisCycle in #758
• reconfigure servers - external volume task by @blewisCycle in #759
• Fix external volume includes/meta by @mattoni in #760
• cert.generate by @blewisCycle in #762
• external volumes tasks by @blewisCycle in #761
• Scan Volumes content body by @blewisCycle in #763
• external volume content by @blewisCycle in #764
• volume attachment pointer by @blewisCycle in #765
• scan options namespace by @blewisCycle in #766
• Add use_disk to stack spec by @mattoni in #767
• external volume activities by @blewisCycle in #769
• attachment.reconfigure task by @blewisCycle in #768

Full Changelog: v2025.11.12.01...v2025.12.16.01

v2025.11.12.01

This release adds schemas and endpoints for external volumes.

What's Changed

• environment.service.gateway.ips.sync.failed added by @blewisCycle in #723
• Creating a trigger key requires a name by @mattoni in #725
• Add configuring state to virtual machines by @mattoni in #724
• billing dns zones by @blewisCycle in #726
• scoped variable description by @blewisCycle in #727
• Add Runtime Configuration Options to VM Config by @blewisCycle in #729
• resolve typegen issue around empty objects. by @blewisCycle in #730
• Reorganize VM runtime config and add attachments & OS flavor by @mattoni in #731
• Attached Volumes Feature by @mattoni in #732
• Resolve issue with nesting on attachable sources by @mattoni in #733
• Typo in Ceph-rbd type by @blewisCycle in #734
• Update Volume API Call -> ACL must allow null or undefined by @blewisCycle in #735
• nullable identifier on env/volume create by @blewisCycle in #736
• api spec stack build optional parameters by @blewisCycle in #737
• attachable volume rename to external volume by @blewisCycle in #738
• update container and vm SAN to use new external volumes instead by @blewisCycle in #739
• Add OpenVPN custom directives to service config by @mattoni in #741
• Add custom directives to VPN reconfigure task by @mattoni in #742
• external volumes update -> remove SanLun endpoints by @blewisCycle in #740
• add location filter to servers fetch by @blewisCycle in #743
• update container volume reconfigure task and remove additional san.lu… by @blewisCycle in #744
• vm volume config by @blewisCycle in #746
• vm external volume image source by @blewisCycle in #745
• Update the certificate lookup endpoint by @mattoni in #747
• server location filter update by @blewisCycle in #748
• ceph update by @blewisCycle in #749
• Update external volume sources to use integration IDs by @mattoni in #750
• external volume options update and use_disk on image struct by @blewisCycle in #751
• volumes revision by @blewisCycle in #752
• update patch pipeline trigger key return tyle by @blewisCycle in #753
• volume stack spec udpates to external by @blewisCycle in #754
• external volume activities and component additions by @blewisCycle in #755
• vm reconfig by @blewisCycle in #756

Full Changelog: v2025.09.25.01...v2025.11.12.01

v2025.09.25.01

What's Changed

• virtual machine tasks by @blewisCycle in #710
• container volume identifier by @blewisCycle in #711
• patch iso update by @blewisCycle in #712
• isos sort by @blewisCycle in #713
• instanceVolume nullable properties by @blewisCycle in #714
• Add device permissions to container config by @mattoni in #715
• Add container runtime device config to stack spec by @mattoni in #716
• update pipeline identifier by @blewisCycle in #717
• stack build deploy step nullable by @blewisCycle in #718
• container deprecate description by @blewisCycle in #720
• egress via gateway by @blewisCycle in #719
• Blewis/log drain services by @blewisCycle in #721
• vm volume activities by @blewisCycle in #722

Full Changelog: v2025.09.03.01...v2025.09.25.01

v2025.09.03.01

What's Changed

• remove logs container config by @blewisCycle in #678
• add environment.task.monitoring.reconfigured event by @mattoni in #679
• Fix misnamed activity by @mattoni in #680
• context window size by @blewisCycle in #681
• add cluster task activity by @blewisCycle in #682
• integraiton task verify activity by @blewisCycle in #683
• add cluster tier reconfigure activity by @blewisCycle in #684
• changelog by @blewisCycle in #685
• add buildvariables to deploy stack step by @blewisCycle in #686
• stack build deploy variables by @blewisCycle in #687
• plan tier and orders item update by @blewisCycle in #688
• network update by @blewisCycle in #689
• ipv4 nic by @blewisCycle in #690
• pool options by @blewisCycle in #691
• ip pool create activity by @blewisCycle in #692
• incompatible neighbor event by @blewisCycle in #694
• pagination for isos by @blewisCycle in #695
• Add vm root pw capabilities by @mattoni in #696
• Add support for SAN endpoints by @mattoni in #697
• Add definitions for new SAN image source types by @mattoni in #698
• Add SAN Target/LUN endpoints by @mattoni in #699
• Add san lun include params by @mattoni in #700
• Require SAN LUN target ID by @mattoni in #701
• Add SAN volumes to VM config by @mattoni in #702
• Add san sync activity types by @mattoni in #703
• san-update by @blewisCycle in #705
• blewis/index-update by @blewisCycle in #704
• san filtering by @blewisCycle in #706
• Redocly config by @blewisCycle in #693
• san lun meta by @blewisCycle in #707
• update san lun filter - single server id by @blewisCycle in #708
• container volume storage pool type fix by @blewisCycle in #709

Full Changelog: v2025.06.03.01...v2025.09.03.01

v2025.06.03.01

What's Changed

• deployment scoped variables by @blewisCycle in #648
• add bond modes by @blewisCycle in #649
• discovery throttle event by @blewisCycle in #650
• update virtual machine tag by @blewisCycle in #651
• tag-audit by @blewisCycle in #652
• node state desired by @blewisCycle in #653
• Add virtual provider L2 iso config by @mattoni in #654
• Add virtual provider L2 iso config (#654) by @mattoni in #655
• Add l2 network domains/static routes & rename by @mattoni in #656
• update sdn patch body by @mattoni in #657
• fixed destination prioritization by @blewisCycle in #658
• virtual provider tier feature by @blewisCycle in #659
• add rootpw change to vm activity by @blewisCycle in #660
• networks environment filter by @blewisCycle in #662
• Blewis/monitoring refactor v1 by @blewisCycle in #664
• invoice token by @blewisCycle in #661
• environment monitoring log drain by @blewisCycle in #666
• resolve issue with env task spelling error by @blewisCycle in #667
• add sdn pool ips by @blewisCycle in #668
• get cluster identifier description update by @blewisCycle in #669
• server monitoring throttle by @blewisCycle in #670
• update vm_priv_ips to hypervisor ips by @blewisCycle in #671
• clean up implementation in environment features by @blewisCycle in #672
• Add autoscale.up event by @mattoni in #673
• proper nullable object formatting by @blewisCycle in #674
• throughput descriptions by @blewisCycle in #675
• additional kernel args by @blewisCycle in #676
• build stack spec by @blewisCycle in #677
• Blewis/eng 3527 stackspec log drain by @blewisCycle in #665

Full Changelog: v2025.04.24.01...v2025.06.03.01

v2025.04.24.01

What's Changed

• Add direct payment method by @mattoni in #584
• include clusters on environment by @blewisCycle in #585
• remove bind ip by @blewisCycle in #586
• container deprecate step by @blewisCycle in #587
• list container deprecate in pipeline run step by @blewisCycle in #588
• Add quarantined state to servers by @mattoni in #589
• integration definition field by @blewisCycle in #590
• Add virtual provider & tasks by @mattoni in #591
• Fix mistake with api spec formatting by @mattoni in #592
• Add virtual machine gateways endpoint by @mattoni in #593
• nullable iso inputs by @blewisCycle in #594
• virtual provider isos by @blewisCycle in #595
• iso delete and generate url by @blewisCycle in #596
• unquarantine action by @blewisCycle in #597
• remove iso identifier by @blewisCycle in #598
• add iso activity by @blewisCycle in #599
• update iso struct with server network interfaces by @blewisCycle in #601
• patch and get iso by @blewisCycle in #602
• iso name by @blewisCycle in #603
• read me link updates for api docs by @blewisCycle in #583
• docs link by @blewisCycle in #550
• hub integration activities by @blewisCycle in #605
• server stats update by @blewisCycle in #606
• add unquarantine activity by @blewisCycle in #607
• waf expires by @blewisCycle in #608
• Add distributed deployment strategy by @mattoni in #609
• vlan networking by @blewisCycle in #610
• make host interface nullable by @blewisCycle in #611
• patch network update by @blewisCycle in #612
• update iso struct and api calls by @blewisCycle in #613
• clean up integration definition by @blewisCycle in #614
• create ip pool by @blewisCycle in #615
• patch routes in network by @blewisCycle in #616
• add virtual provider server actions by @blewisCycle in #617
• ip pool filters by @blewisCycle in #618
• Blewis/ip pool naming conventions by @blewisCycle in #620
• deprecate filter for containers by @blewisCycle in #621
• server vp activities by @blewisCycle in #622
• vlan route update by @blewisCycle in #623
• bonds section by @blewisCycle in #624
• interface name required by @blewisCycle in #625
• iso server storage by @blewisCycle in #626
• fix auth-reset -> auth.reset in job name by @mattoni in #627
• update nic static and dhcp structs by @blewisCycle in #628
• neighbors event by @blewisCycle in #629
• network create ip by @blewisCycle in #630
• Network to block in ip pool by @blewisCycle in #631
• update contributing by @mattoni in #632
• Add ability to restart container by @mattoni in #633
• Add restart task headers by @mattoni in #634
• Add file permissions to scoped variable file type by @mattoni in #635
• Add UID/GID by @mattoni in #636
• add ability to purge instance traffic by @blewisCycle in #637
• Blewis/server nickname by @blewisCycle in #638
• source ip routing type by @blewisCycle in #639
• server stats network transmitted by @blewisCycle in #640
• instance meta node by @blewisCycle in #641
• resolve vp iso name by @blewisCycle in #642
• Add power management endpoints to internal API by @mattoni in #643
• update container runtime host by @blewisCycle in #644
• add server power off events by @blewisCycle in #646
• Add diffing script for report generation by @mattoni in #645
• Release latest stack spec by @mattoni in #647

Full Changelog: v2025.02.18.01...v2025.04.24.01

v2025.02.18.01

This release formalizes the launch of Virtual Machine functionality for Cycle, and includes all endpoints used for creating and interacting with them. There are numerous other additions and improvements to typing throughout.

What's Changed

• Add new environment summary field by @mattoni in #556
• Add gateway to ServiceContainerIdentifier enum by @blewisCycle in #557
• Add log drain format option by @mattoni in #558
• Update stack spec by @mattoni in #560
• add 2fa struct to public account by @blewisCycle in #563
• Update internal API with missing endpoints by @mattoni in #566
• allow null for log format in stack spec by @blewisCycle in #562
• Add billing contact by @mattoni in #564
• add reconfigure task activity by @blewisCycle in #567
• announcement update by @blewisCycle in #568
• fix erroneous pipeline trigger response to job desc. by @mattoni in #569
• Add missing states to pipeline run by @mattoni in #570
• Add missing advanced property to pipeline trigger task by @mattoni in #571
• Add virtual machine support to dns records by @mattoni in #572
• Add virtual machines to record incldues and cleanup by @mattoni in #574
• vm priv ips by @blewisCycle in #573
• Blewis/vm priv ips 2 by @blewisCycle in #575
• Add downconverter script by @mattoni in #576
• Move request body discriminator for container tasks into separate file by @mattoni in #577
• standardize dns record titles to match their file names by @blewisCycle in #578
• Add billing emails to hub patch by @mattoni in #579
• Add billing status endpoint to platform API by @mattoni in #581
• Add deprecated field to integration definitions by @mattoni in #582

Full Changelog: v2025.01.15.01...v2025.02.18.01

v2025.01.15.01

Our first release of 2025!

This API release corrects some missing/extraneous fields, lays the groundwork for our new VM support coming soon, and several other minor issues.

What's Changed

• update lets encrypt - remove enable field by @blewisCycle in #526
• Current type on lb response is required by @mattoni in #527
• Update lets encrypt in stacks to not have an 'enable' by @mattoni in #528
• Add restrictions to hub integration queries by @mattoni in #529
• Add integration ID to server provider by @mattoni in #530
• Add clusters to server include by @mattoni in #531
• Add sort to list integrations query by @mattoni in #532
• extended integration configuration update by @blewisCycle in #533
• add server provider zone by @blewisCycle in #534
• nullable transport for v1 lb controller by @blewisCycle in #535
• add gateway functionality by @blewisCycle in #536
• add provider-multi-account feature to tier by @blewisCycle in #537
• Improve accuracy of membership includes parameters by @mattoni in #538
• Add gateway to environment summary by @mattoni in #539
• Fix membership includes pt 2 by @mattoni in #540
• Remove additional enums in hub membership includes by @mattoni in #541
• update container logs config to support log drain by @blewisCycle in #542
• add stack build logs by @blewisCycle in #543
• stack log by @blewisCycle in #544
• integrations filter update - remove identifier by @blewisCycle in #545
• update build log error code by @blewisCycle in #546
• resolve internal api server issue for unix socket by @blewisCycle in #547
• Update description for lookup components api call by @mattoni in #548
• Add endpoint for fetching available virtual machine IPs by @mattoni in #549
• Add gateway service configuration task by @mattoni in #552
• Scaling Threshold Key Change by @blewisCycle in #553
• force hub delete by @blewisCycle in #554
• update force delete body by @blewisCycle in #555

Full Changelog: v2024.11.25.01...v2025.01.15.01

v2024.11.25.01

This release lays the foundation for virtual machines, and adds support for user-uploaded TLS certificates.

Breaking Changes:

• Error code formats have been changed from _ to -, so for example 503.not_enabled is now 503.not-enabled

What's Changed

• Blewis/skip locks by @blewisCycle in #483
• add hypervisor to server and server models by @blewisCycle in #484
• Support Virtual Machines on Cycle by @mattoni in #482
• Blewis/block device container volume by @blewisCycle in #485
• update required payment result fields by @mattoni in #481
• Add VM support to event activity by @mattoni in #486
• Update metric and event call filtering parameters by @mattoni in #487
• Update virtual machine nomenclature by @mattoni in #488
• Resolve incorrect file for virtual machine path by @mattoni in #489
• Add virtual machine activity topics by @mattoni in #490
• Add vm to context for activity by @mattoni in #491
• Pipeline Runs Event Descriptions by @aubuchcl in #492
• update VM base image definition to include uefi by @mattoni in #493
• Update virtual machine specs by @mattoni in #494
• Mattoni/update virtual machine spec by @mattoni in #495
• update virtual machine cpu resources - cores to be nullable by @blewisCycle in #496
• vm reconfigure by @blewisCycle in #497
• get vms include containers by @blewisCycle in #498
• Virtual machine type updates by @mattoni in #499
• Virt machine root password can be null by @mattoni in #500
• Add support for serial-over-ssh to vms by @mattoni in #501
• Add extension to container instance by @mattoni in #502
• Add vm console event/activity by @mattoni in #503
• remove shutdown signals from VM shutdown policy by @blewisCycle in #504
• Add VM SSH key endpoints by @mattoni in #505
• Add missing ssh key routes by @mattoni in #506
• Add additional vm ssh key functionality by @mattoni in #507
• Correct mistake on ssh key create by @mattoni in #508
• Mattoni/fix ssh key create params by @mattoni in #509
• Make public key required for ssh key create by @mattoni in #510
• Add ssh key activity/component by @mattoni in #511
• Mattoni/vm ssh key activity component by @mattoni in #512
• Blewis/server allocation meta by @blewisCycle in #513
• Add hub security property by @mattoni in #514
• Invoice payment can be null by @mattoni in #515
• Add IP assignment for virtual machine by @mattoni in #516
• Allocate unallocate vm ip address task by @mattoni in #517
• Server Tasks by @mattoni in #518
• Add server meta to virtual machine endpoints by @mattoni in #519
• Add support for uploading user generated TLS certs by @mattoni in #520
• More work on user-supplied certs by @mattoni in #521
• More TLS certificate work by @mattoni in #522
• Fix domain filter name for user supplied certs by @mattoni in #523
• Add user tls certs to components by @mattoni in #524
• Add missing tls cert event property by @mattoni in #525

Full Changelog: v2024.10.22.01...v2024.11.25.01

v2024.10.22.01

This release is the first we've done in a long time as we've stabilized several interfaces and types, upgraded the spec from 3.0.0 to 3.1.0, separated out our various APIs to their own folders, separated out the stack spec, and countless more improvements. This certainly would have breaking changes from the last release we've done, and we're planning on doing more regular releases of the API.

This release marks the latest stable API spec for the platform and all other APIs provided by Cycle. If you have any issues with downstream clients, or notice anything incorrect based on what you're receiving from the API, please open an issue and let us know.

What's Changed

• add environments prune to Activity type enum by @blewisCycle in #274
• add overrides to create-image and create-import-image pipeline steps by @blewisCycle in #275
• router and http config updates by @blewisCycle in #273
• add client certs to TLS struct by @blewisCycle in #277
• Blewis/client certs by @blewisCycle in #278
• client cert auth rename by @blewisCycle in #279
• update deployment version description by @blewisCycle in #276
• discount update by @blewisCycle in #280
• update tls to router section by @blewisCycle in #281
• add "branch" ref type for git stack build create by @blewisCycle in #282
• Updates to various pipeline types by @mattoni in #283
• resolve issue with deployment start stop step struct by @blewisCycle in #284
• resolve tls optional properties by @blewisCycle in #285
• create image pipeline step build args by @blewisCycle in #286
• deployment start step update by @blewisCycle in #287
• Update Pipeline Run by @blewisCycle in #288
• Add new healthy deployment pipeline step by @mattoni in #289
• Add new hub integration endpoints by @mattoni in #290
• remove new state from integrations by @mattoni in #291
• nest integrations and available integrations return type under "data" by @blewisCycle in #293
• Update accuracy of api spec data by @mattoni in #292
• Add control endpoints for a single Hub Integration by @mattoni in #294
• Add hubs-integrations-view capability by @mattoni in #295
• New "Integration" system by @mattoni in #296
• Add 404.hub.integration error type by @mattoni in #297
• base 64 config by @blewisCycle in #299
• Require data field on available integrations by @mattoni in #298
• Make data field required on integrations by @mattoni in #300
• Integration endpoint improvements by @mattoni in #301
• update integration meta to link to proper definition by @mattoni in #302
• fix small mistake in integration auth type (string -> object) by @mattoni in #303
• minor fixes to spec by @mattoni in #305
• Add disable property to load balancer controller transport by @mattoni in #304
• Fix delete DNS Record response code 200 -> 202 on success by @mattoni in #306
• Updates to Container meta fields by @mattoni in #307
• update description for create/update integration by @blewisCycle in #308
• add vendor to integration by @mattoni in #309
• Custom builder options for Images/Sources by @mattoni in #310
• More integration work for Image Sources by @mattoni in #311
• update server provider to use vendor rather than identifier by @blewisCycle in #312
• deployment start activity by @blewisCycle in #313
• add identifier includes to all resources that have them by @mattoni in #314
• include integrations for get Images by @blewisCycle in #315
• Provider includes -> integrations includes by @mattoni in #316
• update integration id to be nullable by @blewisCycle in #317
• Blewis/nullable integration by @blewisCycle in #318
• Pipeline naming inconsistencies by @blewisCycle in #319
• Add editable property to Integrations by @mattoni in #320
• update ip pool provider to include vendor by @blewisCycle in #322
• update access environment variable struct by @blewisCycle in #323
• Blewis/access environment variable by @blewisCycle in #324
• updated URL for docs, fixed typo by @aubuchcl in #325
• lbv1 controller update - add controller template by @blewisCycle in #326
• Blewis/eng 2082 api spec acl roles by @blewisCycle in #327
• Further updates to capabilities/roles by @mattoni in #328
• Capabilities corrections by @mattoni in #329
• more corrections to capabilities lists by @mattoni in #330
• add 'extra' field on errors by @mattoni in #331
• resolve remaining issues with api spec by @blewisCycle in #332
• Add function as container state by @mattoni in #333
• add identifier to patch env arg by @blewisCycle in #334
• Add hubs-auditlog-view capability by @mattoni in #335
• stack prune pipeline step by @blewisCycle in #336
• pipeline prune activity by @blewisCycle in #337
• update role default to be string pointer by @blewisCycle in #338
• API Spec Standardization by @mattoni in #321
• roles activity message by @blewisCycle in #340
• Add definitions for scheduler service config by @mattoni in #339
• Blewis/backups update by @blewisCycle in #342
• scheduler config added to createSchedulerServiceJob by @blewisCycle in #343
• Scheduler Service API by @mattoni in #344
• Scheduler claim token >= 5 chars by @mattoni in #345
• mark request/response bodies as required by @mattoni in #346
• Add bind_host property by @mattoni in #349
• API Spec 3.1.0 Upgrade by @mattoni in #347
• Add data as required on container create by @mattoni in #351
• Add UDP configuration option for LBv1 by @mattoni in #352
• Stack Spec JSON Schema by @mattoni in #353
• Update telemetry options for tcp/udp by @mattoni in #354
• udp transport config does not have a connections property by @blewisCycle in #355
• Add support for external stack files by @mattoni in #356
• More verbose definitions for stack build deployments (scoped variables) by @aubuchcl in #357
• Add destination prioritization to load balancer router config by @mattoni in #358
• Stack Spec build by @blewisCycle in #360
• default to null by @mattoni in #359
• Add function container configuration options by @mattoni in #361
• nullable function ...