node-saucelabs

SauceLabs Interface

The following commands are available via package or cli tool:

GET /v1.1/jobs/{id}
No description available.

Example:

api.getJobV1_1(id)
GET /v1.1/users/{username}/concurrency
No description available.

Example:

api.getUserConcurrency(username)
GET /v1.1/users/{username}/organization
No description available.

Example:

api.listUserOrganization(username)
GET /v1.1/{username}/available_tunnels
No description available.

Example:

api.listAvailableTunnels(username)
GET /v1.1/{username}/builds
No description available.

Example:

api.listBuilds(username, { ...options })

Options

  • subaccounts: Include subaccounts in list of jobs
  • limit: Number of results to return
GET /v1.1/{username}/jobs
No description available.

Example:

api.listJobs(username, { ...options })

Options

  • auto_only: No description available.
  • to: receive jobs until specific timestamp
  • from: receive jobs beginning of a specific timestamp
  • owner: username of owner of the jobs
  • owner_type: owner type for jobs
  • name: name of the job
  • limit: Number of results to return
  • manual_only: Only return manual jobs
  • full: Should the return result contain everything or just the basics
  • subaccounts: Include subaccounts in list of jobs
GET /v1/dashboard_messages/{username}
No description available.

Example:

api.getDashboardMessageForUser(username)
GET /v1/info/platforms/{platform}
returns a list of supported platforms in the Sauce cloud

Example:

api.listPlatforms(platform)
GET /v1/info/status
No description available.

Example:

api.getStatus()
DELETE /v1/manual
complete manual task

Example:

api.deleteManualJob(ids)
POST /v1/manual
Creates a manual job

Example:

api.createManualJob(capabilities)
GET /v1/manual/options/
returns a list of supported platforms in the Sauce cloud

Example:

api.listManualPlatforms()
GET /v1/manual/{taskId}
get manual task

Example:

api.getManualJob(taskId)
POST /v1/manual/{taskId}/screenshot
Take screenshot in manual session

Example:

api.createManualJobScreenshot(taskId)
GET /v1/me
No description available.

Example:

api.getCurrentUser()
DELETE /v1/tasks
complete manual task

Example:

api.deleteManualJobLegacy(ids)
POST /v1/tasks
Creates a manual job

Example:

api.createManualJobLegacy(capabilities)
GET /v1/users/{username}
No description available.

Example:

api.getUser(username)
GET /v1/users/{username}/subaccounts
No description available.

Example:

api.getSubaccounts(username)
GET /v1/users/{username}/activity
No description available.

Example:

api.getUserActivity(username)
GET /v1/users/{username}/monthly-minutes
No description available.

Example:

api.getUserMinutes(username)
GET /v1/users_activity
No description available.

Example:

api.getUsersActivity()
GET /v1/users_last_job
No description available.

Example:

api.usersLastJob()
GET /v1/whoami
No description available.

Example:

api.getCurrentUserFull()
GET /v1/{username}/all_tunnels
No description available.

Example:

api.listAllTunnels(username)
GET /v1/{username}/builds/{id}/failed-jobs
No description available.

Example:

api.listBuildFailedJobs(username, id)
GET /v1/builds/{id}/jobs
No description available.

Example:

api.listBuildJobs(id, { ...options })

Options

  • full: Should the return result contain everything or just the basics
GET /v1/{username}/jobs/{id}
No description available.

Example:

api.getJob(username, id)
PUT /v1/{username}/jobs/{id}
No description available.

Example:

api.updateJob(username, id, body)
PUT /v1/{username}/jobs/{id}/stop
No description available.

Example:

api.stopJob(username, id)
GET /v1/{username}/tunnels
No description available.

Example:

api.listTunnels(username, { ...options })

Options

  • full: Should the return result contain everything or just the basics
DELETE /v1/{username}/tunnels/{id}
No description available.

Example:

api.deleteTunnel(username, id)
GET /v1/{username}/tunnels/{id}
No description available.

Example:

api.getTunnel(username, id)
GET /v1/jobs/{id}/{assetName}
No description available.

Example:

api.downloadJobAsset(id, assetName, { ...options })

Options

  • filepath: file path to store the asset at
POST /storage/upload
Returns new application id after the upload.

Example:

api.uploadApp({ ...options })

Options

  • body: No description available.
  • App-Active: If true makes uploaded application active one
  • App-DisplayName: Your custom display name
  • App-Identifier: Your custom unique identifier for your app
  • App-Type: Application type
