Skip to main content
POST
Start Gateway

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Configuration for Gateway container deployment.

The Gateway always runs secured (TLS + mTLS); there is intentionally no dev_mode and no passphrase field (SEC-048):

  • A Gateway that holds wallet keys must never be served over plain HTTP, so the API does not support a dev/insecure mode.
  • The Gateway (v2.x) uses a single GATEWAY_PASSPHRASE for both TLS cert-key decryption and wallet encryption, and the shared mTLS cert set must be decryptable by this API's clients (which use CONFIG_PASSWORD). The passphrase is therefore always CONFIG_PASSWORD; a separate value would only break the API<->Gateway mTLS chain.
image
string
default:hummingbot/gateway:development

Docker image for Gateway

port
integer
default:15888

Port for Gateway API

Response

Successful Response