Skip to the page

Set the idle timeout, the longest session and recording (owners and admins)

PUT/v1/organisations/{id}/terminal/settings

Operation terminal.setSettings · since 2026-11-05 · stable

Needs a session withwritescopeAnswers200 OK

Path parameters

idstring (uuid)required
The organisation id.

Body (JSON)

Fields not listed here are refused.

idleMinutesinteger, 5 to 20optional
End a session idle this long.
maxHoursinteger, 1 to 8optional
The longest session.
recordingbooleanoptional
Record sessions.

Errors

Every error is { "error", "message", "detail"? } (Errors and references). Besides the codes any route can answer.

PUT/v1/organisations/{id}/terminal/settings
curl -X PUT "https://api.rykloud.com/v1/organisations/$ORG_ID/terminal/settings" \
  -H "Authorization: Bearer $RYKLOUD_TOKEN"