Skip to main content

Retrieve

GET 
/workstations/:workstation_id

Retrieve a Workstation based on a currently active UUID.

Request​

Path Parameters

    workstation_id uidrequired

    The UID associated to a Workstation. Learn more

Responses​

Successfully retrieved a Workstation.

Schema

    id uidrequired

    The UID associated to a Workstation. Learn more

    type WorkstationTypeID (string)required

    Possible values: [max, zoom-chromium, meet-chromium, voip, voip-chromium, chromium, python, nodejs, golang]

    The identification label for a Workstation Type.

    status WorkstationStatus (string)required

    Possible values: [active, completed, errored]

    The status of the Workstation.

    workspace

    object

    id uidrequired

    The UID associated to a Workspace. Learn more

    status WorkspaceStatus (string)required

    Possible values: [active, archived]

    The status of the Workspace.

    files

    object

    object string

    Possible values: [list]

    data

    object[]

  • Array [

    • id uuidrequired

    The UUID associated to a file.

    name stringrequired

    The name of the file.

    url urirequired

    URL to download the file contents.

    size integerrequired

    The size of the file in bytes.

    createdAt date-timerequired

    The creation time of the file.

  • ]

    • logs

    object

    object string

    Possible values: [list]

    data

    object[]

  • Array [

    • id uuidrequired

    The UUID associated to a log.

    type stringrequired

    The type of log.

    level LogLevel (string)required

    Possible values: [debug, info, warning, error]

    The log level.

    url uri

    URL to download the file contents.

    createdAt date-timerequired

    The creation time of the log.

  • ]

    • createdAt date-timerequired

    The creation time of the Workspace.

    startedAt date-timerequired

    The start time of the Workstation's activity.

Loading...