---
title: "Returns a collection of Engines within a workspace."
method: GET
path: "/v1/{parent}/engines"
tags: ["EngineService"]
---

# Returns a collection of Engines within a workspace.

`GET /v1/{parent}/engines`

## 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}/engines`
- Auth: none declared
- TypeScript: <https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto/docs/v1/:parent/engines/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
- `orderBy` string
- `filter` string

## Response `200`

A successful response.

- V1ListEnginesResponse: Response message for EngineService.ListEngines.
  - `engines` V1Engine[]: Collection of Engines.
    - `name` string: Output only. Engine resource name.
    - `uid` string: Output only. Globally unique identifier of the resource.
    - `creator` string: Output only. Name of an entity that created the Engine.
    - `creatorDisplayName` string: Output only. Human-readable name of creator.
    - `type` 'TYPE_UNSPECIFIED' | 'TYPE_DRIVERLESS_AI' | 'TYPE_H2O' | 'TYPE_NOTEBOOK': All possible Engine types. - TYPE_UNSPECIFIED: Engine type is unspecified or unknown. - TYPE_DRIVERLESS_AI: Driverless AI Engine. - TYPE_H2O: H2O Engine. - TYPE_NOTEBOOK: Notebook Engine.
    - `profile` string: Output only. The resource name of the DAIEngineProfile or H2OEngineProfile that is used by this Engine. Format is `daiEngineProfiles/*`, `h2oEngineProfiles/*` or `notebookEngineProfiles/*`.
    - `state` 'STATE_UNSPECIFIED' | 'STATE_STARTING' | 'STATE_RUNNING' | 'STATE_PAUSING' | 'STATE_PAUSED' | 'STATE_FAILED' | 'STATE_DELETING' | 'STATE_CONNECTING' | 'STATE_TERMINATING' | 'STATE_TERMINATED': All possible Engine states. - STATE_UNSPECIFIED: Engine state is unspecified or unknown - STATE_STARTING: Engine is starting. - STATE_RUNNING: Engine is running and can be used. - STATE_PAUSING: Engine is pausing. - STATE_PAUSED: Engine is paused and can be resumed again. - STATE_FAILED: Engine has failed and can be resumed again. - STATE_DELETING: Engine is being deleted. - STATE_CONNECTING: Engine is establishing a connection with the AI Engine Manager. - STATE_TERMINATING: Engine is terminating. - STATE_TERMINATED: Engine is terminated. This is a final state.
    - `reconciling` boolean: Output only. Indicates whether changes to the resource are in progress. If true, current state of the Engine does not match the intended state.
    - `storageResizing` boolean: Output only. Indicates whether the Engine disk is currently resizing. It make take hours to complete the resizing process, especially if the disk has been resized recently.
    - `totalDiskSizeBytes` string, int64, nullable: Output only. Total disk size in bytes as reported by the Engine.
    - `freeDiskSizeBytes` string, int64, nullable: Output only. Free disk size in bytes as reported by the Engine.
    - `createTime` string, date-time: Output only. Time when the Engine creation was requested.
    - `deleteTime` string, date-time, nullable: Output only. Time when the Engine was deleted.
    - `updateTime` string, date-time, nullable: Output only. Time when the Engine was last updated.
    - `resumeTime` string, date-time, nullable: Output only. Time when the Engine was last resumed (or started for the first time).
    - `loginUrl` string: Output only. The URL address to initiate login flow.
    - `annotations` object: Output only. Additional arbitrary metadata associated with the Engine. Annotations are key/value pairs.
    - `displayName` string: Output only. Human-readable name of the Engine. Contains at most 63 characters and is not unique.
    - `version` string: Output only. Engine version identifier. For example: "1.10.1" or "latest".
    - `deprecatedVersion` boolean: Output only. Indicates, whether the used version is deprecated.
    - `deletedVersion` boolean: Output only. Indicates, whether the used version is deleted.
    - `cpu` integer: Output only. The amount of CPU units in total requested by this Engine.
    - `gpu` integer: Output only. The amount of GPU units in total requested by this Engine.
    - `memoryBytes` string, int64: Output only. The amount of memory in bytes requested by this Engine.
    - `storageBytes` string, int64: Output only. The amount of storage in bytes requested by this Engine.
    - `upgradeAvailable` boolean: Output only. Indicates, whether the used version can be upgraded to a later one.
    - `maxIdleDuration` string, nullable: Output only. Maximum time the engine can be idle.
    - `maxRunningDuration` string, nullable: Output only. Maximum time the engine can be running.
    - `currentIdleDuration` string, nullable: Output only. Current time the engine is idle.
    - `currentRunningDuration` string, nullable: Output only. Current time the engine is running.
    - `visitable` boolean: Output only. Indicates, whether the engine can be visited.
  - `nextPageToken` string: Used to retrieve the next page of results. When unset, no further items are available (this response was the last page).
  - `totalSize` integer: Total number of Engines matched by the List request.

## 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/57d1a2e93fcf?raw)