Skip to navigation
Benchling APIApp Session

Update AppSession

Beta
Update AppSession.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

app_session_idstringRequired
ID of the AppSession.

Headers

EARLY-ACCESSstringOptional

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

Request

This endpoint expects an object.
messageslist of objectsOptional
Replace the current messages with this list. If omitted, the existing messages are carried forward unchanged.
statusenumOptional

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

Allowed values:
timeoutSecondsintegerOptional
New timeout in seconds. Must be greater than or equal to the current timeout.

Response

OK
__typenamestringOptional
appobjectOptional
The Benchling App installation that owns this session.
createdAtstringOptional
idstringOptional
messageslist of objectsOptional
The messages currently displayed to the user, from the most recent session version.
modifiedAtstringOptional
namestringOptional
statusenumOptional
The current lifecycle status of this session, derived from the most recent version.
Allowed values:
timeoutSecondsintegerOptional
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.

Errors

400
App Session Update Request Bad Request Error
403
App Session Update Request Forbidden Error
404
App Session Update Request Not Found Error
409
App Session Update Request Conflict Error
429
App Session Update Request Too Many Requests Error
500
App Session Update Request Internal Server Error