Coolify Typescript SDK

Self-hosting with superpowers.

Developer-friendly & type-safe Typescript SDK specifically catered to leverage the Coolify API.

Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Table of Contents

• SDK Installation
• Requirements
• SDK Example Usage
• Available Resources and Operations
• Standalone functions
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• Debugging

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add https://github.com/LukeHagar/Coolify-TypeScript-SDK

PNPM

pnpm add https://github.com/LukeHagar/Coolify-TypeScript-SDK

Bun

bun add https://github.com/LukeHagar/Coolify-TypeScript-SDK

Yarn

yarn add https://github.com/LukeHagar/Coolify-TypeScript-SDK zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Coolify } from "coolify";

const coolify = new Coolify({
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await coolify.applications.list();

  // Handle the result
  console.log(result);
}

run();

Available Resources and Operations

Available methods

api

• enable - Enable API
• disable - Disable API

applications

• list - List
• createPublic - Create (Public)
• createPrivateGithubApp - Create (Private - GH App)
• createPrivateDeployKey - Create (Private - Deploy Key)
• createDockerfile - Create (Dockerfile)
• createDockerImage - Create (Docker Image)
• createDockerCompose - Create (Docker Compose)
• get - Get
• delete - Delete
• update - Update
• listEnvs - List Envs
• createEnv - Create Env
• updateEnv - Update Env
• updateEnvsBulk - Update Envs (Bulk)
• deleteEnv - Delete Env
• start - Start
• stop - Stop
• restart - Restart
• executeCommand - Execute Command

databases

• list - List
• get - Get
• delete - Delete
• update - Update
• createPostgresql - Create (PostgreSQL)
• createClickhouse - Create (Clickhouse)
• createDragonfly - Create (DragonFly)
• createRedis - Create (Redis)
• createKeydb - Create (KeyDB)
• createMariadb - Create (MariaDB)
• createMysql - Create (MySQL)
• createMongodb - Create (MongoDB)
• start - Start
• stop - Stop
• restart - Restart

deployments

• list - List
• get - Get
• deployByTagOrUuid - Deploy

health

• check - Healthcheck

privateKeys

• list - List
• create - Create
• update - Update
• get - Get
• delete - Delete

projects

• list - List
• create - Create
• get - Get
• delete - Delete
• update - Update
• getEnvironment - Environment

resources

• list - List

servers

• list - List
• create - Create
• get - Get
• delete - Delete
• update - Update
• getResources - Resources
• getDomains - Domains
• validate - Validate

services

• list - List
• create - Create
• get - Get
• delete - Delete
• listEnvs - List Envs
• createEnv - Create Env
• updateEnv - Update Env
• updateEnvsBulk - Update Envs (Bulk)
• deleteEnv - Delete Env
• start - Start
• stop - Stop
• restart - Restart

teams

• list - List
• get - Get
• getMembers - Members
• getCurrent - Authenticated Team
• getCurrentMembers - Authenticated Team Members

version

• get - Version

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

• apiDisable - Disable API
• apiEnable - Enable API
• applicationsCreateDockerCompose - Create (Docker Compose)
• applicationsCreateDockerfile - Create (Dockerfile)
• applicationsCreateDockerImage - Create (Docker Image)
• applicationsCreateEnv - Create Env
• applicationsCreatePrivateDeployKey - Create (Private - Deploy Key)
• applicationsCreatePrivateGithubApp - Create (Private - GH App)
• applicationsCreatePublic - Create (Public)
• applicationsDelete - Delete
• applicationsDeleteEnv - Delete Env
• applicationsExecuteCommand - Execute Command
• applicationsGet - Get
• applicationsList - List
• applicationsListEnvs - List Envs
• applicationsRestart - Restart
• applicationsStart - Start
• applicationsStop - Stop
• applicationsUpdate - Update
• applicationsUpdateEnv - Update Env
• applicationsUpdateEnvsBulk - Update Envs (Bulk)
• databasesCreateClickhouse - Create (Clickhouse)
• databasesCreateDragonfly - Create (DragonFly)
• databasesCreateKeydb - Create (KeyDB)
• databasesCreateMariadb - Create (MariaDB)
• databasesCreateMongodb - Create (MongoDB)
• databasesCreateMysql - Create (MySQL)
• databasesCreatePostgresql - Create (PostgreSQL)
• databasesCreateRedis - Create (Redis)
• databasesDelete - Delete
• databasesGet - Get
• databasesList - List
• databasesRestart - Restart
• databasesStart - Start
• databasesStop - Stop
• databasesUpdate - Update
• deploymentsDeployByTagOrUuid - Deploy
• deploymentsGet - Get
• deploymentsList - List
• healthCheck - Healthcheck
• privateKeysCreate - Create
• privateKeysDelete - Delete
• privateKeysGet - Get
• privateKeysList - List
• privateKeysUpdate - Update
• projectsCreate - Create
• projectsDelete - Delete
• projectsGet - Get
• projectsGetEnvironment - Environment
• projectsList - List
• projectsUpdate - Update
• resourcesList - List
• serversCreate - Create
• serversDelete - Delete
• serversGet - Get
• serversGetDomains - Domains
• serversGetResources - Resources
• serversList - List
• serversUpdate - Update
• serversValidate - Validate
• servicesCreate - Create
• servicesCreateEnv - Create Env
• servicesDelete - Delete
• servicesDeleteEnv - Delete Env
• servicesGet - Get
• servicesList - List
• servicesListEnvs - List Envs
• servicesRestart - Restart
• servicesStart - Start
• servicesStop - Stop
• servicesUpdateEnv - Update Env
• servicesUpdateEnvsBulk - Update Envs (Bulk)
• teamsGet - Get
• teamsGetCurrent - Authenticated Team
• teamsGetCurrentMembers - Authenticated Team Members
• teamsGetMembers - Members
• teamsList - List
• versionGet - Version

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Coolify } from "coolify";

