Device Catalog
List the status of all devices
Lists the current status of all devices. For private devices, additional details are available, including the precise state and current user. The delay of this state is < 1s.
get/devices/status
Request
- Base URLhttps://api.us-west-1.saucelabs.com/rdc/v2
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
state'AVAILABLE' | 'IN_USE' | 'CLEANING' | 'REBOOTING' | 'MAINTENANCE' | 'OFFLINE'
Current device state. Private devices show specific states; public devices show aggregated states. If any device sharing a descriptorId is available, the descriptor is marked as available.
Example:IN_USE
Filter by device state
privateOnlyboolean
Show only private devices for the authenticated customer
deviceNamestring
Example:iPhone.*
Filter by device identifier (supports regex). Matches both descriptor and deviceName fields.
Response
Ok
Example response
{
"devices": [
{
"descriptor": "iPhone_13_real",
"isPrivateDevice": true,
"state": "IN_USE",
"inUseBy": [
{
"username": "john.smith"
}
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.