NodeJS Client for interacting with Cycle's API.

Downloads in past


991.5.0-dev.36 years ago7 years agoMinified + gzip package size for cycle-api in KB


Cycle Platform API Build Status npm version

What is Cycle?

Cycle is a Containers as a Service (CaaS) platform that through container-native features into a simple, yet powerful way to deploy and scale to bare-metal infrastructure around the world.


npm install --save cycle-api

API Overview

A token is required in order to access any endpoint using Cycle's API. When you authenticate using your API Key (generate one in the portal), a token/refresh token combo is generated and stored. This token will expire after two hours, it is up to the user to manage token refreshing.
import { Auth } from "cycle-api"

async function authenticate() {
    const result = await Auth.apiKeyAuth({
        secret: "YOUR_API_KEY"

    if (!result.ok) {
        throw new Error(result.error.detail);


The token is stored in an internal cache, but can be overridden if desired. This is useful if you want to write your token into a local storage device.
Every resource method returns an API Response wrapped in an awaitable promise. An API response contains the following properties:
interface APIResult<T> {
    ok: boolean;
    value?: T;
    error?: {
        status?: number;
        code?: ErrorCode;
        title?: string;
        detail?: string;
        source?: string;

where T is the type of resource you are attempting to access. This format is extremely powerful when using Typescript > 2.0, due to tagged unions. When using Typescript > 2.0, you MUST check the response of the call and verify no error is present before you are able to access the value.
import { Environments } from "cycle-api" 

async function getEnvironmentsList() {
    const resp = await Environments.document().get();
    if (!resp.ok) {
        // Handle your error here

    console.log(resp.value); // Your list of environments



  • Setting a team:
import { Settings } from "cycle-api"; = "YOUR_TEAM_ID";
  • Utilize an internal resource cache - If the same call is made within x seconds, it'll use a cached version of the results for speed
import { Settings } from "cycle-api";
Settings.cache.use = true;
Settings.cache.refresh = 1000 //ms
  • Set up token storage - Requires an interface with three functions: read, write, and delete
import { Settings } from "cycle-api";

interface StorageInterface {
    read(): Token | undefined;
    write(t: Token): void;
    delete(): void;
} = new StorageInterface(); // Replace with class that matches interface


The API client comes with optional utility functions to make interacting with Cycle even simpler.

Job Tracker

The job tracker is an awaitable function that takes a settings object and resolves when the job is in a state that would be completed - whether or not it errored.
import { Utils } from "cycle-api";

// Settings
interface JobTrackerSettings {
    id: ResourceId; // -> ID of job you want to track
    onProgress?: (j: Jobs.Single) => void; // -> function that gets called every update tick with current state of job
    fetchJob?: FetchJobCallback; // -> Override function - implement custom job fetching
    delay?: number; // -> ms between ticks

// Usage

async function test() {
    const jresp = await Utils.jobToComplete({
        id: "abc", // -> ID of Job (usually from task)
        onProgress: j => { // Function called on every update cycle
            console.log("JOB UPDATED", j);

     * Only gets here if job state is not new, running, or queued.
     * Cycle is no longer working on the job and no
     * more updated will be made
    if (jresp.ok) {
        const { value: job} = jresp;

        // Make sure data isn't null
        if (! {

        // Utilize job here