PUT /v1/appium/session/{sessionId}/skiptest
Report the result of a test as skipped.

Example:

api.markTestAsSkippedDeprecated(sessionId)
PUT /v1/appium/session/{sessionId}/test
Report the result of a test.

Example:

api.updateTestDeprecated(sessionId, { ...options })

Options

  • body: No description available.
PUT /v1/appium/suites/{batchId}
Updates the properties of a suite.

Example:

api.updateSuiteDeprecated(suiteId, { ...options })

Options

  • body: No description available.
GET /v1/appium/suites/{batchId}/deviceIds
Returns the IDs of the devices which you had selected for the specified suite.

Example:

api.readDeviceIdsDeprecated(suiteId)
POST /v1/appium/suites/{batchId}/reports/start
Start a new suite execution including its test executions.

Example:

api.startSuiteDeprecated(suiteId, { ...options })

Options

  • body: No description available.
  • appId: The ID of the app version you wish to test
PUT /v1/appium/suites/{batchId}/reports/{batchReportId}/finish
Marks all test executions contained in the specified suite execution as finished.

Example:

api.finishSuiteDeprecated(suiteId, batchReportId)
PUT /v1/appium/suites/{batchId}/reports/{batchReportId}/results/{testReportId}/finish
Sets the status of the specific test execution and marks it as finished.

Example:

api.finishTestReportDeprecated(suiteId, suiteReportId, testReportId, { ...options })

Options

  • body: No description available.
PUT /v1/appium/suites/{batchId}/reports/{batchReportId}/results/{testReportId}/skip
Mark test execution as skipped

Example:

api.skipTestReportDeprecated(suiteId, suiteReportId, testReportId)
GET /v1/devices
Returns a list containing all devices, including those not currently available for testing

Example:

api.getDescriptorsDeprecated()
GET /v1/devices/all
Returns a list containing all devices, including those not currently unavailable for testing. This endpoint requires API Key authentication and will also return your private devices.

Example:

api.getDescriptorsApiDeprecated()
GET /v1/devices/all/available
Returns a list containing the IDs of all devices currently available for testing. This endpoint requires API Key authentication and will also return your private devices.

Example:

api.getAvailableDescriptorIdsApiDeprecated()
GET /v1/devices/available
Returns a list containing the IDs of all devices currently available for testing

Example:

api.getAvailableDescriptorIdsDeprecated()
GET /v1/devices/reports
The session history reports provide information about user sessions. This includes device usage and test reports. By default reports of the last 30 days will be retrieved - limited to a maximum of 50 reports. If the authenticated user is the owner of the account, session reports of the entire team will be retrieved. Team members can only retrieve their own session history. This endpoint requires Password authentication.

Example:

api.getSessionReports({ ...options })

Options

  • limit: Max number of results per page
  • offset: Offset for pagination
  • lastDays: Number of days to report
  • userId: Your username.
GET /v1/devices/{deviceDescriptorId}
Returns information for a particular device. This endpoint requires API Key authentication.

Example:

api.getDescriptorDeprecated(deviceId)
GET /v1/devices/{deviceDescriptorId}/status
Returns a list containing device status infos for all device instances with the specified device ID on all pools. This endpoint requires API Key authentication and will also return your private devices.

Example:

api.getDeviceStatusInfosDeprecated(deviceId)
PUT /v2/appium/session/{sessionId}/skiptest
Report the result of a test as skipped.

Example:

api.markTestAsSkipped(sessionId)
PUT /v2/appium/session/{sessionId}/test
Report the result of a test.

Example:

api.updateTest(sessionId, { ...options })

Options

  • body: No description available.
PUT /v2/appium/suites/{batchId}
Updates the properties of a suite.

Example:

api.updateSuite(suiteId, { ...options })

Options

  • body: No description available.
GET /v2/appium/suites/{batchId}/deviceIds
Returns the IDs of the devices which you had selected for the specified suite.

Example:

api.readDeviceIds(suiteId)
POST /v2/appium/suites/{batchId}/reports/start
Start a new suite execution including its test executions.

Example:

api.startSuite(suiteId, { ...options })

Options

  • body: No description available.
  • appId: The ID of the app version you wish to test
PUT /v2/appium/suites/{batchId}/reports/{batchReportId}/finish
Marks all test executions contained in the specified suite execution as finished.

Example:

api.finishSuite(suiteId, batchReportId)
PUT /v2/appium/suites/{batchId}/reports/{batchReportId}/results/{testReportId}/finish
Sets the status of the specific test execution and marks it as finished.

