Proxy Endpoint

POST

/production/proxy

Authorizations

• User Key

Request Body ^required

WebsocketUserRequest

This is the request generated internally by the /proxy endpoint.

object

tenant_id

required

Tenant Id

string

node_id

required

Node Id

string

http

required

ProxiedHttpRequest

object

path

required

Path

string

method

required

Method

string

Allowed values: GET POST DELETE PUT HEAD PATCH

api_version

Api Version

integer

body_json

Any of:

object

object

null

null

message_type

Message Type

string

default: user-request

request_id

required

Request Id

string

large_payload_destination

required

LargePayloadDestination

object

type

required

Type

string

url

required

Url

string

threshold_bytes

Threshold Bytes

integer

default: 8388608

Responses

200

Successful Response

WebsocketUserResponse

This is the response returned to the /proxy endpoint handler

object

message_type

Message Type

string

default: user-response

request_id

required

Request Id

string

payload_location

Any of:

PayloadLocation

PayloadLocation

string

Allowed values: inline external

null

null

http

Any of:

ProxiedHttpResponse

ProxiedHttpResponse

object

code

required

Code

integer

body_json

Any of:

object

object

null

null

null

null

403

{"detail": "Invalid API Key"}

404

{"detail": "Tenant not found"} {"detail": "Node not found"}

408

{"detail": "Proxy timed out"}

410

{"detail": "Node not connected"}

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string