---
title: "Returns a collection of NotebookEngineImages."
method: GET
path: "/v1/{parent}/notebookEngineImages"
tags: ["NotebookEngineImageService"]
---

# Returns a collection of NotebookEngineImages.

`GET /v1/{parent}/notebookEngineImages`

## 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/{parent}/notebookEngineImages`
- Auth: none declared
- TypeScript: <https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto/docs/v1/:parent/notebookEngineImages/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `parent` string, required

## Query parameters

- `pageSize` integer
- `pageToken` string

## Response `200`

A successful response.

- V1ListNotebookEngineImagesResponse: Response message for ListNotebookEngineImages.
  - `notebookEngineImages` V1NotebookEngineImage[]: Collection of NotebookEngineImages.
    - `name` string: Output only. Resource name. Format is `workspaces/*/notebookEngineImages/*`.
    - `displayName` string: Optional. Human-readable name.
    - `image` string, required
    - `enabled` boolean: Optional. Whether the NotebookEngineImage is enabled. Disabled NotebookEngineImage cannot be used for creating new NotebookEngine.
    - `imagePullPolicy` 'IMAGE_PULL_POLICY_UNSPECIFIED' | 'IMAGE_PULL_POLICY_ALWAYS' | 'IMAGE_PULL_POLICY_NEVER' | 'IMAGE_PULL_POLICY_IF_NOT_PRESENT': Policy for downloading an image in K8s. - IMAGE_PULL_POLICY_UNSPECIFIED: Unspecified image pull policy. - IMAGE_PULL_POLICY_ALWAYS: Every time the container is launched, the container image registry is queried to resolve the name to an image digest. - IMAGE_PULL_POLICY_NEVER: Do not try to fetch the image. If the image is already present locally, the container will start. If the image is not present, container startup will fail. - IMAGE_PULL_POLICY_IF_NOT_PRESENT: The image is pulled only if it is not already present locally.
    - `imagePullSecrets` string[]: Optional. A list of Kubernetes secret references used for authenticating to private container registries or repositories. These secrets provide the necessary credentials to pull Docker images from private repositories. Each entry in this list should be the name of a Kubernetes secret configured in the cluster.
    - `createTime` string, date-time: Output only. Time when the NotebookEngineImage was created.
    - `updateTime` string, date-time, nullable: Output only. Time when the NotebookEngineImage was last updated.
    - `creator` string: Output only. Name of entity that created the NotebookEngineImage.
    - `updater` string: Output only. Name of entity that last updated the NotebookEngineImage.
    - `creatorDisplayName` string: Output only. Human-readable name of entity that created the NotebookEngineImage.
    - `updaterDisplayName` string: Output only. Human-readable name of entity that last updated the NotebookEngineImage.
  - `nextPageToken` string: Used to retrieve the next page of results. When unset, no further items are available (this response was the last page).

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