Read account limits

GET

limits

curl --request GET \
  --url "https://api.bead.run/v1/limits" \
  --header "X-API-Key: $BEAD_API_KEY"

from beadrun import Bead

client = Bead()
print(client.limits())
client.close()

import { Bead } from "@beadrun/sdk";

const client = new Bead();
console.log(await client.limits());

{
  "resources": {
    "sandbox_limit": 123,
    "memory_limit_mib": 123,
    "cpu_limit": 123,
    "sandboxes": 123,
    "memory_mib": 123,
    "vcpus": 123
  },
  "batch_limits": {
    "swarm": 123,
    "fleet": 123,
    "fork": 123
  },
  "policy": {
    "max_vcpus": 123,
    "max_memory_mib": 123,
    "starts_minute": 123,
    "starts_hour": 123,
    "starts_day": 123,
    "concurrent_per_shape": 123,
    "saved_templates": 123,
    "batch_size": 123,
    "burst_multiple": 123,
    "burst_units": 123,
    "shape_limits": {}
  },
  "burst_enabled": true,
  "saved_templates": 123,
  "windows": [
    {
      "seconds": 123,
      "usage": 123,
      "reset_at": 123
    }
  ],
  "shapes": [
    {
      "vcpus": 123,
      "memory_mib": 123,
      "usage": 123
    }
  ]
}

Authentication

Send your scoped bearer token in the Authorization: Bearer <BEAD_TOKEN> header, or send your API key in X-API-Key.

curl --request GET \
  --url "https://api.bead.run/v1/limits" \
  --header "X-API-Key: $BEAD_API_KEY"

from beadrun import Bead

client = Bead()
print(client.limits())
client.close()

import { Bead } from "@beadrun/sdk";

const client = new Bead();
console.log(await client.limits());

Response

200

Current organization admission policy and usage.

object

required

Organization resource caps and current usage.

Show Properties

integer

required

Maximum retained machines.

integer

required

Organization memory cap in MiB.

integer

required

Organization CPU cap.

integer

required

Current machines counted against the cap.

integer

required

Current memory allocation in MiB.

integer

required

Current CPU allocation.

object

required

Effective batch limits for this policy.

Show Properties

integer

required

Maximum swarm batch admitted under the current policy.

integer

required

Maximum fleet batch admitted under the current policy.

integer

required

Maximum fork batch admitted under the current policy.

object

required

Admission policy applied to your organization.

Show Properties

integer

Maximum CPU count per machine, when constrained.

integer

Maximum memory per machine in MiB, when constrained.

integer

required

Allowed starts in a UTC minute.

integer

required

Allowed starts in a UTC hour.

integer

required

Allowed starts in a UTC day.

integer

required

Maximum concurrent machines per size.

integer

required

Maximum saved templates.

integer

required

Maximum attempts admitted in one batch.

integer

required

Multiplier for consented burst starts.

integer

required

Credit units charged per extra start.

object

required

Lower concurrency caps keyed by vCPUs-memoryMiB. Additional keys accept integer values.

boolean

required

Whether you consented to paid burst starts.

integer

required

Current saved template count.

object[]

required

Start usage in each UTC time window.

Show Properties

integer

required

Window duration in seconds.

integer

required

Starts counted in this window.

integer

required

Next reset as Unix seconds.

object[]

required

Current allocated machines grouped by CPU and memory.

Show Properties

integer

required

CPUs per machine.

integer

required

Memory per machine in MiB.

integer

required

Machines currently allocated with this size.

Errors

Status	Meaning
401	Authentication credential is missing or rejected.
403	The credential lacks the required scope.
429	Request or resource admission limit exceeded (`admission_limit`). Follow limit.next_action and Retry-After when present.
503	Service or persistence is temporarily unavailable.

curl --request GET \
  --url "https://api.bead.run/v1/limits" \
  --header "X-API-Key: $BEAD_API_KEY"

from beadrun import Bead

client = Bead()
print(client.limits())
client.close()

import { Bead } from "@beadrun/sdk";

const client = new Bead();
console.log(await client.limits());

{
  "resources": {
    "sandbox_limit": 123,
    "memory_limit_mib": 123,
    "cpu_limit": 123,
    "sandboxes": 123,
    "memory_mib": 123,
    "vcpus": 123
  },
  "batch_limits": {
    "swarm": 123,
    "fleet": 123,
    "fork": 123
  },
  "policy": {
    "max_vcpus": 123,
    "max_memory_mib": 123,
    "starts_minute": 123,
    "starts_hour": 123,
    "starts_day": 123,
    "concurrent_per_shape": 123,
    "saved_templates": 123,
    "batch_size": 123,
    "burst_multiple": 123,
    "burst_units": 123,
    "shape_limits": {}
  },
  "burst_enabled": true,
  "saved_templates": 123,
  "windows": [
    {
      "seconds": 123,
      "usage": 123,
      "reset_at": 123
    }
  ],
  "shapes": [
    {
      "vcpus": 123,
      "memory_mib": 123,
      "usage": 123
    }
  ]
}

Start here

Endpoints

Read account limits

Authentication

Response

200

Errors

​Authentication

​Response

​200

​Errors

Authentication

Response

200

Errors