Introduction

Create, read, update, and delete configurations, servers, and tweaks in your panel using your account’s API key. No panel login session is required.

Choose your API

Client and Business API credentials are separate. Both are intended for your backend or trusted automation. Each has its own account page, quota, and authentication checks.

Three building blocks

Configuration — A saved panel record containing servers, tweaks, a message, and access settings. Configurations.

Server — where the connection goes. It defines a tunnel, a carrier, connection settings such as an endpoint and credentials, and the method combinations it accepts.

Tweak — how the app reaches that server. It selects compatible tunnels and provides methods such as a payload, TLS, or a proxy. The app selects a server and a tweak together. Even direct SSH uses a tweak with an empty methods object.

The connection format explains how these pieces fit together. You do not need every optional setting to make your first request.

What happens to your data?

Create, read, update, and delete configurations, servers, and tweaks in your panel using your account’s API key. No panel login session is required.

The Business API builds a configuration in memory and returns importable text. It does not add a configuration, server, or tweak to your panel. Optional cloud delivery stores a share, and Cloud Protect stores material needed to open the protected export. See delivery options.

Read these docs in order

1. Make your first request with a Client API key, or follow the Business API guide.
2. Use the focused resource pages when you need servers, tweaks, or cloud access.
3. Choose a complete payload from connection examples.
4. Use responses, errors & limits when a request fails.

All examples describe the current public JSON format. Hostnames and credentials in examples are placeholders; replace them with your own server details.