Authorizations
Enter your API Key in the format: Bearer <token>. Get it from https://gbox.ai
Path Parameters
Box ID
Example:
"c9bdc193-b54b-4ddb-a035-5ac0c598d32d"
Response
200 - application/json
Get box
- Linux Box
- Android Box
Linux box instance with full configuration and status
Unique identifier for the box
Example:
"c9bdc193-b54b-4ddb-a035-5ac0c598d32d"
The current status of a box instance
Available options:
pending
, running
, error
, terminated
Example:
"running"
Creation timestamp of the box
Example:
"2024-01-15T10:30:00.000Z"
Last update timestamp of the box
Example:
"2024-01-15T10:35:00.000Z"
Expiration timestamp of the box
Example:
"2024-01-15T10:40:00.000Z"
Box type is Linux
Available options:
linux
Example:
"linux"
Configuration for a Linux box instance Complete configuration for Linux box instance
Example:
{
"os": { "version": "ubuntu-20.04" },
"workingDir": "/home/user",
"labels": {
"environment": "development",
"team": "qa"
},
"envs": {
"NODE_ENV": "production",
"PATH": "/usr/bin:/bin"
},
"cpu": 2,
"memory": 1024,
"storage": 30
}
The reason for the current status, if any
Example:
"Box terminated by user"