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 ...

v2024.01.24.01

This release contains some rather large updates going out with this the latest version of the platform.

Deployments

Cycle now supports deployments within an environment. See our release video here for more details: https://www.youtube.com/watch?v=KI0ml65D8Ws

Simplified pipeline references (❗ BREAKING CHANGE ❗)

Cycle now uses 'fluid identifiers' for referencing resources/previous steps in steps. Existing pipelines have automatically been migrated with the update, and the API now uses them instead of previous structure.

Variable support in pipelines and stacks

Both pipelines and stacks now support variables in the format {{variable}}. The API has been updated to support building stacks/triggering pipelines with variables attached.

There have also been additional step types added to pipelines, such as the GET webhook step.

data root response key now listed as 'required'

All Cycle API responses are keyed under data. Now, this is listed as a 'required' field for 2xx responses, making it easier to interact with the response data in API clients etc.

There are many additional minor fixes/changes to the spec, listed below.

What's Changed

• Update Stack Spec Scoped Variable by @blewisCycle in #230
• Router extension config by @blewisCycle in #231
• server mounts by @blewisCycle in #232
• Blewis/server mounts by @blewisCycle in #234
• Blewis/server mounts by @blewisCycle in #235
• Add server console endpoint by @mattoni in #236
• updates to lb and telemetry by @mattoni in #237
• lb telemetry latest controllers by @mattoni in #238
• Spec Cleanup by @mattoni in #233
• Server spec updates by @mattoni in #239
• Add deployment changes to spec by @mattoni in #240
• resolve mistakes in spec by @blewisCycle in #241
• Add deployment to container post endpoint by @mattoni in #242
• Deployment Spec Compliance by @mattoni in #243
• Correction to environment deployments call by @mattoni in #244
• remove stack from env create by @blewisCycle in #245
• remove stack from env create pipeline step by @blewisCycle in #246
• deployment support for pipelines by @blewisCycle in #247
• add deployment tag step by @mattoni in #248
• Pipelines Overhaul by @mattoni in #249
• Set repo auth in stack spec to allow nullable by @mattoni in #250
• Add deployments as billing tier advanced feat. flag by @mattoni in #251
• resolve improper webhook options syntax by @blewisCycle in #252
• Blewis/webhook options by @blewisCycle in #253
• Add variables to trigger pipeline task by @mattoni in #254
• update webhook struct to be simple string route by @blewisCycle in #255
• update webhooks options non_200 to simply "not" by @blewisCycle in #256
• remove var: and identifier: from fluid identifier by @blewisCycle in #257
• add pipeline-run-completed activity by @blewisCycle in #258
• Update discovery config by @mattoni in #259
• update pipeline run by @blewisCycle in #260
• Blewis/update pipeline run by @blewisCycle in #261
• Add config to discovery reconfig job by @mattoni in #262
• activity components includes update by @blewisCycle in #263
• update webhook wait_on to retry_on by @blewisCycle in #264
• add variables to stack builds by @mattoni in #265
• Add dynamic boolean to pipelines by @mattoni in #266
• Add variable map to stacks by @mattoni in #267
• update to discovery config by @blewisCycle in #268
• add scheduler service container by @blewisCycle in #269
• pipeline run variables by @blewisCycle in #270
• Add missing includes for LB latest controllers by @mattoni in #271
• Make all 2xx responses require data in the return by @mattoni in #272

Full Changelog: v2023.12.11.01...v2024.01.24.01

v2023.12.11.01

Our latest platform release is now live, and with it we've done several corrections to the API spec, though nothing major has changed.

What's Changed

• small spec corrections to containers by @mattoni in #206
• update telemetry instance to be its own file by @blewisCycle in #207
• Fix container includes by @mattoni in #208
• update v1Config controllers to be an array by @blewisCycle in #210
• Fix container delete response by @mattoni in #209
• Cleanup incorrect fields by @mattoni in #211
• update lb router info by @blewisCycle in #212
• update to task descriptor by @blewisCycle in #213
• Blewis/task descriptor by @blewisCycle in #214
• Update autoscale_group on containers to be nullable by @mattoni in #215
• Fix task descriptor props by @mattoni in #216
• Task descriptor parallel subqueue can be null by @mattoni in #217
• add function deployment strategy by @blewisCycle in #218
• add auto update support by @blewisCycle in #219
• add path to router.match by @blewisCycle in #220
• updates to scoped variables struct by @blewisCycle in #221
• Stack spec container config required, annotations not by @mattoni in #222
• Correct bug in scoped variable access by @mattoni in #223
• Fix ogen indentation by @mattoni in #224
• Update route to StackSpecScopedVariable by @blewisCycle in #225
• Blewis/stack spec scoped variable by @blewisCycle in #226
• Blewis/stack spec scoped variable by @blewisCycle in #227
• updates to url requests by @blewisCycle in #228
• Stack Var Fixes by @mattoni in #229

