E2e2b-dev
templates

List templates (v2)

Changed on

List all templates

get/v2/templates

Request

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

Query parameters

teamIDstring

Identifier of the team, as its UUID or its public project ID (prj_)

nextTokenstring

Cursor to start the list from

limitinteger

Maximum number of items to return per page

Response

Successfully returned all 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

  • 04ec8eabc7f9Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • a37f50c70019Revision changes
    • info

      added the non-success response with the status