Remote Desktop Session icon

Remote Desktop Session

Manage Remote Desktop sessions - start, get info, or close

Start

AI-generated

Summary

Start a new remote desktop session via POST /sessions, optionally configuring retry behavior.

Inputs

  • options — Configuration options for the session start operation. If provided, its sub‑parameters are passed as the request body under a 'config' key; otherwise an empty object is sent.

Output shape

json

Returns the session object received from the Remote Desktop API after creating the session.

Examples

Example 1: Create a session with default retry settings

Leave the Options collection empty

Example 2: Create a session with custom retry limits and timeouts

Set Max Action Retries to 5, Retry Delay to 2 seconds, Action Timeout to 120 seconds

Discussion