Request

POST 
/workstations

Request a Workstation based on a Workstation Type.

Request

application/json

Body

Request a Workstation based on a Workstation Type.

type WorkstationTypeID (string)required

The identification label for a Workstation Type.

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

workspace_id uid

The UID associated to a Workspace. Learn more

Responses

200

Successfully requested a Workstation.

application/json

Schema

Schema

id uidrequired

The UID associated to a Workstation. Learn more

type WorkstationTypeID (string)required

The identification label for a Workstation Type.

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

status WorkstationStatus (string)required

The status of the Workstation.

Possible values: [active, completed, errored]

workspace

object

id uidrequired

The UID associated to a Workspace. Learn more

status WorkspaceStatus (string)required

The status of the Workspace.

Possible values: [active, archived]

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

The log level.

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

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.

Example (from schema)

{
  "id": "Il4lMTpQUC3L",
  "type": "python",
  "status": "active",
  "workspace": {
    "id": "bMf1euMgczAY",
    "status": "active",
    "createdAt": "2021-04-07T10:30:00Z"
  },
  "startedAt": "2021-04-07T10:30:00Z"
}

400

Invalid Request Format - check API documentation for proper syntax.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

401

Unauthorized - missing or invalid API key.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

402

Payment Required - you have run out of trial credits or your payment method has expired. Please add payment details to your account.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

422

Unprocessable Entity - cannot find requested asset associated with your API key.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

429

Too Many Requests - you have exceeded the rate limit for your account. Please wait before making additional requests.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

500

Internal Server Error - please retry your request.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

503

Service Unavailable - our servers have dropped the request due to high load - please retry.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Loading...