ExecutionRunner

Update existing Execution Runner

Created Execution Runner for tracking a unique runner

patch/execution/runners/{id}

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/execution/runners/{id}
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

idstring required

runner ID (NOT the ref_id)

Headers

If-Matchstring

If-Match header according to http/1.1 spec section 14.24 - use to ensure atomic updates, pass "version" from etag

Request body

ipv4_addressstring

Currently associated IP address (typically RFC 1918)

execution_runtime_versionstring

SHA256 hash first 7 characters of the runner binary (NOT necessarily the OS/base image)

mobile_training_session_idstring

The currently associated mobile training session ID

status'ready' | 'resetting' | 'running' | 'stopping' | 'starting' | 'terminated'

Non-directed states for runner lifecycle

test_run_idstring

Currently associated test run ID

zonestring

The zone where the VM resides

Response

Execution Runner

ipv4_addressstring

Currently associated IP address (typically RFC 1918)

execution_runtime_versionstring

SHA256 hash first 7 characters of the runner binary (NOT necessarily the OS/base image)

mobile_training_session_idstring

The currently associated mobile training session ID

status'ready' | 'resetting' | 'running' | 'stopping' | 'starting' | 'terminated' required

Non-directed states for runner lifecycle

test_run_idstring

Currently associated test run ID

zonestring

The zone where the VM resides

ref_idstring required

Globally unique runner reference ID (e.g. GCE VM instance number as "gce-<number>", GKE pod ID "gke-<number>", EC2 instance ID as "ec2-<ID>")

workspace_idstring required

Runner owner - may be user owned, or mabl owned

display_namestring required

Presentation name for this runner

test_type'api' | 'browser' | 'performance' | 'mobile'

Type of test

mobile_device_type'virtual' | 'physical'

Type of platform used to create mobile device

execution_host_idstring

The id of the execution host this is running on

execution_runtime_purpose'training' | 'test_run'

Capability provided by this runtime

capabilitiesExecutionRuntimeCapability[] required
execution_runtime_type'container' | 'virtual_machine' required

Type of container used for execution. Note that VM Instances -> virtual machine, GCF, GKE, GCR -> container

execution_runtime_operating_system'android' | 'ios' | 'windows' | 'linux' | 'osx' required

Operation system used in the runtime

capability_browserstring

optional, browsers available to runner, for browser type runners

idstring required

API generated globally unique ID

etagstring

API version etag

created_timeinteger required

Creation time, epoch millis

created_by_idstring required

Creation principal ID

last_updated_timeinteger required

Last updated time, epoch millis

last_updated_by_idstring required

Last updating principal ID

deleted_timeinteger

Deletion time, epoch millis

deleted_by_idstring

Deletion principal ID

Changes

No recorded changes to this operation across all 37 revisions of this API.