Quickstart

This guide takes you from a fresh dashboard account to a working authenticated request. If it returns your apps, your authentication is correct — and everything built on top of it (CI/CD, scripts, backend) works the same way.

Prerequisites

A Hyze Cloud account (sign up)
An API key (starts with hyze_) — if you don’t have one yet, follow the API keys guide

The API base URL is https://api.hyzecloud.com/api. Keep that prefix in every request.

Create the API key

Open the dashboard

Go to hyzecloud.com/dashboard and sign in.

Navigate to API Keys

Open Settings → Developer and click New key.

Copy the key

It starts with hyze_. Copy it — the full key is shown only once.

Make the first request

export HYZE_API_KEY="hyze_your_key"

curl https://api.hyzecloud.com/api/apps/ \
  -H "Authorization: Bearer $HYZE_API_KEY"

A JSON list of your workspace’s apps means authentication works.

With the SDK

npm install @hyzecloud/sdk

import { HyzeCloud } from "@hyzecloud/sdk";

const hyze = new HyzeCloud({ apiKey: process.env.HYZE_API_KEY });
const { apps } = await hyze.apps.list();
console.log(apps);

If something goes wrong

401 Unauthorized

The key wasn’t sent, is wrong/revoked, or the header doesn’t follow the Bearer hyze_... format. Check your HYZE_API_KEY value in the shell with echo $HYZE_API_KEY.

404 Not Found

You probably dropped the /api prefix from the base URL.

429 Too Many Requests

API rate limit. Respect the Retry-After header and retry after the indicated seconds.

Deploy an app

Publish from ZIP or GitHub.

Node.js SDK

Full SDK guide.

Provision a database

Create PostgreSQL, MySQL, MongoDB, or Redis.

API reference

Every endpoint.

Last modified on September 1, 2026

Get started

Prerequisites

Create the API key

Make the first request

With the SDK

If something goes wrong

Next

Deploy an app

Node.js SDK

Provision a database

API reference

​Prerequisites

​Create the API key

​Make the first request

​With the SDK

​If something goes wrong

​Next

Deploy an app

Node.js SDK

Provision a database

API reference

Prerequisites

Create the API key

Make the first request

With the SDK

If something goes wrong

Next