ports

Open a public TCP port to a port of a sandbox: a database, a game server, anything that is not HTTP.

Returns address:publicPort. Raw TCP, carried as it is; use your service's own authentication and TLS. Needs a kept top-up; at most 5 per sandbox and 20 per organization. Calling it again for the same sandbox and port returns the same public port.

post/v1/ports

Request

  • Base URL: https://api.withruntime.com
  • URL: https://api.withruntime.com/v1/ports
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Replaying the same key with the same request within 24 hours returns the first result and never repeats the effect. A refusal is not kept: a request refused before it ran (no_capacity, busy, a limit) runs afresh when sent again with its key. The SDKs send one automatically; the server makes one when absent and returns it in the idempotency-key response header.

Request body

sandboxIdstring required

The sandbox that serves it.

portinteger required

The port your server listens on inside the sandbox.

Response

Success

idstring
sandboxIdstring
addressstring

The public address to connect to.

publicPortinteger
connectstring

address:publicPort, for a client's host and port.

protocolstring

tcp. UDP is not carried.

disabledboolean
createdAtstring date-time
hintstring

Changes

No recorded changes to this operation across all 1 revision of this API.