Endpoints
List templates with pagination
Page through accessible templates using a catalog cursor.
GET
/
v2
/
templates
curl --request GET \
--url "https://api.bead.run/v2/templates" \
--header "X-API-Key: $BEAD_API_KEY"
{
"response": [
{
"aliases": [
"<string>"
],
"buildCount": 123,
"buildID": "<string>",
"buildStatus": "<string>",
"cpuCount": 123,
"createdAt": "<string>",
"createdBy": {
"email": {},
"id": "<string>"
},
"default_kind": "<string>",
"description": "<string>",
"diskSizeMB": 123,
"envdVersion": "<string>",
"isDefault": true,
"lastSpawnedAt": {},
"memoryMB": 123,
"names": [
"<string>"
],
"public": true,
"spawnCount": 123,
"templateID": "<string>",
"updatedAt": "<string>"
}
]
}Authentication
Send your scoped bearer token in theAuthorization: Bearer <BEAD_TOKEN> header, or send your API key in X-API-Key.
Parameters
integer
default:100
Maximum templates per page. Minimum:
1. Maximum: 100.string
Last template ID from the X-Next-Token response header.
string
Your organization UUID; requesting another team returns 403.
curl --request GET \
--url "https://api.bead.run/v2/templates" \
--header "X-API-Key: $BEAD_API_KEY"
Response
200
Successfully returned all templates.object[]
Successfully returned all templates.
Show Properties
Show Properties
string[]
required
deprecated
Aliases of the template
integer
required
Number of times the template was built Format:
int32.string
required
Identifier of the last successful build for given template
string
required
Status of the template build Allowed values:
"building", "waiting", "ready", "error".integer
required
CPU cores for the sandbox Format:
int32. Minimum: 1.string
required
Time when the template was created Format:
date-time.object | null
required
string
Default machine lifetime for this template. Allowed values:
"temporary", "persistent".string
Description of the template
integer
required
Disk size for the sandbox in MiB Format:
int32. Minimum: 0.string
required
Version of the envd running in the sandbox
boolean
Whether the template is one of the platform’s default templates. A default template owned by another team carries zero or null usage fields (
spawnCount, buildCount, lastSpawnedAt, createdBy).string | null
required
Time when the template was last used Format:
date-time. May be null.integer
required
Memory for the sandbox in MiB Format:
int32. Minimum: 128.string[]
required
Names of the template (namespace/alias format when namespaced)
boolean
required
Whether the template is public or only accessible by the team
integer
required
Number of times the template was used Format:
int64.string
required
Identifier of the template
string
required
Time when the template was last updated Format:
date-time.Errors
| Status | Meaning |
|---|---|
| 400 | Invalid pagination or filters; legacy lists also reject results over 5000 entries (admission_limit). |
| 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. |
⌘I
curl --request GET \
--url "https://api.bead.run/v2/templates" \
--header "X-API-Key: $BEAD_API_KEY"
{
"response": [
{
"aliases": [
"<string>"
],
"buildCount": 123,
"buildID": "<string>",
"buildStatus": "<string>",
"cpuCount": 123,
"createdAt": "<string>",
"createdBy": {
"email": {},
"id": "<string>"
},
"default_kind": "<string>",
"description": "<string>",
"diskSizeMB": 123,
"envdVersion": "<string>",
"isDefault": true,
"lastSpawnedAt": {},
"memoryMB": 123,
"names": [
"<string>"
],
"public": true,
"spawnCount": 123,
"templateID": "<string>",
"updatedAt": "<string>"
}
]
}