Get CPU / memory / network stats

GET

sandboxes

{id}

stats

curl --request GET \
  --url https://sandbox.brimble.io/sandboxes/{id}/stats \
  --header 'x-brimble-key: <api-key>'

{
  "message": "Sandbox stats fetched",
  "data": {
    "average": {
      "memory": {
        "totalInPercentage": 123,
        "size": 123
      },
      "cpu": {
        "totalInPercentage": 123,
        "size": 123
      },
      "network": {
        "value": 123,
        "total": 123,
        "totalInPercentage": 123,
        "bytesPerSecond": 123
      }
    },
    "replicaCount": 123,
    "results": [
      {
        "date": "2023-11-07T05:31:56Z",
        "memory": 123,
        "cpu": 123,
        "network": {
          "bytesPerSecond": 123
        }
      }
    ],
    "responseTime": {}
  }
}

Authorizations

x-brimble-key

string

header

required

Your account-level Brimble API key. Find it in the dashboard under your profile drawer → API key (click the avatar in the sidebar). Available on paid plans only.

Path Parameters

string

required

24-char hex id of the sandbox.

Pattern: ^[a-f0-9]{24}$

Query Parameters

hoursAgo

integer

default:1

Lookback window in hours.

Required range: x >= 1

Response

Stats payload

message

string

required

Example:

"Sandbox stats fetched"

data

object

required

Show child attributes

Last modified on May 23, 2026

Run a shell commandRuns `cmd` inside the sandbox via a shell, so pipes, `&&`, redirects, and installed CLI tools all work. Sandbox must be in status `ready`. Pass `stream: true` to receive `stdout` / `stderr` as they arrive. The response then uses `Content-Type: application/x-ndjson` with one JSON frame per line; the final frame is `{ "type": "done", ... }`. See `ExecStreamFrame` for the frame shape.

Get CPU / memory / network stats

curl --request GET \
  --url https://sandbox.brimble.io/sandboxes/{id}/stats \
  --header 'x-brimble-key: <api-key>'

{
  "message": "Sandbox stats fetched",
  "data": {
    "average": {
      "memory": {
        "totalInPercentage": 123,
        "size": 123
      },
      "cpu": {
        "totalInPercentage": 123,
        "size": 123
      },
      "network": {
        "value": 123,
        "total": 123,
        "totalInPercentage": 123,
        "bytesPerSecond": 123
      }
    },
    "replicaCount": 123,
    "results": [
      {
        "date": "2023-11-07T05:31:56Z",
        "memory": 123,
        "cpu": 123,
        "network": {
          "bytesPerSecond": 123
        }
      }
    ],
    "responseTime": {}
  }
}