Full Changelog: v2023.11.15.01...v2023.12.11.01

v2023.11.15.01

The latest updates to Cycle's API spec are here, coinciding with the production release we did late last week. Mostly the changes consist of corrections, but a few new API calls have been added.

As always, if you have any questions feel free to reach out to the Cycle team on our slack.

Sign up for a Cycle account at https://signup.cycle.io

What's Changed

• Remove StateInfo -> Deprecated by @blewisCycle in #186
• Resolve spelling mistake in getServerTelemetry by @blewisCycle in #187
• Add changed time to NodeState by @blewisCycle in #188
• Make existing nullable by @mattoni in #190
• Fix missing nullable values by @mattoni in #191
• update create server to return to JobDescriptor by @blewisCycle in #192
• update provider api calls to use providerIdentifier by @blewisCycle in #193
• Blewis/get provider by @blewisCycle in #194
• httpRouterConfig by @blewisCycle in #195
• add shared directory to container.config.runtime by @blewisCycle in #196
• provider server filtering by @blewisCycle in #198
• v1 config verbosity by @blewisCycle in #199
• add container.instance.healthcheck.failed activity type by @blewisCycle in #200
• add vpn reset activity by @blewisCycle in #201
• Add range filter to credits, invoices, instances by @blewisCycle in #197
• Add lookup endpoint to api spec by @mattoni in #202
• Make data/id fields required by @mattoni in #203
• Resolve issues in Job structure by @mattoni in #204
• updates to load balancer latest telemetry by @blewisCycle in #205

Full Changelog: v2023.10.11.01...v2023.11.15.01

v2023.10.11.01

What's Changed

• renamed resetPassword to updatePassword and added reset-password route by @blewisCycle in #167
• Blewis/autoscaling by @blewisCycle in #168
• Health Check changes by @aubuchcl in #170
• Lay the groundwork for Infrastructure Scaling by @blewisCycle in #169
• Add auto-scale related activity events by @mattoni in #172
• Blewis/eng 1583 autoscaling infrastructure public api by @blewisCycle in #171
• Add updated server & instance auto-scale structs by @mattoni in #173
• Fix autoscale on instances by @mattoni in #174
• Fix instance autoscale by @mattoni in #175
• Add more infrastructure autoscale hub activities by @mattoni in #176
• Add auto-scale group as activity component include by @mattoni in #177
• Add missing namespace to container config by @mattoni in #178
• Remove min instances autoscale feat by @mattoni in #179
• Remove deprecated job_id from task descriptor by @mattoni in #180
• Add latest_instance & failed timestamps for servers by @mattoni in #181
• Update auto-scale group scale-down section by @mattoni in #182
• Update tier plan features by @mattoni in #183
• Update filters for auto-scale groups by @mattoni in #184
• Add evacuate struct to server by @mattoni in #185

Full Changelog: v2023.09.18.01...v2023.10.11.01

v2023.09.26.01

What's Changed

• added descriptions and examples where needed and added the delay field for stacks > container > config > duration > health_check #170 @aubuchcl

v2023.09.18.01

What's Changed

• Resolve allof/anyofs by @mattoni in #160
• LB Config Cleanup by @mattoni in #161
• add meta to fetch invoice arg by @blewisCycle in #163
• Add nullable instance health state & health_check delay field by @mattoni in #164
• Add update policy + stagger by @mattoni in #165
• Providers identifier by @aubuchcl in #166

Full Changelog: v2023.08.24.01...v2023.09.18.01

v2023.08.24.01

This API Spec release coincides with the latest release of the platform.

What's Changed

• Update events filter for hub activity by @mattoni in #149
• Fix events filter description on hub activity by @mattoni in #150
• Make step resource location id required if present by @mattoni in #151
• Update DNS Records priority to integer by @blewisCycle in #152
• V1 Config Update by @blewisCycle in #153
• Add fields to backup logs by @blewisCycle in #154
• Add 'reset' to environment VPN tasks by @mattoni in #155
• Add server_deleted hub webhook by @mattoni in #156
• Update definitions for v1 load balancer by @mattoni in #157
• Add forward scheme to v1 router by @mattoni in #159
• Resolve missing type on destionation_connection by @mattoni in #158

Full Changelog: v2023.08.09.01...v2023.08.24.01

v2023.08.09.01

Includes several corrections to the spec, as well as some of the new features that are now released on the platform:

• OCI image sources
• Additional server CPU stats/telemetry