Required. The resource name of the Location from which to list the NotebookRuntimes. Format: projects/{project}/locations/{location}
Query parameters
filter
string
Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.
notebookRuntime supports = and !=. notebookRuntime represents the NotebookRuntime id, i.e. the last segment of the NotebookRuntime's resource name.
displayName supports = and != and regex.
notebookRuntimeTemplate supports = and !=. notebookRuntimeTemplate represents the NotebookRuntimeTemplate id, i.e. the last segment of the NotebookRuntimeTemplate's resource name.
healthState supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED].
API version is UI only: uiState supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED].
notebookRuntimeType supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK].
machineType supports = and !=.
acceleratorType supports = and !=.
Some examples:
notebookRuntime="notebookRuntime123"
displayName="myDisplayName" and displayName=~"myDisplayNameRegex"
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# Method: notebookRuntimes.list\n\n**Full name**: projects.locations.notebookRuntimes.list\n\nLists NotebookRuntimes in a Location. \n\n### Endpoint\n\nget `https:``/``/{service-endpoint}``/v1``/{parent}``/notebookRuntimes` \nWhere `{service-endpoint}` is one of the [supported service endpoints](/vertex-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n`parent` `string` \nRequired. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}`\n\n### Query parameters\n\n`filter` `string` \nOptional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.\n\n- `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime id, i.e. the last segment of the NotebookRuntime's [resource name](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookRuntimes#NotebookRuntime.FIELDS.name).\n- `displayName` supports = and != and regex.\n- `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate id, i.e. the last segment of the NotebookRuntimeTemplate's [resource name](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookRuntimeTemplates#NotebookRuntimeTemplate.FIELDS.name).\n- `healthState` supports = and !=. healthState enum: \\[HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED\\].\n- `runtimeState` supports = and !=. runtimeState enum: \\[RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID\\].\n- `runtimeUser` supports = and !=.\n- API version is UI only: `uiState` supports = and !=. uiState enum: \\[UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED\\].\n- `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: \\[USER_DEFINED, ONE_CLICK\\].\n- `machineType` supports = and !=.\n- `acceleratorType` supports = and !=.\n\nSome examples:\n\n- `notebookRuntime=\"notebookRuntime123\"`\n- `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"`\n- `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"`\n- `healthState=HEALTHY`\n- `runtimeState=RUNNING`\n- `runtimeUser=\"test@google.com\"`\n- `uiState=UI_RESOURCE_STATE_BEING_DELETED`\n- `notebookRuntimeType=USER_DEFINED`\n- `machineType=e2-standard-4`\n- `acceleratorType=NVIDIA_TESLA_T4`\n`pageSize` `integer` \nOptional. The standard list page size.\n`pageToken` `string` \nOptional. The standard list page token. Typically obtained via [ListNotebookRuntimesResponse.next_page_token](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookRuntimes/list#body.ListNotebookRuntimesResponse.FIELDS.next_page_token) of the previous [NotebookService.ListNotebookRuntimes](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookRuntimes/list#google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes) call.\n`readMask` `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` \nOptional. Mask specifying which fields to read.\n\nThis is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`.\n`orderBy` `string` \nOptional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields:\n\n- `displayName`\n- `createTime`\n- `updateTime`\n\nExample: `displayName, createTime desc`.\n\n### Request body\n\nThe request body must be empty. \n\n### Response body\n\nResponse message for [NotebookService.ListNotebookRuntimes](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookRuntimes/list#google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes).\n\nIf successful, the response body contains data with the following structure:\nFields `notebookRuntimes[]` `object (`[NotebookRuntime](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookRuntimes#NotebookRuntime)`)` \nList of NotebookRuntimes in the requested page.\n`nextPageToken` `string` \nA token to retrieve next page of results. Pass to [ListNotebookRuntimesRequest.page_token](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookRuntimes/list#body.QUERY_PARAMETERS.page_token) to obtain that page."]]
