Create New Scheduled Access

post

https://webapi.splashtop.com/api/open/v1/teams/{team_id}/scheduled_access

Creates new scheduled access.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

team_id

integer

required

ID of Splashtop team. It is one team at a time you can query Body

Body Params

name

string

required

Required Name of the new scheduled access

description

string

(Optional) Scheduled access description

warn_time_left

integer

(Optional) Integer Warning time in seconds before disconnect

support_connection_pool

boolean

(Optional) Boolean Support connection pool for schedules

template_connection_pool

boolean

(Optional) Boolean Set the schedule as connection pool (default setting)

template_multiple_session_limit

integer

(Optional) Integer Multiple session limit for connection pool

support_exclusive_mode

boolean

(Optional) Boolean Support exclusive (remote or local) access for member accounts

template_exclusive_mode

boolean

(Optional) Boolean Prevent member from accessing a computer which has already been logged in (default setting)

template_idle_time

integer

required

Required Integer Allow access to a computer with a logged user, if idle for more than (seconds, range: 300-900)

template_lock_km

boolean

(Optional) Boolean Lock keyboard and mouse when in a session

template_lock_screen_intentional

integer

(Optional) Integer Log out a user on a disconnect (seconds, range: 0-300)

template_enabled_lock_screen_intentional

boolean

(Optional) Boolean Enable lock screen for intentional disconnects

template_lock_screen_unintentional

integer

(Optional) Integer Lock screen before user logout for unintentional disconnects (seconds, range: 0-300)

template_enabled_lock_screen_unintentional

boolean

(Optional) Boolean Enable lock screen for unintentional disconnects (default setting)

force_disconnect

string

Force disconnect user when time expires.

template_blank_screen

boolean

(Optional) Boolean Blank screen when in session (default setting)

template_enabled_idle_time

boolean

(Optional) Boolean Enable idle time check (default setting)

Responses

400

Bad request — invalid parameters

401

Unauthorized — invalid or missing access token

403

Forbidden — insufficient scope, or the action/value/target is not allowed. See data.error for the sub-reason.

200Successful response