Update Scheduled Access Timeslot

put

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

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

scheduled_access_id

integer

required

Scheduled access ID.

integer

required

Timeslot ID.

Body Params

name

string

required

String Timeslot name

rrule

string

required

String Recurrence rule (iCalendar RRULE format). Must be valid according to RFC 5545. Weekly types must include days

start_date

string

required

Timeslot start date (Format: YYYY-MM-DD)

end_date

string

required

Timeslot end date (Format: YYYY-MM-DD)

start_time

string

required

Start time (Format: HH:MM:SS)

end_time

string

required

End time (Format: HH:MM:SS). Must be after start_time

timeslot_type

string

required

Type of timeslot. Allowed values: "once", "daily", "weekly". The type and rrule must match.

force_disconn

boolean

(Optional) Boolean Force disconnect user when time expires

warn_time_left

integer

(Optional) Integer Warning time before disconnect (seconds, range: 0-600)

idle_time

integer

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

lock_screen_intentional

integer

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

lock_screen_unintentional

integer

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

exclusive_mode

boolean

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

enabled_idle_time

boolean

(Optional) Boolean Enable idle time check

enabled_lock_screen_intentional

boolean

(Optional) Boolean Enable lock screen for intentional disconnects

enabled_lock_screen_unintentional

boolean

(Optional) Boolean Enable lock screen for unintentional disconnects

blank_screen

boolean

(Optional) Boolean Blank screen when in a session

lock_km

boolean

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

connection_pool

boolean

(Optional) Boolean Enable connection pool for this timeslot

multiple_session_limit

integer

(Optional) Integer Multiple session limit for connection pool

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.

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response