Skip to main content

Get a single session

GET/vm/<session_id>

cURL#

curl -H 'Authorization: Bearer <your-api-key>' \    https://engine.hyperbeam.com/v0/vm/<session_id>

Example response#

{  "session_id": "c5772689-2255-4e59-8cea-b846cda7ad4e",  "embed_url": "https://96xljbfypmn3ibra366yqapci.hyperbeam.com/AAEjQFOIRnyeb81XbBsHMw?token=VTWsp1KGn4lLySRkUCmmAhsCcqJrPdhTXNS0Y-KPwHU",  "admin_token": "DrXWd9QguPRSXwhQn4yJ66sExpoV0BZtAfZsseYECKo",  "termination_date": null}

Response body#

PropertyTypeDescription
session_idstringThe ID of the cloud computer session
embed_urlstringA URL you can load into an iframe on your website
admin_tokenstringA token that grants access to the cloud computer API and an exclusive subset of the client-side iframe API. Needed for setting permissions and programmatic control.
termination_datestring or nullThe termination time of the cloud computer session. Formatted according to RFC3339 (e.g. 2006-01-02T15:04:05Z07:00). null if the session hasn’t terminated yet.