templates

List default templates

Changed on

Lists the platform's default templates, ordered by template ID. Deleted templates are left out. Templates that are not public are listed only to their own team and to admin callers. The build, resources and envd version are those of the newest ready build tagged default, the one a sandbox started from the template runs, and are zero or empty when there is none; buildStatus describes the newest build tagged default in any state. Usage fields (spawnCount, buildCount, lastSpawnedAt, createdBy) are reported only for the caller's own templates and to admin callers.

get/default-templates

Request

  • Base URL
    https://api.e2b.app
  • URL
    https://api.e2b.app/default-templates
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer
    • or API key in header X-Admin-Token
    • or HTTP bearer

Response

Successfully returned the default templates

templateIDstring required

Identifier of the template

buildIDstring required

Identifier of the last successful build for given template

cpuCountinteger required

CPU cores for the sandbox

memoryMBinteger required

Memory for the sandbox in MiB

diskSizeMBinteger required

Disk size for the sandbox in MiB

publicboolean required

Whether the template is public or only accessible by the team

aliasesstring[] required

Aliases of the template

namesstring[] required

Names of the template (namespace/alias format when namespaced)

createdAtstring date-time required

Time when the template was created

updatedAtstring date-time required

Time when the template was last updated

lastSpawnedAtstring date-time nullable required

Time when the template was last used

spawnCountinteger required

Number of times the template was used

buildCountinteger required

Number of times the template was built

envdVersionstring required

Version of the envd running in the sandbox

buildStatus'building' | 'waiting' | 'ready' | 'error' required

Status of the template build

isDefaultboolean

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).

descriptionstring

Description of the template

Changes