Skip to end of metadata
Go to start of metadata

Location 

There are two endpoints depending on which data center you are using. There are two data centers in Sauce Labs that support real devices: EU and US. Please use the endpoint associated to the data center you have an account in. 

Get Jobs

Get a list of jobs running on real devices

GET api.us-west-1.saucelabs.com/v1/rdc/jobs
GET api.eu-central-1.saucelabs.com/v1/rdc/jobs
curl -u USERNAME:ACCESS_KEY https://api.us-west-1.saucelabs.com/v1/rdc/jobs
curl -u USERNAME:ACCESS_KEY https://api.eu-central-1.saucelabs.com/v1/rdc/jobs
Parameters

limit

optional

positive integer, default 20, max 500

 Specifies the number of jobs to return

offset

optional

positive integer, default 1

Specifies the number of the first job to include; all preceding jobs will be skipped

 Click here to see a sample JSON response



RDC jobs list:

https://api.us-west-1.saucelabs.com/v1/rdc/jobs or https://api.eu-central-1.saucelabs.com/v1/rdc/jobs

{
    "entities": [
        {
            "assigned_tunnel_id": null,
            "device_type": "real_device",
            "owner_sauce": "maxmustermann",
            "consolidated_status": "complete",
            "end_time": 1551271288938,
            "id": "b7b24affb8bd4562b1a085677df83529",
            "name": "takeScreenshot",
            "os": "Android",
            "os_version": "7.0",
            "device_name": "Huawei Honor 8",
            "start_time": 1551271274593,
            "status": "complete",
            "creation_time": 1551271274593
        },
        {
            "assigned_tunnel_id": null,
            "device_type": "real_device",
            "owner_sauce": "maxmustermann",
            "consolidated_status": "complete",
            "end_time": 1551270267061,
            "id": "c63d5d051d3b47f8a5026b5595f01739",
            "name": "takeScreenshot",
            "os": "iOS",
            "os_version": "10.1.1",
            "device_name": "iPhone 5C",
            "start_time": 1551270206344,
            "status": "complete",
            "creation_time": 1551270206344
        },
        {
            "assigned_tunnel_id": null,
            "device_type": "real_device",
            "owner_sauce": "maxmustermann",
            "consolidated_status": "complete",
            "end_time": 1551269354340,
            "id": "774e5aab24264d72961484ed3d250dfb",
            "name": "takeScreenshot",
            "os": "Android",
            "os_version": "6.0",
            "device_name": "LG G Stylo",
            "start_time": 1551269315405,
            "status": "complete",
            "creation_time": 1551269315405
        },
        ...
    ],
    "metaData": {
        "offset": 1,
        "limit": 20,
        "searchTerm": null,
        "sortDirection": "DESCENDING",
        "moreAvailable": true
    }
}

Get Job

Get information about a single job

GET api.us-west-1.saucelabs.com/v1/rdc/jobs/[JOB_ID]
GET api.eu-central-1.saucelabs.com/v1/rdc/jobs/[JOB_ID]
Parameters

JOB_ID

required

string

The ID of the job you want information about


 Click here to see a sample JSON response
Single RDC job:

https://api.us-west-1.saucelabs.com/v1/rdc/jobs/b7b24affb8bd4562b1a085677df83529

{
    "assigned_tunnel_id": null,
    "device_type": "real_device",
    "owner_sauce": "maxmustermann",
    "automation_backend": "appium",
    "base_config": {},
    "build": null,
    "collects_automator_log": true,
    "consolidated_status": "complete",
    "creation_time": 1551271274593,
    "device_descriptor": {
        "id": "Huawei_Honor_8_real_us",
        "name": "Huawei Honor 8",
        "modelNumber": "FRD-L04",
        "manufacturer": [
            "Huawei"
        ],
        "isArm": true,
        "hasOnScreenButtons": true,
        "abiType": "arm64-v8a",
        "os": "ANDROID",
        "osVersion": "7.0",
        "apiLevel": 24,
        "screenSize": 5.2,
        "resolutionWidth": 1080,
        "resolutionHeight": 1920,
        "dpi": 423,
        "pixelsPerPoint": 1,
        "isTablet": false,
        "internalOrientation": "PORTRAIT",
        "defaultOrientation": "PORTRAIT",
        "ramSize": 4096,
        "internalStorageSize": 32768,
        "sdCardSize": 0,
        "cpuCores": 8,
        "cpuFrequency": 1805,
        "supportsMockLocations": true,
        "supportsAppiumWebAppTesting": true,
        "isKeyGuardDisabled": false,
        "isRooted": false,
        "isPrivate": false,
        "supportsGlobalProxy": true,
        "supportsMinicapSocketConnection": false,
        "disableMtp": false,
        "cpuType": "ARM",
        "deviceFamily": "ANY",
        "dpiName": "xxhdpi",
        "isAlternativeIoEnabled": true,
        "supportsQualityReport": true,
        "supportsManualWebTesting": true,
        "supportsXcuiTest": true,
        "supportsMultiTouch": true
    },
    "end_time": 1551271288938,
    "error": null,
    "id": "b7b24affb8bd4562b1a085677df83529",
    "framework_log_url": "https://api.us-west-1.saucelabs.com/v1/rdc/jobs/b7b24affb8bd4562b1a085677df83529/appiumLogs",
    "device_log_url": "https://api.us-west-1.saucelabs.com/v1/rdc/jobs/b7b24affb8bd4562b1a085677df83529/deviceLogs",
    "requests_url": "https://api.us-west-1.saucelabs.com/v1/rdc/jobs/b7b24affb8bd4562b1a085677df83529/appiumRequests",
    "manual": false,
    "modification_time": 1551271288938,
    "name": "takeScreenshot",
    "os": "Android",
    "os_version": "7.0",
    "device_name": "Huawei Honor 8",
    "passed": null,
    "proxied": false,
    "record_screenshots": true,
    "record_video": true,
    "start_time": 1551271274593,
    "status": "complete",
    "tags": [],
    "video_url": "https://api.us-west-1.saucelabs.com/v1/rdc/jobs/b7b24affb8bd4562b1a085677df83529/video.mp4",
    "remote_app_file_url": null
}
  • No labels