Skip to main content
An API key is your credential to access Hyze Cloud. It identifies your workspace and authorizes every request to the API. Without a valid key, no call is accepted.

​
Create a key

1

Open the dashboard

Sign in at hyzecloud.com/dashboard.
2

Go to Settings → Developer

The panel lists every key in your workspace with its name, prefix (hyze_…), last used time, and creation date.
3

Click New key

Give it a name that identifies its use, such as CI/CD Production or Internal scripts.
4

Copy and store the secret

The full key is shown only once. Save it in a secrets manager or environment variable. If you lose it, you must revoke it and create a new one.
After creation, only the prefix (hyze_…) stays visible in the dashboard. Revoke any key that may have leaked immediately.

​
Authenticate a request

Send the key in the Authorization header with the Bearer scheme:
With the SDK, pass the key once at initialization:
The API base URL is https://api.hyzecloud.com/api. The same endpoint serves every environment — the workspace is determined by the key used in the request.

​
When something goes wrong

You get HTTP 401 when:
  • The key is missing from the Authorization header
  • The key is wrong or has been revoked
  • The header does not follow the Bearer hyze_... format

​
Best practices

  • Store keys in environment variables (HYZE_API_KEY), never in source code or client-side code
  • Use one key per environment or automation (CI, local, production tooling)
  • Use descriptive names — they show up in the list and help you revoke the right key
  • Revoke keys you no longer use

​
Manage keys through the API

Besides the dashboard, you can create, list, update, and revoke keys through the API keys endpoints.

​
Next steps

Quickstart

Validate your key with your first request.

Manage secrets

Store keys and settings as environment variables of your apps.

Workspaces

Understand how keys bind to your workspace.

Rate limits

API and public proxy limits.
Last modified on September 24, 2026