Start a remote control session
POST/devices/:id/remote-control
Mints a short-lived viewer token for one device and returns the URL to frame.
The returned embed_url already carries the token in its fragment, so frame it exactly as returned. The token is scoped to this one device, expires at expires_at, and is safe to hand to a browser; the API key that minted it is not.
The page that frames the viewer must be served from an origin registered on the enterprise's embed origin list, otherwise the browser refuses the frame before the viewer runs. See GET and PUT /enterprise/embed-origins.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 500
Session created; frame embed_url
Device ID is not a valid identifier
Authentication required
Remote control is not available for this enterprise
Device not found
The remote control agent has not registered this device
Remote control is not configured for this enterprise