---
title: "Returns a specific SandboxEngineTemplate."
method: GET
path: "/v1/{name_14}"
tags: ["SandboxEngineTemplateService"]
---

# Returns a specific SandboxEngineTemplate.

`GET /v1/{name_14}`

## Request

- Base URL: `https://docs.h2o.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.h2o.ai/v1/{name_14}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto/docs/v1/:name_14/get.ts> (a function with typed inputs; its response is checked against the schema)

Authorization may require the following permission on the template's parent workspace:
* actions/enginemanager/sandboxEngineTemplates/GET

## Path parameters

- `name_14` string, required

## Response `200`

A successful response.

- V1GetSandboxEngineTemplateResponse: Response message for `GetSandboxEngineTemplate`.
  - `sandboxEngineTemplate` V1SandboxEngineTemplate: SandboxEngineTemplate is a compute template for a SandboxEngine. An existing SandboxEngineTemplate must be specified when creating a new SandboxEngine.
    - `name` string: Identifier. Resource name. Format is `workspaces/*/sandboxEngineTemplates/*`.
    - `displayName` string: Optional. Human-readable name.
    - `milliCpuRequest` integer: Optional. MilliCPU units that will be reserved for the SandboxEngine. SandboxEngine may use more CPU resources up to the milli_cpu_limit. It is recommended to set CPU requests to avoid resource contention. 1000 milliCPU = 1 CPU core. When unset, milli_cpu_request will be set to milli_cpu_limit.
    - `milliCpuLimit` integer: Optional. Maximum MilliCPU units a SandboxEngine is allowed to use. The SandboxEngine will be throttled to not exceed this limit. It is discouraged to set CPU limits when possible. 1000 milliCPU = 1 CPU core.
    - `gpuResource` string: Optional. Kubernetes GPU resource name. For example: `nvidia.com/gpu` or `amd.com/gpu`. When unset, server will choose a default value.
    - `gpu` integer: Optional. The amount of GPU units requested by this SandboxEngine.
    - `memoryBytesRequest` string, int64: Optional. Memory in bytes that will be reserved for the SandboxEngine. When unset, memory_bytes_request will be set to memory_bytes_limit.
    - `memoryBytesLimit` string, int64, required: Required. Max memory in bytes a SandboxEngine is allowed to use. SandboxEngine may fail or be terminated if it exceeds this limit.
    - `storageBytes` string, int64: Optional. External ephemeral storage in bytes that will be mounted to the SandboxEngine. When unset, the node disk will be used.
    - `environmentalVariables` object: Optional. Map of environmental variables that will be set in the SandboxEngine.
    - `yamlPodTemplateSpec` string: When specified, then it is applied for SandboxEngine pod. PodTemplateSpec describes what will be applied on top of a regular SandboxEngine pod before it is created. This template is merged using StrategicMergePatch method (it overrides the default SandboxEngine pod). More info about StrategicMergePatch: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/ Example YAML value (custom annotation applied on SandboxEngine pod): metadata: annotations: custom-key: custom-value
    - `enabled` boolean: Optional. Whether the SandboxEngineTemplate is enabled. Disabled SandboxEngineTemplates cannot be used for creating new SandboxEngines.
    - `maxIdleDuration` string, required: Required. Maximum time a SandboxEngine can be idle before it is automatically terminated. An idle SandboxEngine is one with no processes in STATE_RUNNING. A value of 0s means no idle limit.
    - `maxRunningDuration` string, required: Required. Maximum time a SandboxEngine can run before it is automatically terminated. Measured from pod start time, regardless of activity. A value of 0s means no running limit.
    - `createTime` string, date-time: Output only. Time when the SandboxEngineTemplate was created.
    - `updateTime` string, date-time, nullable: Output only. Time when the SandboxEngineTemplate was last updated.
    - `creator` string: Output only. Name of entity that created the SandboxEngineTemplate.
    - `updater` string: Output only. Name of entity that last updated the SandboxEngineTemplate.
    - `creatorDisplayName` string: Output only. Human-readable name of entity that created the SandboxEngineTemplate.
    - `updaterDisplayName` string: Output only. Human-readable name of entity that last updated the SandboxEngineTemplate.

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto.md) - [All operations](https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto/llms.txt) - [OpenAPI document](https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto/revisions/297cfadc1d39?raw)