Example:

api.finishTestReport(suiteId, suiteReportId, testReportId, { ...options })

Options

  • body: No description available.
PUT /v2/appium/suites/{batchId}/reports/{batchReportId}/results/{testReportId}/skip
Mark test execution as skipped

Example:

api.skipTestReport(suiteId, suiteReportId, testReportId)
GET /v2/batchReports/{batchReportId}
Returns the test report of a suite

Example:

api.readBatchReport({ ...options })

Options

  • body: No description available.
  • body: No description available.
GET /v2/batchReports/{batchReportId}/xml
Returns the test report of a suite as XML

Example:

api.junitStyleXmlReport({ ...options })

Options

  • body: No description available.
  • body: No description available.
GET /v2/devices
Returns a list per data center containing all devices, including private devices and those not currently available for testing. This endpoint requires API Key authentication.

Example:

api.getDescriptors()
GET /v2/devices/available
Returns a list per data center containing the IDs of all devices currently available for testing, including private devices. This endpoint requires API Key authentication.

Example:

api.getAvailableDescriptorIds()
GET /v2/devices/{deviceDescriptorId}
Returns information for a particular device per data center. This endpoint requires API Key authentication.

Example:

api.getDescriptor(deviceId)
GET /v2/logs/{testReportId}/appium
Returns Appium log for the specified test report

Example:

api.readAppiumLog(testReportId)
GET /v2/logs/{testReportId}/device
Returns device log for the specified test report

Example:

api.readDeviceLog(testReportId)
GET /v2/logs/{testReportId}/vitals
Returns device vitals of a test session after completion

Example:

api.readVitalsLog(testReportId)
GET /v2/logs/{testReportId}/xcuitest
Returns XCUITest log for the specified test report

Example:

api.readXcuiTestLog(testReportId)
GET /v2/reports/{testReportId}
Returns test report and artifacts for a test session after completion

Example:

api.readReport(testReportId)
GET /v2/screenshots/{testReportId}/{screenshotId}.png
Returns a PNG screenshot from a test

Example:

api.getScreenshot(testReportId, screenshotId)
GET /v2/video/{videoId}.mp4
Returns screen recording of a test session after completion

Example:

api.getScreenRecording(videoId, { ...options })

Options

  • Range: No description available.
GET /metrics/
Provides a list of paginated raw performance metrics for the logged user

Example:

api.getPerformanceMetrics({ ...options })

Options

  • page_url: No description available.
GET /metrics/{job_id}/
Provides performance metrics and job basic data for a given job_id

Example:

api.getPerformanceMetricsByJobId(job_id, { ...options })

Options

  • full: When set to false, basic job data will be returned, excluding performance metrics
GET /metrics/{job_id}/assert/
Provides information if there is an outlier for the given job_id and metric

Example:

api.assertPerformance(job_id, metric_names, order_index)
GET /metrics/{job_id}/baseline/
Provides baseline based on metrics history, where the reference point is a given job_id

Example:

api.getBaseline(job_id, metric_names, order_index, { ...options })

Options

  • regime_end: No description available.
  • regime_start: No description available.
GET /metrics/{job_id}/baseline/reset/
Returns true if a baseline was resetted for a give job_id

Example:

api.hasBaselineReset(job_id)
POST /metrics/{job_id}/baseline/reset/
Sets a reset point market at job_id, previous jobs will not be taken into account in calculating baseline

Example:

api.acknowledgeBaseline(job_id)
GET /metrics/{job_id}/discarded/
Provides lists outliers marked as discarded

Example:

api.getDiscardedOutliers(job_id, order_index)
POST /metrics/{job_id}/discarded/
Marks outlier for a given {job_id} as not relevant/flaky

Example:

api.discardOutliers(job_id, order_index)
GET /metrics/{job_id}/history/
Provides a list of raw performance metrics up to point where the reference is a given job_id and order_index

Example:

api.getBaselineHistory(job_id, order_index, { ...options })

Options

  • limit: No description available.
GET /metrics/{job_id}/regimes/
Provides regimes per metric calculated for a set of jobs, where the reference point is a given job_id

Example:

api.getRegimes(job_id, metric_names, order_index, { ...options })

Options

  • include_baseline: No description available.
POST /metrics/{job_id}/regimes/acknowledge/
Acknowledge regime. Confirm values in new regime are acceptable.

Example:

api.acknowledgeRegime(job_id, order_index)
GET /metrics/swagger/
Provides json documentation for the performance API

Example:

api.getApiDefinition()