Request
POST/workstations
Request a Workstation based on a Workstation Type.
Request
- application/json
Body
Request a Workstation based on a Workstation Type.
The identification label for a Workstation Type.
Possible values: [max
, zoom-chromium
, meet-chromium
, voip
, voip-chromium
, chromium
, python
, nodejs
, golang
]
The UID associated to a Workspace. Learn more
Responses
- 200
- 400
- 401
- 402
- 422
- 429
- 500
- 503
Successfully requested a Workstation.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
The UID associated to a Workstation. Learn more
The identification label for a Workstation Type.
Possible values: [max
, zoom-chromium
, meet-chromium
, voip
, voip-chromium
, chromium
, python
, nodejs
, golang
]
The status of the Workstation.
Possible values: [active
, completed
, errored
]
workspace
object
The UID associated to a Workspace. Learn more
The status of the Workspace.
Possible values: [active
, archived
]
files
object
Possible values: [list
]
data
object[]
The UUID associated to a file.
The name of the file.
URL to download the file contents.
The size of the file in bytes.
The creation time of the file.
logs
object
Possible values: [list
]
data
object[]
The UUID associated to a log.
The type of log.
The log level.
Possible values: [debug
, info
, warning
, error
]
URL to download the file contents.
The creation time of the log.
The creation time of the Workspace.
The start time of the Workstation's activity.
{
"id": "Il4lMTpQUC3L",
"type": "python",
"status": "active",
"workspace": {
"id": "bMf1euMgczAY",
"status": "active",
"createdAt": "2021-04-07T10:30:00Z"
},
"startedAt": "2021-04-07T10:30:00Z"
}
Invalid Request Format - check API documentation for proper syntax.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"message": "string"
}
Unauthorized - missing or invalid API key.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"message": "string"
}
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
- Example (from schema)
Schema
{
"error": "string",
"message": "string"
}
Unprocessable Entity - cannot find requested asset associated with your API key.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"message": "string"
}
Too Many Requests - you have exceeded the rate limit for your account. Please wait before making additional requests.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"message": "string"
}
Internal Server Error - please retry your request.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"message": "string"
}
Service Unavailable - our servers have dropped the request due to high load - please retry.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"message": "string"
}