Stay organized with collections
Save and categorize content based on your preferences.
Resource: NotebookRuntime
A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade.
Fields
name
string
Output only. The resource name of the NotebookRuntime.
Output only. timestamp when this NotebookRuntime was created.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. timestamp when this NotebookRuntime was most recently updated.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. The runtime (instance) state of the NotebookRuntime.
isUpgradable
boolean
Output only. Whether NotebookRuntime is upgradable.
labels
map (key: string, value: string)
The labels with user-defined metadata to organize your NotebookRuntime.
label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime:
"aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id.
"aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.
Output only. timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. user created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
version
string
Output only. The VM os image version of NotebookRuntime.
Output only. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the notebook runtime as data disk storage.
[[["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,["# REST Resource: projects.locations.notebookRuntimes\n\nResource: NotebookRuntime\n-------------------------\n\nA runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade.\nFields `name` `string` \nOutput only. The resource name of the NotebookRuntime.\n`runtimeUser` `string` \nRequired. The user email of the NotebookRuntime.\n`notebookRuntimeTemplateRef` `object (`[NotebookRuntimeTemplateRef](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookRuntimes#NotebookRuntimeTemplateRef)`)` \nOutput only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.\n`proxyUri` `string` \nOutput only. The proxy endpoint used to access the NotebookRuntime.\n`createTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this NotebookRuntime was created.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`updateTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this NotebookRuntime was most recently updated.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`healthState` `enum (`[HealthState](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookRuntimes#HealthState)`)` \nOutput only. The health state of the NotebookRuntime.\n`displayName` `string` \nRequired. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.\n`description` `string` \nThe description of the NotebookRuntime.\n`serviceAccount` `string` \nOutput only. Deprecated: This field is no longer used and the \"Vertex AI Notebook service Account\" ([service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com](mailto:service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com)) is used for the runtime workload identity. See \u003chttps://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account\u003e for more details.\n\nThe service account that the NotebookRuntime workload runs as.\n`runtimeState` `enum (`[RuntimeState](/vertex-ai/docs/reference/rest/v1/projects.locations.notebookRuntimes#RuntimeState)`)` \nOutput only. The runtime (instance) state of the NotebookRuntime.\n`isUpgradable` `boolean` \nOutput only. Whether NotebookRuntime is upgradable.\n`labels` `map (key: string, value: string)` \nThe labels with user-defined metadata to organize your NotebookRuntime.\n\nlabel keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded).\n\nSee \u003chttps://goo.gl/xmQnxf\u003e for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable. Following system labels exist for NotebookRuntime:\n\n- \"aiplatform.googleapis.com/notebook_runtime_gce_instance_id\": output only, its value is the Compute Engine instance id.\n- \"aiplatform.googleapis.com/colab_enterprise_entry_service\": its value is either \"bigquery\" or \"vertex\"; if absent, it should be \"vertex\". This is to describe the entry service, either BigQuery or Vertex.\n`expirationTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. user created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`version` `string` \nOutput only. The VM os image version of NotebookRuntime.\n`notebookRuntimeType` `enum (`[NotebookRuntimeType](/vertex-ai/docs/reference/rest/v1/NotebookRuntimeType)`)` \nOutput only. The type of the notebook runtime.\n`machineSpec` `object (`[MachineSpec](/vertex-ai/docs/reference/rest/v1/MachineSpec)`)` \nOutput only. The specification of a single machine used by the notebook runtime.\n`dataPersistentDiskSpec` `object (`[PersistentDiskSpec](/vertex-ai/docs/reference/rest/v1/PersistentDiskSpec)`)` \nOutput only. The specification of \\[persistent disk\\]\\[https://cloud.google.com/compute/docs/disks/persistent-disks\\] attached to the notebook runtime as data disk storage.\n`networkSpec` `object (`[NetworkSpec](/vertex-ai/docs/reference/rest/v1/NetworkSpec)`)` \nOutput only. Network spec of the notebook runtime.\n`idleShutdownConfig` `object (`[NotebookIdleShutdownConfig](/vertex-ai/docs/reference/rest/v1/NotebookIdleShutdownConfig)`)` \nOutput only. The idle shutdown configuration of the notebook runtime.\n`eucConfig` `object (`[NotebookEucConfig](/vertex-ai/docs/reference/rest/v1/NotebookEucConfig)`)` \nOutput only. EUC configuration of the notebook runtime.\n`shieldedVmConfig` `object (`[ShieldedVmConfig](/vertex-ai/docs/reference/rest/v1/ShieldedVmConfig)`)` \nOutput only. Runtime Shielded VM spec.\n`networkTags[]` `string` \nOptional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).\n`softwareConfig` `object (`[NotebookSoftwareConfig](/vertex-ai/docs/reference/rest/v1/NotebookSoftwareConfig)`)` \nOutput only. Software config of the notebook runtime.\n`encryptionSpec` `object (`[EncryptionSpec](/vertex-ai/docs/reference/rest/v1/EncryptionSpec)`)` \nOutput only. Customer-managed encryption key spec for the notebook runtime.\n`satisfiesPzs` `boolean` \nOutput only. reserved for future use.\n`satisfiesPzi` `boolean` \nOutput only. reserved for future use. \n\nNotebookRuntimeTemplateRef\n--------------------------\n\nPoints to a NotebookRuntimeTemplateRef.\nFields `notebookRuntimeTemplate` `string` \nImmutable. A resource name of the NotebookRuntimeTemplate. \n\nHealthState\n-----------\n\nThe substate of the NotebookRuntime to display health information.\n\nRuntimeState\n------------\n\nThe substate of the NotebookRuntime to display state of runtime. The resource of NotebookRuntime is in ACTIVE state for these sub state."]]
