Skip to main content
POST
/
gateway
/
start
Start Gateway
curl --request POST \
  --url http://localhost:8000/gateway/start \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "passphrase": "<string>",
  "image": "hummingbot/gateway:latest",
  "port": 15888,
  "dev_mode": true
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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

passphrase
string
required

Gateway passphrase for configuration encryption

image
string
default:hummingbot/gateway:latest

Docker image for Gateway

port
integer
default:15888

Port for Gateway API

dev_mode
boolean
default:true

Enable development mode

Response

Successful Response