MobileTrainingSession

Changed on

Used to trigger the termination of an existing mobile training session

post/mobile/training/session/{id}/terminate

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/mobile/training/session/{id}/terminate
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

idstring required

The ID of the mobile training session to terminate

Request body

status_causestring
termination_reason'insufficient_quota' | 'scheduling_timeout' | 'session_closed' | 'session_expired' | 'startup_failed' | 'startup_timeout' | 'no_gpus_available'

The reason why a mobile training session was terminated

Response

The mobile training session that was terminated

mobile_app_file_idstring required

id of the mobile app file to install

mobile_device_configuration_idstring

The id of the mobile device configuration to use for the training session. If specified, overrides the mobile_device_configuration.

target_runtime_versionstring

Custom image ID to use for the training session

workspace_idstring required

The id of the workspace for the mobile training session

requires_gpuboolean

true if the mobile training requires a GPU to run

status_causestring
termination_reason'insufficient_quota' | 'scheduling_timeout' | 'session_closed' | 'session_expired' | 'startup_failed' | 'startup_timeout' | 'no_gpus_available'

The reason why a mobile training session was terminated

execution_runner_idstring

The ID of the associated ExecutionRunner, if any

status'queued' | 'scheduling' | 'provisioning' | 'initializing' | 'ready' | 'terminated' required

Represents the current status of a mobile training session

connect_urlstring

URL clients should use to make connections to this mobile cloud training session

created_by_idstring required

The ID of the client/user who created this mobile training session

created_timeinteger required

Time at which the mobile training session was created

deleted_by_idstring

The ID of the client/user who deleted this mobile training session

deleted_timeinteger

Time at which this mobile training session was deleted

expiration_timeinteger

Time at which this mobile training session will expire

idstring required

The mobile training session id

is_activeboolean required

Whether or not the session is currently active (status != terminated).

is_initializingboolean

Whether or not the session is currently initializing (status != (READY || TERMINATED))

last_extended_timeinteger

Time at which the mobile training session was last extended

last_updated_by_idstring required

The ID of the client/user who last updated this mobile training session

last_updated_timeinteger required

Time at which the mobile training session was last updated

session_end_timeinteger

Time at which the mobile training session entered terminated status

session_keystring required

Secret key used to authenticate connections to the cloud training session server

session_start_timeinteger

Time at which the mobile training session entered ready status

terminated_by_idstring

The ID of the client/user who terminated this mobile training session

Changes

  • 24dd8c2933dfRevision changes
    • info

      added the optional property ///// to the response with the status