API Reference
Devbox
- The Devbox Object
- Devbox Lifecycle
- Devbox File Tools
- Devbox Shell Tools
- Devbox Network Tools
- Devbox Persistence Tools
- Devbox Observability Tools
- Devbox Add-ons
- Browser
- Computer
Blueprint
- The Blueprint Object
- Blueprint Lifecycle
- Blueprint Observability
Repository
- The Repository Object
- Repository Lifecycle
Code Scenario
- Code Scenario Lifecycle
- Scenarios Runs
- Custom Scenario Scorer
- Public Scenarios
Benchmark
- Benchmark Lifecycle
- Benchmark Runs
- Public Benchmarks
Browser
Get Browser Details.
Browser
Get Browser Details.
GET
/
v1
/
devboxes
/
browsers
/
{id}
import Runloop from '@runloop/api-client';
const client = new Runloop({
bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});
async function main() {
const browserView = await client.devboxes.browsers.retrieve('id');
console.log(browserView.connection_url);
}
main();
{
"devbox": {
"id": "<string>",
"name": "<string>",
"status": "provisioning",
"create_time_ms": 123,
"end_time_ms": 123,
"blueprint_id": "<string>",
"snapshot_id": "<string>",
"metadata": {},
"failure_reason": "out_of_memory",
"shutdown_reason": "api_shutdown",
"launch_parameters": {
"launch_commands": [
"<string>"
],
"resource_size_request": "X_SMALL",
"keep_alive_time_seconds": 123,
"available_ports": [
123
],
"after_idle": {
"idle_time_seconds": 123,
"on_idle": "shutdown"
},
"custom_cpu_cores": 123,
"custom_gb_memory": 123,
"architecture": "x86_64",
"user_parameters": {
"username": "<string>",
"uid": 123
}
},
"capabilities": [
"unknown"
]
},
"connection_url": "<string>",
"live_view_url": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The Browser ID
Response
200 - application/json
OK
A Browser represents a managed implementation of a browser like Chromiumon top of Devboxes. It includes the tunnel to the live screen and the underlying DevboxView.
Was this page helpful?
import Runloop from '@runloop/api-client';
const client = new Runloop({
bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});
async function main() {
const browserView = await client.devboxes.browsers.retrieve('id');
console.log(browserView.connection_url);
}
main();
{
"devbox": {
"id": "<string>",
"name": "<string>",
"status": "provisioning",
"create_time_ms": 123,
"end_time_ms": 123,
"blueprint_id": "<string>",
"snapshot_id": "<string>",
"metadata": {},
"failure_reason": "out_of_memory",
"shutdown_reason": "api_shutdown",
"launch_parameters": {
"launch_commands": [
"<string>"
],
"resource_size_request": "X_SMALL",
"keep_alive_time_seconds": 123,
"available_ports": [
123
],
"after_idle": {
"idle_time_seconds": 123,
"on_idle": "shutdown"
},
"custom_cpu_cores": 123,
"custom_gb_memory": 123,
"architecture": "x86_64",
"user_parameters": {
"username": "<string>",
"uid": 123
}
},
"capabilities": [
"unknown"
]
},
"connection_url": "<string>",
"live_view_url": "<string>"
}