Cycle’s API Docs Go Live

Cycle API Documentation

Cycle’s API docs are live, and with it a whole new suite of tools to automate the management of containers across cloud providers. This is the same API that Cycle’s portal is built upon, meaning you have near full capability to do anything programmatically that you can do through the interface.

Powerful and Expressive

Cycle’s API is a REST based JSON API, with standard return and error formats. Complex tasks, like starting dozens (or hundreds!) of container instances across multiple cloud providers, is as easy as submitting a “start” task for the environment. Cycle will queue up a job to handle it, and you can track the progress as the job completes. Automate the spinning up/shutting down of infrastructure, building stacks, or scaling workloads without breaking a sweat.

Each section of the API is divided into two parts. On the left, you’ll have a detailed description of the call, what permissions are required for your API key to access it, and a breakdown of what the return type will be. On the right, you’ll see examples for all supported libraries, and an example response, so that you can easily visualize what data you’ll be receiving.

Much More To Come

This API documentation will constantly be updated and revised as Cycle’s API evolves. This first release is focused on current demand, but there is some incredible functionality we’re still documenting— namely the notification websocket API and the internal container API. These will be available in the coming weeks to give you even more power and control.

In addition, we’ll be adding new official libraries as the demand arises. Currently, we support Typescript (node/javascript), as well as good ol’ fashioned cURL. A Go library is on the horizon and is sure to be coming to a Github repo near you. If you end up writing one for your favorite language, please let us know!

We can’t wait to see what awesome things you’ll build using the Cycle API. If you run into any issues, or have questions please don’t hesitate to reach out to our staff. We’re happy to help!

Still Have Questions?

If you want to dive in and learn more, head over to our slack channel. Our community is growing, and our team hangs out there daily. Feel free to shoot us a message any time with your questions and we’ll be sure to respond!

Of course, for a more in-depth look at how to use Cycle, check out our documentation.