Sauce Labs REST APIs

https://docs.saucelabs.com/dev/api
Admin
Sauce Labs REST APIs provide endpoints to programmatically perform operations, manage accounts, and...
Tokens:50,520
Snippets:161
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### 400 Missing Required Parameter JSON Error Response Example

Source: https://docs.saucelabs.com/dev/api/index

This JSON example demonstrates an error response for a 400 Bad Request, specifically indicating a missing required parameter. The response details which field is missing and why, helping developers correct their API requests.

```json
{
"verify_password": ["This field is required."]
}

```

--------------------------------

### Authenticate GET Request with Curl (Header)

Source: https://docs.saucelabs.com/dev/api/index

Demonstrates authenticating a GET request to the Sauce Labs API using curl by passing credentials in the Authorization header. This example fetches user data and assumes environment variables for username and access key are configured.

```curl
curl -L -X GET 'https://api.us-west-1.saucelabs.com/team-management/v1/users/' \
-u $SAUCE_USERNAME:$SAUCE_ACCESS_KEY  

```

--------------------------------

### HTTP Methods

Source: https://docs.saucelabs.com/dev/api/index

Overview of supported HTTP methods for API requests. Unspecified method requests default to GET. Other methods require the `Content-Type` header.

```APIDOC
## Methods

### Description
Details on supported HTTP methods for API requests.

### Supported Methods
- `GET` (Default if unspecified)
- `PUT`
- `POST`
- `DELETE`
- `PATCH`

### Request Header Requirement
For `PUT`, `POST`, `DELETE`, and `PATCH` requests, the `Content-Type` header must be set to `application/json`.
```

--------------------------------

### Get Sauce Connect Download Information

Source: https://docs.saucelabs.com/dev/api/connect

Retrieves download URLs and SHA1 hashes for different versions and platforms of Sauce Connect.

```APIDOC
## GET /websites/saucelabs_dev_api

### Description
Retrieves download information for Sauce Connect, including download URLs and SHA1 hashes for various versions and operating systems. Supports filtering by client host and client version.

### Method
GET

### Endpoint
/websites/saucelabs_dev_api

### Query Parameters
- **client_host** (string) - Optional - The target host platform (e.g., "linux", "osx", "win32").
- **client_version** (string) - Optional - The specific version of Sauce Connect to retrieve information for.

### Response
#### Success Response (200)
- **latest_version** (string) - The latest available version of Sauce Connect.
- **info_url** (string) - A URL providing more information about Sauce Connect installation.
- **downloads** (object) - An object containing download details for different platforms.
  - **download_url** (string) - The direct download URL for the Sauce Connect executable.
  - **sha1** (string) - The SHA1 hash of the downloaded file.
- **warning** (array) - An array of warning messages, if any.

#### Response Example (with client_host=linux)
```json
{
  "download_url": "https://saucelabs.com/downloads/sc-4.9.2-linux.tar.gz",
  "downloads": {
    "linux": {
      "download_url": "https://saucelabs.com/downloads/sc-4.9.2-linux.tar.gz",
      "sha1": "<hash>"
    },
    "linux-arm64": {
      "download_url": "https://saucelabs.com/downloads/sc-4.9.2-linux-arm64.tar.gz",
      "sha1": "<hash>"
    },
    "win32": {
      "download_url": "https://saucelabs.com/downloads/sc-4.9.2-win32.zip",
      "sha1": "<hash>"
    }
  },
  "info_url": "https://docs.saucelabs.com/secure-connections/sauce-connect-4/installation",
  "latest_version": "4.9.2",
  "sha1": "<hash>"
}
```

#### Response Example (with client_version=4.7.1)
```json
{
  "client_version": "4.7.1",
  "downloads": {
    "linux": {
      "download_url": "https://saucelabs.com/downloads/sc-4.9.2-linux.tar.gz",
      "sha1": "<hash>"
    },
    "linux-arm64": {
      "download_url": "https://saucelabs.com/downloads/sc-4.9.2-linux-arm64.tar.gz",
      "sha1": "<hash>"
    },
    "win32": {
      "download_url": "https://saucelabs.com/downloads/sc-4.9.2-win32.zip",
      "sha1": "<hash>"
    }
  },
  "info_url": "https://docs.saucelabs.com/secure-connections/sauce-connect-4/installation",
  "latest_version": "4.9.2",
  "status": "UPGRADE",
  "warning": [
    "Client host platform is not specified, the download URL cannot be determined"
  ]
}
```
```

--------------------------------

### Authenticate GET Request with Curl (US West)

Source: https://docs.saucelabs.com/dev/api/index

Example of how to authenticate a GET request to the Sauce Labs API using curl with username and access key. It targets the US West data center and the team management endpoint. Ensure SAUCE_USERNAME and SAUCE_ACCESS_KEY environment variables are set.

```curl
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.us-west-1.saucelabs.com/team-management/v1/teams'  

```

--------------------------------

### GET /websites/saucelabs_dev_api

Source: https://docs.saucelabs.com/dev/api/connect

Retrieves information about Sauce Connect downloads. By default, it returns the latest stable version's download links. An optional 'all=true' query parameter can be used to retrieve download links for all available versions.

```APIDOC
## GET /websites/saucelabs_dev_api

### Description
Retrieves information about Sauce Connect downloads, including download URLs and SHA1 hashes for different operating systems.

### Method
GET

### Endpoint
/websites/saucelabs_dev_api

### Query Parameters
- **all** (boolean) - Optional - If set to `true`, returns download information for all available Sauce Connect versions. Otherwise, returns only the latest stable version.

### Request Example
```
GET /websites/saucelabs_dev_api?all=true
```

### Response
#### Success Response (200)
- **downloads** (object) - Contains download information for the latest version. 
  - **linux** (object) - Download details for Linux.
    - **download_url** (string) - The URL to download the Sauce Connect executable for Linux.
    - **sha1** (string) - The SHA1 hash of the Linux download file.
  - **linux-arm64** (object) - Download details for Linux ARM64.
    - **download_url** (string) - The URL to download the Sauce Connect executable for Linux ARM64.
    - **sha1** (string) - The SHA1 hash of the Linux ARM64 download file.
  - **osx** (object) - Download details for macOS.
    - **download_url** (string) - The URL to download the Sauce Connect executable for macOS.
    - **sha1** (string) - The SHA1 hash of the macOS download file.
  - **win32** (object) - Download details for Windows 32-bit.
    - **download_url** (string) - The URL to download the Sauce Connect executable for Windows 32-bit.
    - **sha1** (string) - The SHA1 hash of the Windows 32-bit download file.
- **all_downloads** (object) - (Only present if `all=true` is specified) Contains download information for all available Sauce Connect versions.
  - **[version_number]** (object) - An object where the key is the Sauce Connect version number (e.g., "4.7.0").
    - **linux** (object) - Download details for Linux for this version.
    - **linux-arm64** (object) - Download details for Linux ARM64 for this version.
    - **osx** (object) - Download details for macOS for this version.
    - **win32** (object) - Download details for Windows 32-bit for this version.
- **info_url** (string) - A URL to the official documentation for Sauce Connect installation.
- **latest_version** (string) - The latest stable version number of Sauce Connect.
- **warning** (array) - An array of warning messages, if any.

#### Response Example (Default)
```json
{
   "downloads" : {
      "linux" : {
         "download_url" : "https://saucelabs.com/downloads/sc-4.9.2-linux.tar.gz",
         "sha1" : "<hash>"
      },
      "linux-arm64" : {
         "download_url" : "https://saucelabs.com/downloads/sc-4.9.2-linux-arm64.tar.gz",
         "sha1" : "<hash>"
      },
      "osx" : {
         "download_url" : "https://saucelabs.com/downloads/sc-4.9.2-osx.zip",
         "sha1" : "<hash>"
      },
      "win32" : {
         "download_url" : "https://saucelabs.com/downloads/sc-4.9.2-win32.zip",
         "sha1" : "<hash>"
      }
   },
   "info_url" : "https://docs.saucelabs.com/secure-connections/sauce-connect-4/installation",
   "latest_version" : "4.9.2",
   "warning" : [
      "Client host platform is not specified, the download URL cannot be determined"
   ]
}
```

#### Response Example (with `all=true`)
```json
{
   "all_downloads" : {
      "4.7.0" : {
         "linux" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.7.0-linux.tar.gz",
            "sha1" : "<hash>"
         },
         "osx" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.7.0-osx.zip",
            "sha1" : "<hash>"
         }
      },
      "4.7.1" : {
         "linux" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.7.1-linux.tar.gz",
            "sha1" : "<hash>"
         },
         "linux-arm64" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.7.1-linux-arm64.tar.gz",
            "sha1" : "<hash>"
         },
         "osx" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.7.1-osx.zip",
            "sha1" : "<hash>"
         },
         "win32" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.7.1-win32.zip",
            "sha1" : "<hash>"
         }
      }
   },
   "info_url" : "https://docs.saucelabs.com/secure-connections/sauce-connect-4/installation",
   "latest_version" : "4.9.2"
}
```

#### Error Response (404)
Not found.

```

--------------------------------

### Get Tunnel Version Downloads - EU-Central Sample Request

Source: https://docs.saucelabs.com/dev/api/connect

This `curl` command illustrates fetching tunnel version download information from the EU-Central region of the Sauce Labs API. It requires valid authentication credentials.

```bash
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.eu-central-1.saucelabs.com/rest/v1/public/tunnels/info/versions' | json_pp
```

--------------------------------

### Get All Screenshots

Source: https://docs.saucelabs.com/dev/api/jobs

Retrieves all screenshot files for a specified job and downloads them as a single ZIP file. Use the --output flag to specify a local directory for download.

```APIDOC
## GET /rest/v1/{username}/jobs/{job_id}/assets/screenshots.zip

### Description
Retrieves all of the screenshot files for the specified job and downloads them as a single ZIP file. Use the `--output <filepath>` cURL flag, as shown in the request samples, to download to a local directory.

### Method
GET

### Endpoint
`/rest/v1/{username}/jobs/{job_id}/assets/screenshots.zip`

### Parameters
#### Path Parameters
- **username** (string) - Required - The username of the owner of the job. You can look up Sauce Labs users in your organization using the Lookup Users endpoint.
- **job_id** (string) - Required - The Sauce Labs identifier of the job for which you are retrieving the asset list. You can look up job IDs using the Get Jobs endpoint.

### Request Example
```bash
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.us-west-1.saucelabs.com/rest/v1/nancy.sweeney/jobs/bc3d1dbd96fd4479925f2afa8efbc090/assets/screenshots.zip' --output './screenshots.zip'
```

```bash
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.eu-central-1.saucelabs.com/rest/v1/nancy.sweeney/jobs/bc3d1dbd96fd4479925f2afa8efbc090/assets/screenshots.zip' --output './screenshots.zip'
```

### Response
#### Success Response (200)
Success. Screenshots are downloaded to the specified output location.

#### Response Example
```
% Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                               Dload  Upload   Total   Spent    Left  Speed
100     9    0     9    0     0     18      0 --:--:-- --:--:-- --:--:--    18
```
```

--------------------------------

### Sample Success Response for Reset Service Account Access Key

Source: https://docs.saucelabs.com/dev/api/accounts

Provides an example of a successful response when an access key for a service account is reset. The response contains the newly generated access key.

```json
{
  "access_key": "3f78c473-3396-432d-b6d1-48e2dd7c57b1"
}
```

--------------------------------

### Get Tunnel Version Downloads - Sample Response

Source: https://docs.saucelabs.com/dev/api/connect

This is a sample JSON response for a successful request to retrieve tunnel version download information. It includes details about the tunnel owner, creation time, status, and host.

```json
{
    "owner": "jim.smith",
    "team_ids": [...],
    "creation_time": 1618345938,
    "domain_names": null,
    "id": "28e7c8133ede4588a891666dd35af1f8",
    "extra_info": "{…}",
    "direct_domains": null,
    "vm_version": "",
    "no_ssl_bump_domains": null,
    "shared_tunnel": false,
    "metadata": {...},
    "status": "running",
    "is_ready": true,
    "shutdown_reason": null,
    "shutdown_time": null,
    "user_shutdown": null,
    "host": "maki3429.miso.saucelabs.com",
    "ip_address": null,
    "last_connected": 1618346660,
    "launch_time": 1618345940,
    "tunnel_identifier": "jim.smith_tunnel_id"
}
```

--------------------------------

### Get User Concurrency

Source: https://docs.saucelabs.com/dev/api/accounts

Retrieves details about current in-use virtual machines and real devices, along with maximum allowed values for a given user.

```APIDOC
## GET /rest/v1.2/users/{username}/concurrency

### Description
Returns details about the current in-use virtual machines and real devices along with the maximum allowed values for a user.

### Method
GET

### Endpoint
`/rest/v1.2/users/{username}/concurrency`

### Parameters
#### Path Parameters
- **username** (STRING) - Required - The username of the user whose concurrency details are to be retrieved.

### Note on Real Devices
At this time, the current usage for real devices is not accurately returned in the response. As a workaround, use the following endpoint:
`curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location --request GET 'https://api.us-west-1.saucelabs.com/v1/rdc/concurrency' --header 'Content-Type: application/json' | json_pp`
```

--------------------------------

### Get Builds List (EU)

Source: https://docs.saucelabs.com/dev/api/jobs

Retrieves a list of recent builds for a specified user in the EU region. Requires the username as a path parameter. Returns a JSON array of build objects.

```curl
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.eu-central-1.saucelabs.com/rest/v1/jsmith/builds' | json_pp
```

--------------------------------

### Get Builds List (US)

Source: https://docs.saucelabs.com/dev/api/jobs

Retrieves a list of recent builds for a specified user in the US region. Requires the username as a path parameter. Returns a JSON array of build objects.

```curl
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.us-west-1.saucelabs.com/rest/v1/jsmith/builds' | json_pp
```

--------------------------------

### Get Tunnel Version Downloads

Source: https://docs.saucelabs.com/dev/api/connect

Retrieves download information for Sauce Connect tunnel versions. You can filter by client version, client host, or retrieve all available versions.

```APIDOC
## GET /rest/v1/public/tunnels/info/versions

### Description
Returns tunnel version download information.

### Method
GET

### Endpoint
/rest/v1/public/tunnels/info/versions

### Parameters
#### Query Parameters
- **client_version** (STRING) - Optional - Returns download information for the specified Sauce Connect client version (For example, `4.7.1`).
- **client_host** (STRING) - Optional - Returns download information for the Sauce Connect Proxy version with the specified host OS and CPU Architecture (For example, `darwin-amd64`).
- **all** (BOOLEAN) - Optional - Set to `true` to return download information for all available Sauce Connect Proxy versions. Defaults to `false`.

### Request Example
```bash
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.us-west-1.saucelabs.com/rest/v1/public/tunnels/info/versions' | json_pp
```
```bash
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.us-east-4.saucelabs.com/rest/v1/public/tunnels/info/versions' | json_pp
```
```bash
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.eu-central-1.saucelabs.com/rest/v1/public/tunnels/info/versions' | json_pp
```

### Response
#### Success Response (200)
- **owner** (STRING) - The owner of the tunnel.
- **team_ids** (ARRAY) - A list of team IDs associated with the tunnel.
- **creation_time** (INTEGER) - The timestamp when the tunnel was created.
- **domain_names** (null) - Domain names associated with the tunnel (currently null).
- **id** (STRING) - The unique identifier of the tunnel.
- **extra_info** (STRING) - Additional information about the tunnel.
- **direct_domains** (null) - Direct domains associated with the tunnel (currently null).
- **vm_version** (STRING) - The version of the virtual machine used by the tunnel.
- **no_ssl_bump_domains** (null) - Domains where SSL bumping is disabled (currently null).
- **shared_tunnel** (BOOLEAN) - Indicates if the tunnel is shared.
- **metadata** (OBJECT) - Metadata associated with the tunnel.
- **status** (STRING) - The current status of the tunnel (e.g., "running").
- **is_ready** (BOOLEAN) - Indicates if the tunnel is ready for use.
- **shutdown_reason** (null) - The reason for tunnel shutdown (currently null).
- **shutdown_time** (null) - The time when the tunnel was shut down (currently null).
- **user_shutdown** (null) - Indicates if the tunnel was shut down by the user (currently null).
- **host** (STRING) - The hostname of the tunnel server.
- **ip_address** (null) - The IP address of the tunnel server (currently null).
- **last_connected** (INTEGER) - The timestamp of the last connection to the tunnel.
- **launch_time** (INTEGER) - The timestamp when the tunnel was launched.
- **tunnel_identifier** (STRING) - The identifier of the tunnel.

#### Response Example
```json
{
    "owner": "jim.smith",
    "team_ids": [],
    "creation_time": 1618345938,
    "domain_names": null,
    "id": "28e7c8133ede4588a891666dd35af1f8",
    "extra_info": "{…}",
    "direct_domains": null,
    "vm_version": "",
    "no_ssl_bump_domains": null,
    "shared_tunnel": false,
    "metadata": {},
    "status": "running",
    "is_ready": true,
    "shutdown_reason": null,
    "shutdown_time": null,
    "user_shutdown": null,
    "host": "maki3429.miso.saucelabs.com",
    "ip_address": null,
    "last_connected": 1618346660,
    "launch_time": 1618345940,
    "tunnel_identifier": "jim.smith_tunnel_id"
}
```
```

--------------------------------

### Get All Screenshots for a Job (EU Region)

Source: https://docs.saucelabs.com/dev/api/jobs

Retrieves all screenshot files for a specified job in the EU region and downloads them as a single ZIP file. Requires username and job ID. The output path for the downloaded ZIP file must be specified.

```curl
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.eu-central-1.saucelabs.com/rest/v1/nancy.sweeney/jobs/bc3d1dbd96fd4479925f2afa8efbc090/assets/screenshots.zip' --output './screenshots.zip'
```

--------------------------------

### Get Tunnel Version Downloads - US-West Sample Request

Source: https://docs.saucelabs.com/dev/api/connect

This `curl` command demonstrates how to request tunnel version download information from the US-West region of the Sauce Labs API. It requires authentication with username and access key.

```bash
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.us-west-1.saucelabs.com/rest/v1/public/tunnels/info/versions' | json_pp
```

--------------------------------

### 404 Not Found HTML Error Response Example

Source: https://docs.saucelabs.com/dev/api/index

This snippet shows a typical HTML response for a 404 Not Found error, often encountered when there's a typo in the request URL. It provides a basic structure for informing the user that the resource could not be located on the server.

```html
<!doctype html>
<html lang="en">

<head>
	<title>Not Found</title>
</head>

<body>
	<h1>Not Found</h1>
	<p>The requested resource was not found on this server.</p>
</body>

</html>

```

--------------------------------

### Get All Screenshots for a Job (US Region)

Source: https://docs.saucelabs.com/dev/api/jobs

Retrieves all screenshot files for a specified job in the US region and downloads them as a single ZIP file. Requires username and job ID. The output path for the downloaded ZIP file must be specified.

```curl
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.us-west-1.saucelabs.com/rest/v1/nancy.sweeney/jobs/bc3d1dbd96fd4479925f2afa8efbc090/assets/screenshots.zip' --output './screenshots.zip'
```

--------------------------------

### Get Tunnel Version Downloads - US-East Sample Request

Source: https://docs.saucelabs.com/dev/api/connect

This `curl` command shows how to retrieve tunnel version download information from the US-East region of the Sauce Labs API. Ensure you have your Sauce Labs username and access key configured.

```bash
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.us-east-4.saucelabs.com/rest/v1/public/tunnels/info/versions' | json_pp
```

--------------------------------

### Sauce Connect Download Info - All Versions (all=true)

Source: https://docs.saucelabs.com/dev/api/connect

This JSON object represents the response when the `all=true` parameter is used in a Sauce Connect download request. It provides download URLs and SHA1 hashes for multiple versions of Sauce Connect, categorized by version number and then by operating system.

```json
{
   "all_downloads" : {
      "4.7.0" : {
         "linux" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.7.0-linux.tar.gz",
            "sha1" : "<hash>"
         },
         "osx" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.7.0-osx.zip",
            "sha1" : "<hash>"
         }
      },
      "4.7.1" : {
         "linux" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.7.1-linux.tar.gz",
            "sha1" : "<hash>"
         },
         "linux-arm64" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.7.1-linux-arm64.tar.gz",
            "sha1" : "<hash>"
         },
         "osx" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.7.1-osx.zip",
            "sha1" : "<hash>"
         },
         "win32" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.7.1-win32.zip",
            "sha1" : "<hash>"
         }
      },
      "4.8.0" : {
         "linux" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.8.0-linux.tar.gz",
            "sha1" : "<hash>"
         },
         "linux-arm64" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.8.0-linux-arm64.tar.gz",
            "sha1" : "<hash>"
         },
         "osx" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.8.0-osx.zip",
            "sha1" : "<hash>"
         },
         "win32" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.8.0-win32.zip",
            "sha1" : "<hash>"
         }
      },
      "4.8.1" : {
         "linux" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.8.1-linux.tar.gz",
            "sha1" : "<hash>"
         },
         "linux-arm64" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.8.1-linux-arm64.tar.gz",
            "sha1" : "<hash>"
         },
         "osx" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.8.1-osx.zip",
            "sha1" : "<hash>"
         },
         "win32" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.8.1-win32.zip",
            "sha1" : "<hash>"
         }
      },
      "4.8.2" : {
         "linux" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.8.2-linux.tar.gz",
            "sha1" : "<hash>"
         },
         "linux-arm64" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.8.2-linux-arm64.tar.gz",
            "sha1" : "<hash>"
         },
         "osx" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.8.2-osx.zip",
            "sha1" : "<hash>"
         },
         "win32" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.8.2-win32.zip",
            "sha1" : "<hash>"
         }
      },
      "4.9.0" : {
         "linux" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.9.0-linux.tar.gz",
            "sha1" : "<hash>"
         },
         "linux-arm64" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.9.0-linux-arm64.tar.gz",
            "sha1" : "<hash>"
         },
         "osx" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.9.0-osx.zip",
            "sha1" : "<hash>"
         },
         "win32" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.9.0-win32.zip",
            "sha1" : "<hash>"
         }
      },
      "4.9.1" : {
         "linux" : {
            "download_url" : "https://saucelabs.com/downloads/sc-4.9.1-linux.tar.gz",
            "sha1" : "<hash>"
         },
         "linux-arm64" : {

```

--------------------------------

### Create User POST Request - EU Region

Source: https://docs.saucelabs.com/dev/api/accounts

This `curl` command shows how to create a new user via the Sauce Labs API in the EU region. It is similar to the US region request but targets the EU endpoint. It includes authentication, headers, and the JSON payload for user creation. The `json_pp` command aids in pretty-printing the output.

```bash
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request POST 'https://api.eu-central-1.saucelabs.com/team-management/v1/users/' \
--header 'Content-Type: application/json' \
--data-raw '{  
    "first_name": "John",  
    "last_name": "Smith",  
    "email": "jsmith@icloud.com",  
    "username": "jsmith",  
    "password": "$m1th*RULES",  
    "role": 4,  
    "team": "<team-id>"  
}' | json_pp  
```

--------------------------------

### Get Specific User - GET /team-management/v1/users/{user_id}/

Source: https://docs.saucelabs.com/dev/api/accounts

Retrieves the full profile of a specific user using their unique ID. The user ID can be obtained from the Lookup Users endpoint.

```curl
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.us-west-1.saucelabs.com/team-management/v1/users/<user-id>' \
--header 'Content-Type: application/json' | json_pp
```

```curl
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.eu-central-1.saucelabs.com/team-management/v1/users/<user-id>' \
--header 'Content-Type: application/json' | json_pp
```

--------------------------------

### Create User POST Request - US Region

Source: https://docs.saucelabs.com/dev/api/accounts

This `curl` command demonstrates how to create a new user via the Sauce Labs API in the US region. It includes the necessary authentication, endpoint, headers, and a JSON payload with user details. The `json_pp` command formats the response for readability.

```bash
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request POST 'https://api.us-west-1.saucelabs.com/team-management/v1/users/' \
--header 'Content-Type: application/json' \
--data-raw '{  
    "first_name": "John",  
    "last_name": "Smith",  
    "email": "jsmith@icloud.com",  
    "username": "jsmith",  
    "password": "$m1th*RULES",  
    "role": 4,  
    "team": "<team-id>"  
}' | json_pp  
```

--------------------------------

### Get User Concurrency (RDC) - US Region

Source: https://docs.saucelabs.com/dev/api/accounts

Retrieves concurrency details for real devices using a GET request to the US-West-1 API. This endpoint is a workaround as the main user concurrency endpoint does not accurately return real device usage.

```curl
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location --request GET 'https://api.us-west-1.saucelabs.com/v1/rdc/concurrency' --header 'Content-Type: application/json' | json_pp  

```

--------------------------------

### Sample Lighthouse Performance Data Response

Source: https://docs.saucelabs.com/dev/api/jobs

A sample JSON response from the Lighthouse performance analysis, detailing various metrics, score breakdowns, and request type information for a given URL.

```json
;[
{
lighthouseVersion: '6.3.0',
timestamp: 1618922245243,
loaderId: '806270ED1EF8FA367C4CDC4083079F32',
score: 0.61,
url: 'https://www.paypal.com/',
value: {
mainThreadWorkBreakdown: [
{
group: 'scriptEvaluation',
duration: 498
},
{
group: 'other',
duration: 304
},
{
group: 'styleLayout',
duration: 236
},
{
group: 'paintCompositeRender',
duration: 102
},
{
group: 'parseHTML',
duration: 24
},
{
group: 'garbageCollection',
duration: 22
},
{
group: 'scriptParseCompile',
duration: 18
}
],
diagnostics: {
numRequests: 33,
numScripts: 12,
numStylesheets: 1,
numFonts: 4,
numTasks: 266,
numTasksOver10ms: 16,
numTasksOver25ms: 7,
numTasksOver50ms: 5,
numTasksOver100ms: 2,
numTasksOver500ms: 0,
rtt: 8,
throughput: 1446875.3581661892,
maxRtt: 26,
maxServerLatency: 581,
totalByteWeight: 3646672,
totalTaskTime: 1204,
mainDocumentTransferSize: 37202
},
metrics: {
estimatedInputLatency: 19,
timeToFirstByte: 572,
serverResponseTime: 572,
domContentLoaded: 4057,
firstVisualChange: 4111,
firstPaint: 4115,
firstContentfulPaint: 4115,
firstMeaningfulPaint: 4115,
lastVisualChange: 17642,
firstCPUIdle: 7608,
firstInteractive: 7608,
load: 5043,
speedIndex: 6431,
totalBlockingTime: 200,
largestContentfulPaint: 4115,
cumulativeLayoutShift: 0
},
scoreOverview: {
firstContentfulPaint: {
score: 0.47,
value: 4114.5,
weight: 15
},
speedIndex: {
score: 0.4,
value: 6431,
weight: 15
},
largestContentfulPaint: {
score: 0.47,
value: 4114.5,
weight: 25
},
firstInteractive: {
score: 0.47,
value: 7607.5,
weight: 15
},
totalBlockingTime: {
score: 0.97,
value: 200,
weight: 25
},
cumulativeLayoutShift: {
score: 1,
value: 0,
weight: 5
}
},
requestTypes: {
Document: {
size: 106595,
encoded: 0,
count: 1
},
Font: {
size: 73360,
encoded: 0,
count: 4
},
Stylesheet: {
size: 316022,
encoded: 0,
count: 1
},
Image: {
size: 191384,
encoded: 0,
count: 7
},
Script: {
size: 1587992,
encoded: 0,
count: 12
},
XHR: {
size: 39994,
encoded: 0,
count: 2
},
Other: {
size: 6876,
encoded: 0,
count: 2
},
Media: {
size: 1360299,
encoded: 0,
count: 2
}
},
warnings: {}
},
type: 'hard'
}
]
```

--------------------------------

### Get Specific Tunnel Information (curl)

Source: https://docs.saucelabs.com/dev/api/connect

Fetches detailed information for a specific Sauce Connect tunnel using its ID. The request requires the username of the tunnel owner and the tunnel's unique identifier. It uses a GET request to the Sauce Labs API.

```curl
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.us-west-1.saucelabs.com/rest/v1/jim.smith/tunnels/28e7c8133ede4588a891666dd35af1f8' \
--header 'Content-Type: application/json' | json_pp  

```

```curl
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.us-east-4.saucelabs.com/rest/v1/jim.smith/tunnels/28e7c8133ede4588a891666dd35af1f8' \
--header 'Content-Type: application/json' | json_pp  

```

```curl
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.eu-central-1.saucelabs.com/rest/v1/jim.smith/tunnels/28e7c8133ede4588a891666dd35af1f8' \
--header 'Content-Type: application/json' | json_pp  

```

--------------------------------

### Create Team using cURL

Source: https://docs.saucelabs.com/dev/api/accounts

This snippet demonstrates how to create a new team using the cURL command. It requires the Sauce Labs username and access key for authentication. The request body specifies the team's name, settings (including virtual machine concurrency), and an optional description. It targets the US West 1 API endpoint.

```bash
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request POST 'https://api.us-west-1.saucelabs.com/team-management/v1/teams/' \
--header 'Content-Type: application/json' \
--data-raw '{ \
    "name": "A-Team", \
    "settings": { \
        "virtual_machines": "10" \
    }, \
    "description": "Docs QA Team" \
}' | json_pp
```

--------------------------------

### GET /team-management/v1/service-accounts/{uuid}/

Source: https://docs.saucelabs.com/dev/api/accounts

Retrieves details of a specific service account using its unique identifier.

