Network Throttling

Set a predefined network profile

Applies a predefined network profile (e.g. 2G, 4G-fast) to the device session. Profiles are mapped to network conditions internally—the resolved conditions are returned in the response. Use DELETE /sessions/{sessionId}/network/condition to reset.

post/sessions/{sessionId}/network/profile

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/network/profile/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

networkProfilestring required

The ID of the predefined network profile to apply.

Example request

{
  "networkProfile": "4G-fast"
}

Response

Network profile applied successfully

downloadSpeedinteger

Download speed in kbps (0 - 50000).

uploadSpeedinteger

Upload speed in kbps (0 - 50000).

latencyinteger

Latency in ms (0 - 3000).

lossinteger

Packet loss percentage (0 - 100).

Example response

{
  "downloadSpeed": 5000,
  "uploadSpeed": 3000,
  "latency": 200,
  "loss": 2
}

Changes

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