const coolify = new Coolify({
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await coolify.applications.list({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Coolify } from "coolify";

const coolify = new Coolify({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await coolify.applications.list();

  // Handle the result
  console.log(result);
}

run();

Error Handling

All SDK methods return a response object or throw an error. By default, an API error will throw a errors.APIError.

If a HTTP request fails, an operation my also throw an error from the models/errors/httpclienterrors.ts module:

HTTP Client Error	Description
RequestAbortedError	HTTP request was aborted by the client
RequestTimeoutError	HTTP request timed out due to an AbortSignal signal
ConnectionError	HTTP client was unable to make a request to a server
InvalidRequestError	Any input used to create a request is invalid
UnexpectedClientError	Unrecognised or unexpected error

In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the list method may throw the following errors:

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthenticated	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	*/*

import { Coolify } from "coolify";
import {
  BadRequest,
  InternalServerError,
  NotFound,
  RateLimited,
  SDKValidationError,
  Timeout,
  Unauthenticated,
} from "coolify/models/errors";

const coolify = new Coolify({
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

async function run() {
  let result;
  try {
    result = await coolify.applications.list();

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      case (err instanceof SDKValidationError): {
        // Validation errors can be pretty-printed
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof BadRequest): {
        // Handle err.data$: BadRequestData
        console.error(err);
        return;
      }
      case (err instanceof Unauthenticated): {
        // Handle err.data$: UnauthenticatedData
        console.error(err);
        return;
      }
      case (err instanceof NotFound): {
        // Handle err.data$: NotFoundData
        console.error(err);
        return;
      }
      case (err instanceof Timeout): {
        // Handle err.data$: TimeoutData
        console.error(err);
        return;
      }
      case (err instanceof RateLimited): {
        // Handle err.data$: RateLimitedData
        console.error(err);
        return;
      }
      case (err instanceof InternalServerError): {
        // Handle err.data$: InternalServerErrorData
        console.error(err);
        return;
      }
      default: {
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.

Server Selection

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Coolify } from "coolify";

const coolify = new Coolify({
  serverURL: "https://app.coolify.io/api/v1",
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await coolify.applications.list();

  // Handle the result
  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Coolify } from "coolify";
import { HTTPClient } from "coolify/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Coolify({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
bearerAuth	http	HTTP Bearer	COOLIFY_BEARER_AUTH

To authenticate with the API the bearerAuth parameter must be set when initializing the SDK client instance. For example:

import { Coolify } from "coolify";

const coolify = new Coolify({
  bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await coolify.applications.list();

  // Handle the result
  console.log(result);
}

run();

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Coolify } from "coolify";

const sdk = new Coolify({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable COOLIFY_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy