The methods described in this section allows you obtain information about and manage completed test jobs.
Some of the methods take an inline parameter of <JOB_ID>. You can obtain a job's ID in any of the following ways:
- Each job result returned in GET /rest/v1/USERNAME/jobs includes an "Id" value that corresponds to the JOB ID.
- The WebDriver object's “sessionId” attribute is the Sauce Labs JOB ID.
- In the Sauce Labs app, the Metadata tab of a test's details provides the 'Id" that corresponds to the JOB ID.
Retrieve the list of recent jobs belonging to a specific user.
positive integer, default 100, max 500
|Specifies the number of jobs to return|
positive integer, default 0
Skips the specified number of jobs
|Get jobs since the specified time|
|Get jobs until the specified time|
string, one of
|Get job info in the specified format|
The get jobs call returns an array of jobs meeting the criteria set in the call. Each job returned includes the following attributes:
|status||string||The current status of the job, such as completed.|
|base_config||object||The set of platform configurations on which the test was executed, such as sauce:options settings, the browser and OS versions, etc.|
|command_counts||object||A breakdown of the total number of commands executed in the job and the number of errors.|
|String||The Unix timestamp representing the time at which the job was deleted.|
|url||String||The URL address of the web driver log file.|
|org_id||String||The unique identification for the organization of which the job owner is a member.|
|creation_time||Integer||The Unix timestamp representing the time at which the job was instantiated.|
|id||String||The unique identification of the job. Also known as the |
|team_id||String||The unique identification of the team to which the job owner is assigned.|
|performance_enabled||Boolean||Whether the test options set performance to true.|
|assigned_tunnel_id||String||The unique identification of the tunnel used for the test.|
|container||Boolean||Whether the job is a parent test.|
|group_id||String||The unique identification for the job category|
|public||String||Specifies who is able to view the job, based on the Visibility setting.|
|breakpointed||Boolean||Whether this test's execution was halted using the Sauce Breakpoint feature.|
See build details for a given username and access key.
Get Job Details
Retrieve job details for the specified JOB_ID.
Edit an existing job
NOTE: Because of the complex syntax required for updating job information via cURL, consider updating job information using the methods described in Test Configuration and Annotation.
|If specified change the job name|
string, JSON array
If present set tags for job
string or boolean
Set job visibility
|Set whether the job passed or not on the user end|
The build name for this test.
Extra key-value pairs with any info that a user would like to add to the job.
Max data allowed is
Removes the job from the system with all the linked assets
If you're using classic team management:
If you're using extended team management:
Note: only job owner, team admin or organization admin can remove the job. See more about user roles.
Delete all user Jobs
This endpoint can be used only if you're using extended team management.
Note: only jobs owner, team admin or organization admin can remove jobs. See more about user roles.
Terminates a running job
Get Job Asset Names
Get details about the static assets collected for a specific job
Each of these fields will be set to
null if the specific asset isn't captured for a job
sauce-log: [string] Name of the Sauce log recorded for a job
selenium-log: [string] Name of the selenium Server log file produced by a job
video: [string] Name of the video file name recorded for a job
screenshots: [array of strings] List of screenshot names captured by a job
Get Job Asset Files
Download job assets. After a job completes, all assets created during the job are available via this API. These include the screencast recording, logs, and screenshots taken on crucial steps.
The job assets will be deleted from the test page after 30 days. Thus, after 30 days all your test commands, logs, screenshots and the screencast recording will be gone. This is the reason why we strongly recommend to download your job assets if this is an information that you must keep in your records.
Delete Job Assets
Delete all the assets captured during a test run. This includes the screencast recording, logs, and all screenshots.