Device Interactions

Change device configuration

Changes device settings such as orientation, locale, or animations during an active session. The request body must contain at least one of the properties below. Note: Some settings are OS-specific. Please review the parameter descriptions for details.

post/sessions/{sessionId}/device/applySettings

Request

Base URL
https://api.us-west-1.saucelabs.com/rdc/v2
Auth
HTTP basic
TypeScript
https://skmtc.dev/saucelabs/apis/real-device-access-api-reference/docs/sessions/:sessionId/device/applySettings/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

sessionIdstring required

The id of the device session

Request body

orientation'PORTRAIT' | 'LANDSCAPE'

The desired screen orientation. Supported on both Android and iOS.

localestring

Android only. Sets the system-wide language and country (IETF BCP 47 format, e.g., 'en-US', 'fr-CA'). Not supported on iOS because changing locale requires a device reboot, which is not supported during an active session.

animationsboolean

Android only. Enable or disable system animations to improve test stability and speed.

Example request

{
  "orientation": "PORTRAIT",
  "locale": "en_US"
}

Response

Command executed successfully

Changes

No recorded changes to this operation across all 1 revision of this API.