BEbenchling
App Session

Update AppSession

Update AppSession.

patch/api/v3/app-session/{app_session_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

app_session_idstring required

ID of the AppSession.

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Request body

status'SUCCEEDED' | 'FAILED' | 'COMPLETED_WITH_WARNINGS'

Transition the session to a terminal status (SUCCEEDED, FAILED, or COMPLETED_WITH_WARNINGS).

timeoutSecondsinteger

New timeout in seconds. Must be greater than or equal to the current timeout.

Response

OK

__typenamestring
createdAtstring datetime
idstring
modifiedAtstring datetime
namestring
status'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'COMPLETED_WITH_WARNINGS' | 'TIMEOUT'

The current lifecycle status of this session, derived from the most recent version.

timeoutSecondsinteger

Maximum duration in seconds before the session times out automatically. Once the session's age exceeds this value and the session has not been finalized, its status becomes TIMEOUT.

Changes

No recorded changes to this operation across all 1 revision of this API.