```APIDOC
## GET /team-management/v1/service-accounts/{uuid}/

### Description
Retrieves details of the specified service account.

### Method
GET

### Endpoint
`/team-management/v1/service-accounts/{uuid}/`

### Parameters
#### Path Parameters
- **uuid** (string) - The unique identifier of the service account.

### Request Example
```bash
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.us-west-1.saucelabs.com/team-management/v1/service-accounts/7ddb81628f5f4e77b5f74d9dec4980db/' \
--header 'Content-Type: application/json' | json_pp
```

### Response
#### Success Response (200)
- **id** (string) - The service account ID.
- **username** (string) - The service account username.
- **name** (string) - The service account name.
- **team** (object) - Details of the team the service account belongs to.
  - **id** (string) - The team ID.
  - **name** (string) - The team name.
- **creator** (object) - Details of the user who created the service account.
  - **id** (string) - The creator's user ID.
  - **username** (string) - The creator's username.
  - **email** (string) - The creator's email.

#### Response Example
```json
{
  "id": "7ddb81628f5f4e77b5f74d9dec4980db",
  "username": "bot-automation-service-account-d2164",
  "name": "Automation Service Account",
  "team": {
    "id": "bd8466c7c94f4f2a8641a1fd4ac1a89d",
    "name": "QA Automation Team"
  },
  "creator": {
    "id": "504e6c7223fd4159815a08c38f677701",
    "username": "john.doe",
    "email": "john.doe@example.com"
  }
}
```
```

--------------------------------

### GET /team-management/v1/users/{user_id}/access-key/

Source: https://docs.saucelabs.com/dev/api/accounts

Retrieves the Sauce Labs access key for the specified user.

```APIDOC
## GET /team-management/v1/users/{user_id}/access-key/

### Description
Retrieves the Sauce Labs access key for the specified user.

### Method
GET

### Endpoint
`/team-management/v1/users/{user_id}/access-key/`

#### Path Parameters
- **user_id** (STRING) - Required - The unique identifier of the user. You can look up a user's ID using the Lookup Users endpoint.

### Response
#### Success Response (200)
- **access_key** (STRING) - The Sauce Labs access key for the user.

#### Response Example
```json
{
  "access_key": "YOUR_USER_ACCESS_KEY"
}
```
```

--------------------------------

### Get a Specific Team

Source: https://docs.saucelabs.com/dev/api/accounts

Retrieves the full profile of a specified team using its unique ID.

```APIDOC
## GET /team-management/v1/teams/{team_id}/

### Description
Returns the full profile of the specified team. The `ID` of the team is the only valid unique identifier.

### Method
GET

### Endpoint
`/team-management/v1/teams/{team_id}/`

### Parameters
#### Path Parameters
- **team_id** (STRING) - Required - The unique identifier of the team. You can look up the IDs of teams in your organization using the Lookup Teams endpoint.

### Request Example
```bash
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \
--request GET 'https://api.us-west-1.saucelabs.com/team-management/v1/teams/<team-id>' \
--header 'Content-Type: application/json' | json_pp
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the team.
- **name** (string) - The name of the team.
- **org_uuid** (object) - The organization UUID.
  - **id** (string) - The organization ID.
  - **name** (string) - The organization name.
  - **created_at** (string) - The creation timestamp.
  - **updated_at** (string) - The update timestamp.
  - **total_vm_concurrency** (integer) - Total VM concurrency.
  - **settings** (object) - Organization settings.
- **group** (object) - Group information.
- **created_at** (string) - The creation timestamp.
- **updated_at** (string) - The update timestamp.
- **settings** (object) - Team settings.
  - **virtual_machines** (integer) - Number of virtual machines.
  - **real_devices** (integer) - Number of real devices.
  - **live_only** (boolean) - Whether live mode is enabled.
- **description** (string) - A description of the team.
- **is_default** (boolean) - Whether this is the default team.
- **links** (object) - Links to related resources.

#### Response Example
```json
{
    "id": "80d69d16ebdb4c018cc9d81ea911761a",
    "name": "Sauce-Docs",
    "org_uuid": {
        "id": "**********",
        "name": "SLTC",
        "created_at": "2020-10-05T16:21:01.513495Z",
        "updated_at": "2020-11-09T23:46:47.752572Z",
        "total_vm_concurrency": 46,
        "settings": {}
    },
    "group": {},
    "created_at": "2020-12-30T17:09:12.473388Z",
    "updated_at": "2020-12-30T17:09:12.473415Z",
    "settings": {
        "virtual_machines": 25,
        "real_devices": 0,
        "live_only": false
    },
    "description": "Tech Content API Testing",
    "is_default": false,
    "links": {}
}
```
```
Tokens:
Raw