BEbenchling
apps

Get an app session

Get an app session

get/app-sessions/{id}

Request

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

Path parameters

idstring required

Query parameters

returningstring

Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, '*'. For more information, click here.

Response

OK

createdAtstring date-time
idstring
modifiedAtstring date-time
namestring

A brief description of the app's actions for users. Length must be between 3-100 chars. It becomes immutable once a value is set.

status'COMPLETED_WITH_WARNINGS' | 'FAILED' | 'RUNNING' | 'SUCCEEDED' | 'TIMEOUT'

All possible values of a Session's status, including system-updated and user-updated values.

timeoutSecondsinteger

Timeout in seconds, a value between 1 second and 30 days. Once set, it can only be increased, not decreased.

Changes

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