websocket

Attach a websocket

If the nodeName query parameter is present, the request will be proxied to the underlying agent environment(endpoint). If the nodeName query parameter is not specified, the request will be upgraded to the websocket protocol and an AttachStart operation HTTP request will be created and hijacked. Access policy: authenticated

get/websocket/attach

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/websocket/attach
  • Auth
    • API key in header X-API-KEY
    • or API key in header Authorization

Query parameters

endpointIdinteger required

environment(endpoint) ID of the environment(endpoint) where the resource is located

nodeNamestring

node name

Response

OK

Changes

No recorded changes to this operation across all 21 revisions of this API.