Retrieve
GET/workspaces/:workspace_id
Retrieve a Workspace based on a currently active UUID.
Request
Path Parameters
The UID associated to a Workspace. Learn more
Responses
- 200
- 400
- 401
- 429
- 500
Successfully retrieved a Workspace.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
The UID associated to a Workspace. Learn more
Possible values: [active
, archived
]
The status of the Workspace.
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.
Possible values: [debug
, info
, warning
, error
]
The log level.
URL to download the file contents.
The creation time of the log.
The creation time of the Workspace.
{
"id": "bMf1euMgczAY",
"status": "active",
"files": {
"object": "list",
"data": [
{
"id": "789c0075-v88v-98f7-a456-426618874000",
"name": "example.txt",
"url": "https://example.com/download/789c0075-v88v-98f7-a456-426618874000",
"size": 1024,
"createdAt": "2021-04-07T10:30:00Z"
},
{
"id": "789c0075-v88v-98f7-a456-426618874001",
"name": "example2.txt",
"url": "https://example.com/download/789c0075-v88v-98f7-a456-426618874001",
"size": 2048,
"createdAt": "2020-02-04T11:32:00Z"
}
]
},
"logs": {
"object": "list",
"data": [
{
"id": "789c0075-v88v-98f7-a456-426618874000",
"type": "system",
"level": "error",
"url": "https://example.com/download/789c0075-v88v-98f7-a456-426618874000",
"createdAt": "2021-04-07T10:30:00Z"
},
{
"id": "789c0075-v88v-98f7-a456-426618874000",
"type": "workspace",
"level": "info",
"url": "https://example.com/download/789c0075-v88v-98f7-a456-426618874000",
"createdAt": "2021-04-07T10:30:00Z"
}
]
},
"createdAt": "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"
}
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"
}