Websockets
TCP Proxy
Establish a WebSocket tunnel to a port inside the sprite environment.
WSS
/
v1
/
sprites
/
{name}
/
proxy
Messages
{
"host": "localhost",
"port": 5432
}"After init message, raw bytes flow directly: 0x47 0x45 0x54 0x20 0x2f ... (HTTP request 'GET /')""After init message, raw bytes flow directly: 0x47 0x45 0x54 0x20 0x2f ... (HTTP request 'GET /')"name
type:string
required
Sprite name within the organization.
bearerAuth
type:http
Sprites API token in the form <org>/<id>/<secret>, sent as Authorization: Bearer <token> on the upgrade request.
ProxyInitMessage
type:object
Raw TCP data forwarded without framing ((none))
type:string
Raw TCP data forwarded without framing
Raw TCP data forwarded without framing ((none))
type:string
Raw TCP data forwarded without framing
⌘I
Messages
{
"host": "localhost",
"port": 5432
}"After init message, raw bytes flow directly: 0x47 0x45 0x54 0x20 0x2f ... (HTTP request 'GET /')""After init message, raw bytes flow directly: 0x47 0x45 0x54 0x20 0x2f ... (HTTP request 'GET /')"