Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
serverName
string

Server Name

serverAliases
string

Aliases

listenPort
number

Listen Port

Required range: 1 <= x <= 65535
mode
enum<string>

Mode

Available options:
static,
proxy
documentRoot
string

Document Root

indexFiles
string

Index Files

proxyPass
string

Upstream URL

proxyWebsocket
boolean

Forward WebSocket headers (Upgrade / Connection)

enableSsl
boolean

Enable SSL (HTTPS)

sslCertificate
string

Certificate Path

sslCertificateKey
string

Private Key Path

http2
boolean

Enable HTTP/2

redirectHttp
boolean

Add HTTP → HTTPS redirect block

enableHsts
boolean

Send HSTS header (Strict-Transport-Security)

enableGzip
boolean

Enable gzip compression

clientMaxBodySize
string

Client Max Body Size

accessLog
string

Access Log

errorLog
string

Error Log

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.